@malib/gear 0.0.1 → 0.1.0

package/lib/gear.d.ts

@@ -1,46 +1,10 @@
+import { GearOption } from "./gearoption";
 import { GearPropType } from "./gearproptype";
+import { GearReq } from "./gearreq";
 import { GearType } from "./geartype";
 import { Potential } from "./potential";
 import { PotentialGrade } from "./potentialgrade";
-import { Soul } from "./soul";
-/**
- * 장비 착용 제한
- */
-export declare class GearReq {
-    /** 착용 가능 레벨 */
-    level: number;
-    /** REQ STR */
-    str: number;
-    /** REQ LUK */
-    luk: number;
-    /** REQ DEX */
-    dex: number;
-    /** REQ INT */
-    int: number;
-    /** 착용 가능 직업 분류 */
-    job: number;
-    /** 착용 가능 직업 */
-    specJob: number;
-}
-/**
- * 장비 옵션
- */
-export declare class GearOption {
-    /** 기본 수치 */
-    base: number;
-    /** 추가옵션 수치 */
-    bonus: number;
-    /** 주문서 강화 수치 */
-    upgrade: number;
-    /** 장비 강화 수치 */
-    enchant: number;
-    /** 모든 수치가 0일 경우 `true`; 아닐 경우 `false` */
-    get empty(): boolean;
-    /** 모든 수치의 합; 합이 음수일 경우 `0` */
-    get sum(): number;
-    /** 기본 수치 대비 변화량 */
-    get diff(): number;
-}
+import { SoulSlot } from "./soul";
 /**
  * 장비
  */
@@ -61,14 +25,18 @@ export declare class Gear {
     req: GearReq;
     /** 장비 속성 */
     props: Map<GearPropType, number>;
-    /** 장비 옵션 */
+    /**
+     * 장비 옵션
+     *
+     * 접근할 때는 `options` 대신 `option`을 사용하는 것이 권장됩니다.
+     */
     options: Map<GearPropType, GearOption>;
     /** 최대 업그레이드 가능 횟수 */
     totalUpgradeCount: number;
     /** 업그레이드 횟수 */
     upgradeCount: number;
     /** 복구 가능 횟수 */
-    failCount: number;
+    upgradeFailCount: number;
     /** 황금망치 횟수 */
     hammerCount: number;
     /** 최대 장비 강화 수치 */
@@ -88,7 +56,16 @@ export declare class Gear {
     /** 에디셔널 잠재옵션 목록 */
     additionalPotentials: Potential[];
     /** 소울 */
-    soul: Soul | undefined;
+    soulSlot: SoulSlot;
+    /**
+     * 업그레이드 가능 횟수
+     */
+    get upgradeCountLeft(): number;
+    /**
+     * 현재 옵션과 기본 옵션의 차이를 가중치를 포함하여 계산합니다.
+     * @returns 가중치가 적용된 옵션 차이의 합
+     */
+    get diff(): number;
     /**
      * 장비 옵션을 반환합니다. 존재하지 않는 옵션은 장비에 추가됩니다.
      * @param type 장비 옵션 종류
@@ -107,21 +84,6 @@ export declare class Gear {
      * @returns 속성이 존재하고 값이 `0` 이상일 경우 `true`; 아닐 경우 `false`
      */
     getBooleanValue(type: GearPropType): boolean;
-    /**
-     * 장비의 최대 강화 수치를 계산합니다.
-     * @returns 최대 장비 강화 수치
-     */
-    getMaxStar(): number;
-    private static readonly starData;
-    /**
-     * 현재 옵션과 기본 옵션의 차이를 가중치를 포함하여 계산합니다.
-     * @returns 가중치가 적용된 옵션 차이의 합
-     */
-    get diff(): number;
-    /**
-     * 업그레이드 가능 횟수
-     */
-    get upgradeLeft(): number;
     /**
      * 장비가 주무기인지 여부를 나타내는 `boolean`값을 반환합니다. 블레이드(katara)는 포함되지 않습니다.
      * @param type 장비 분류
@@ -184,5 +146,12 @@ export declare class Gear {
      */
     static getGearType(gearID: number): GearType;
     static GetGender(gearID: number): number;
+    /**
+     * 장비의 최대 강화 수치를 계산합니다.
+     * @param gear 장비
+     * @returns 최대 장비 강화 수치
+     */
+    static getMaxStar(gear: Gear): number;
+    private static readonly starData;
     private static getPropTypeWeight;
 }

package/lib/gearoption.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 장비 옵션
+ */
+export declare class GearOption {
+    /** 기본 수치 */
+    base: number;
+    /** 추가옵션 수치 */
+    bonus: number;
+    /** 주문서 강화 수치 */
+    upgrade: number;
+    /** 장비 강화 수치 */
+    enchant: number;
+    /** 모든 수치가 0일 경우 `true`; 아닐 경우 `false` */
+    get empty(): boolean;
+    /** 모든 수치의 합; 합이 음수일 경우 `0` */
+    get sum(): number;
+    /** 기본 수치 대비 변화량 */
+    get diff(): number;
+}

package/lib/gearproptype.d.ts

@@ -10,119 +10,94 @@ export declare enum GearPropType {
     incINTr = 6,
     incLUK = 7,
     incLUKr = 8,
-    incAllStat_incMHP25 = 9,
-    incAllStat = 10,
-    incMHP_incMMP = 11,
-    incMHPr_incMMPr = 12,
-    incMHP = 13,
-    incMMP = 14,
-    incMHPr = 15,
-    incMMPr = 16,
-    incMDF = 17,
-    incARC = 18,
-    incAUT = 19,
-    incPAD_incMAD = 20,
-    incPAD = 21,
-    incMAD = 22,
-    incAD = 23,
-    incPDD_incMDD = 24,
-    incPDD = 25,
-    incSpeed = 26,
-    incJump = 27,
-    knockback = 28,
-    bdR = 29,
-    incBDR = 30,
-    imdR = 31,
-    incIMDR = 32,
-    damR = 33,
-    nbdR = 34,
-    statR = 35,
-    incCHUC = 36,
+    incAllStat = 9,
+    incMHP = 10,
+    incMMP = 11,
+    incMHPr = 12,
+    incMMPr = 13,
+    incMDF = 14,
+    incARC = 15,
+    incAUT = 16,
+    incPAD = 17,
+    incMAD = 18,
+    incAD = 19,
+    incPDD = 20,
+    incSpeed = 21,
+    incJump = 22,
+    knockback = 23,
+    bdR = 24,
+    incBDR = 25,
+    imdR = 26,
+    incIMDR = 27,
+    damR = 28,
+    nbdR = 29,
+    statR = 30,
+    incCHUC = 31,
     incPADr = 100,
     incMADr = 101,
     incPDDr = 102,
-    incMDDr = 103,
-    incACCr = 104,
-    incEVAr = 105,
-    incCr = 106,
-    incDAMr = 107,
-    RecoveryHP = 108,
-    RecoveryMP = 109,
-    face = 110,
-    prop = 111,
-    time = 112,
-    HP = 113,
-    MP = 114,
-    attackType = 115,
-    ignoreTargetDEF = 116,
-    ignoreDAM = 117,
-    ignoreDAMr = 118,
-    DAMreflect = 119,
-    mpconReduce = 120,
-    mpRestore = 121,
-    incMesoProp = 122,
-    incRewardProp = 123,
-    incAllskill = 124,
-    RecoveryUP = 125,
-    boss = 126,
-    level = 127,
-    incTerR = 128,
-    incAsrR = 129,
-    incEXPr = 130,
-    reduceCooltime = 131,
-    incCriticaldamageMax = 132,
-    incCriticaldamageMin = 133,
-    incSTRlv = 134,
-    incDEXlv = 135,
-    incINTlv = 136,
-    incLUKlv = 137,
-    incMaxDamage = 138,
-    incMHPlv = 139,
-    incPADlv = 140,
-    incMADlv = 141,
-    incCriticaldamage = 142,
+    incCr = 103,
+    incDAMr = 104,
+    RecoveryHP = 105,
+    RecoveryMP = 106,
+    face = 107,
+    prop = 108,
+    time = 109,
+    HP = 110,
+    MP = 111,
+    attackType = 112,
+    ignoreTargetDEF = 113,
+    ignoreDAM = 114,
+    ignoreDAMr = 115,
+    DAMreflect = 116,
+    mpconReduce = 117,
+    incMesoProp = 118,
+    incRewardProp = 119,
+    incAllskill = 120,
+    RecoveryUP = 121,
+    boss = 122,
+    level = 123,
+    incTerR = 124,
+    incAsrR = 125,
+    incEXPr = 126,
+    reduceCooltime = 127,
+    incSTRlv = 128,
+    incDEXlv = 129,
+    incINTlv = 130,
+    incLUKlv = 131,
+    incMHPlv = 132,
+    incPADlv = 133,
+    incMADlv = 134,
+    incCriticaldamage = 135,
     attackSpeed = 200,
-    tuc = 201,
-    setItemID = 202,
-    durability = 203,
-    reduceReq = 204,
-    growthLevel = 205,
-    growthExp = 206,
-    mastery = 300,
-    reqLevel = 1000,
-    reqSTR = 1001,
-    reqDEX = 1002,
-    reqINT = 1003,
-    reqLUK = 1004,
-    reqJob = 1005,
-    reqPOP = 1006,
-    reqSpecJob = 1007,
+    setItemID = 201,
+    durability = 202,
+    reduceReq = 203,
     only = 1100,
     tradeBlock = 1101,
     accountSharable = 1102,
     onlyEquip = 1103,
     tradeAvailable = 1104,
     equipTradeBlock = 1105,
-    tradeOnce = 1106,
-    sharableOnce = 1107,
-    charismaEXP = 1108,
-    senseEXP = 1109,
-    insightEXP = 1110,
-    willEXP = 1111,
-    craftEXP = 1112,
-    charmEXP = 1113,
-    accountShareTag = 1114,
-    bossReward = 1115,
-    noPotential = 1116,
-    fixedPotential = 1117,
-    specialGrade = 1118,
-    fixedGrade = 1119,
-    superiorEqp = 1120,
-    incPQEXPr = 1121,
-    jokerToSetItem = 1122,
-    blockGoldHammer = 1123,
-    exceptUpgrade = 1124,
-    onlyUpgrade = 1125,
-    noLookChange = 1126,
-    tucIgnoreForPotential = 1127
+    sharableOnce = 1106,
+    charismaEXP = 1107,
+    senseEXP = 1108,
+    insightEXP = 1109,
+    willEXP = 1110,
+    craftEXP = 1111,
+    charmEXP = 1112,
+    accountShareTag = 1113,
+    bossReward = 1114,
+    noPotential = 1115,
+    fixedPotential = 1116,
+    specialGrade = 1117,
+    fixedGrade = 1118,
+    superiorEqp = 1119,
+    incPQEXPr = 1120,
+    jokerToSetItem = 1121,
+    blockGoldHammer = 1122,
+    exceptUpgrade = 1123,
+    onlyUpgrade = 1124,
+    noLookChange = 1125,
+    tucIgnoreForPotential = 1126
 }

package/lib/gearreq.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 장비 착용 제한
+ */
+export declare class GearReq {
+    /** 착용 가능 레벨 */
+    level: number;
+    /** REQ STR */
+    str: number;
+    /** REQ LUK */
+    luk: number;
+    /** REQ DEX */
+    dex: number;
+    /** REQ INT */
+    int: number;
+    /** 착용 가능 직업 분류 */
+    job: number;
+    /** 착용 가능 직업 */
+    specJob: number;
+}

package/lib/logic/enhancement.d.ts

@@ -49,14 +49,14 @@ export declare class EnhancementLogic {
      */
     recalculate(gear: Gear): boolean;
     private static getStatData;
-    private static superiorAttData;
-    private static superiorStatData;
-    private static starforceWeaponAttData;
-    private static starforceAttData;
-    private static starforceStatData;
-    private static amazingAttData;
-    private static amazingStatData;
-    private static starforceGloveBonusAttData;
-    private static starforceMhpData;
-    private static starforceSpeedJumpData;
+    private static readonly superiorAttData;
+    private static readonly superiorStatData;
+    private static readonly starforceWeaponAttData;
+    private static readonly starforceAttData;
+    private static readonly starforceStatData;
+    private static readonly amazingAttData;
+    private static readonly amazingStatData;
+    private static readonly starforceGloveBonusAttData;
+    private static readonly starforceMhpData;
+    private static readonly starforceSpeedJumpData;
 }

package/lib/logic/scroll.d.ts

@@ -14,8 +14,14 @@ export declare class Scroll {
     /**
      * 주문의 흔적 `Scroll`을 반환합니다.
      * @param gear 적용할 장비
-     * @param type 주문의 흔적 스탯 (`GearPropType`)
-     * @param probability 주문의 흔적 확률
+     * @param type 주문의 흔적 스탯 종류; 다음 값 중 하나입니다:
+     *
+     * `GearPropType.incSTR` / `GearPropType.incDEX` /
+     * `GearPropType.incINT` / `GearPropType.incLUK` /
+     * `GearPropType.incAllStat` / `GearPropType.incMHP`
+     * @param probability 주문의 흔적 성공 확률 %; 다음 값 중 하나입니다:
+     *
+     * `100` / `70` / `30` / `15`
      * @returns 주문의 흔적 `Scroll`; 존재하지 않을 경우 `undefined`
      */
     static getSpellTraceScroll(gear: Gear, type: SpellTraceStatType, probability: SpellTraceProbability): Scroll | undefined;

package/lib/logic/soul.d.ts

@@ -0,0 +1,41 @@
+import { Gear } from "../gear";
+import { Soul } from "../soul";
+/**
+ * 소울웨폰 관련 기능을 제공합니다.
+ */
+export declare class SoulLogic {
+    /**
+     * 무기를 소울웨폰으로 변환합니다.
+     * @param gear 적용할 장비
+     * @returns 소울웨폰으로 변환되었을 경우 `true`; 아닐 경우 `false`
+     */
+    enchant(gear: Gear): boolean;
+    /**
+     * 소울웨폰을 원래의 무기로 되돌립니다.
+     * @param gear 되돌릴 장비
+     * @returns 되돌렸을 경우 `true`; 아닐 경우 `false`
+     */
+    disenchant(gear: Gear): boolean;
+    /**
+     * 소울웨폰에 소울을 장착합니다.
+     * @param gear 소울을 장착할 장비
+     * @param soul 장착할 소울
+     * @returns 장착했을 경우 `true`; 아닐 경우 `false`
+     */
+    setSoul(gear: Gear, soul: Soul): boolean;
+    /**
+     * 소울이 장착된 소울웨폰에서 소울을 제거합니다.
+     * @param gear 소울을 제거할 장비
+     * @returns 제거했을 경우 `true`; 아닐 경우 `false`
+     */
+    removeSoul(gear: Gear): boolean;
+    /**
+     * 소울웨폰의 소울 충전량을 설정하고 옵션을 적용합니다.
+     * 0부터 1000까지의 값으로 설정할 수 있습니다.
+     * @param gear 소울 충전량을 설정할 장비
+     * @param charge 소울 충전량
+     * @returns 적용했을 경우 `true`; 아닐 경우 `false`
+     */
+    setCharge(gear: Gear, charge: number): boolean;
+    private getChargeAD;
+}

package/lib/logic/upgrade.d.ts

@@ -12,7 +12,6 @@ export declare class UpgradeLogic {
     applyGoldHammer(gear: Gear): boolean;
     /**
      * 장비에 주문서를 1회 적용합니다.
-     *
      * @param gear 주문서를 적용할 장비
      * @param scroll 적용할 주문서
      * @returns 주문서가 적용됐을 경우 `true`; 아닐 경우 `false`
@@ -21,27 +20,29 @@ export declare class UpgradeLogic {
     /**
      * 장비에 주문의 흔적 강화를 1회 적용합니다.
      * @param gear 강화를 적용할 장비
-     * @param type 주문의 흔적 스탯 종류
-     * @param probability 주문의 흔적 성공 확률 %
+     * @param type 주문의 흔적 스탯 종류; 다음 값 중 하나입니다:
+     *
+     * `GearPropType.incSTR` / `GearPropType.incDEX` /
+     * `GearPropType.incINT` / `GearPropType.incLUK` /
+     * `GearPropType.incAllStat` / `GearPropType.incMHP`
+     * @param probability 주문의 흔적 성공 확률 %; 다음 값 중 하나입니다:
+     *
+     * `100` / `70` / `30` / `15`
      * @returns 주문서가 적용됐을 경우 `true`; 아닐 경우 `false`
      */
     applySpellTrace(gear: Gear, type: SpellTraceStatType, probability: SpellTraceProbability): boolean;
     /**
-     * 장비의 업그레이드 가능 횟수를 1회 감소합니다.
-     *
-     * 주문서가 실패한 것과 동일한 효과입니다.
+     * 장비의 업그레이드 가능 횟수를 실패로 1회 감소합니다.
      * @param gear 감소할 장비
      * @returns 감소됐을 경우 `true`; 아닐 경우 `false`
      */
-    addUpgradeFail(gear: Gear): boolean;
+    addUpgradeFailCount(gear: Gear): boolean;
     /**
-     * 장비의 업그레이드 가능 횟수를 1회 복구합니다.
-     *
-     * 장비의 최대 업그레이드 가능 횟수를 초과하지 않습니다.
+     * 장비의 실패한 업그레이드 가능 횟수를 1회 복구합니다.
      * @param gear 복구할 장비
      * @returns 복구했을 경우 `true`; 아닐 경우 `false`
      */
-    restoreUpgradeFail(gear: Gear): boolean;
+    restoreUpgradeCount(gear: Gear): boolean;
     /**
      * 장비의 주문서, 황금망치 관련 속성을 초기화합니다.
      *

package/lib/potentialgrade.d.ts

@@ -2,10 +2,28 @@
  * 잠재능력 등급
  */
 export declare enum PotentialGrade {
+    /**
+     * 노멀
+     */
     normal = 0,
+    /**
+     * 레어
+     */
     rare = 1,
+    /**
+     * 에픽
+     */
     epic = 2,
+    /**
+     * 유니크
+     */
     unique = 3,
+    /**
+     * 레전드리
+     */
     legendary = 4,
+    /**
+     * 스페셜
+     */
     special = 5
 }