@malib/gear 1.0.0-next.3 → 1.0.0-next.5

package/dist/lib/Gear.d.ts

@@ -1,11 +1,8 @@
-import { GearAddOption, GearBaseOption, GearData, GearExceptionalOption, GearMetadata, GearShapeData, GearStarforceOption, GearType, GearUpgradeOption, PotentialData, PotentialGrade, ReadonlySoulData, SoulChargeOption, SoulData } from './data';
-import { AddOptionGrade, AddOptionType } from './enhance/addOption';
+import { AddOptionGrade, AddOptionType, GearData, GearShapeData, PotentialData, PotentialGrade, SoulData } from './data';
 import { ExceptionalHammer } from './enhance/exceptional';
 import { SpellTraceRate, SpellTraceType } from './enhance/spellTrace';
 import { Scroll } from './enhance/upgrade';
-import { GearAttribute } from './GearAttribute';
-import { GearReq } from './GearReq';
-type _Gear = GearData;
+import { ReadonlyGear } from './ReadonlyGear';
 /**
  * 장비
  *
@@ -18,206 +15,58 @@ type _Gear = GearData;
  *
  * 생성자에 전달된 장비 정보와 `data` 속성 간에 엄격한 동등(`===`)을 보장합니다.
  *
- * 장비 정보의 모든 속성에 대해 읽기 전용 속성을 제공하고, 일부 속성은 장비 객체 자체에 또는 반환 객체의 속성에 쓰기가 가능합니다.
+ * 장비 정보의 모든 속성에 대해 읽기 전용 속성을 제공합니다.
+ * 일부 속성은 장비 객체 자체에 또는 반환 객체의 속성에 쓰기가 가능합니다.
  */
-export declare class Gear implements _Gear {
-    /** 장비 정보 */
-    data: GearData;
+export declare class Gear extends ReadonlyGear {
     /**
-     * 장비 정보를 참조하는 장비 인스턴스를 생성합니다.
-     * @param data 장비 정보.
+     * 장비 정보
      */
-    constructor(data: GearData);
-    /**
-     * 장비 메타데이터
-     */
-    get meta(): GearMetadata;
-    /**
-     * 장비명
-     */
-    get name(): string;
-    /**
-     * 장비 아이콘
-     */
-    get icon(): string;
-    /**
-     * 장비 설명
-     */
-    get desc(): string | undefined;
+    get data(): GearData;
     /**
      * 장비 외형
      */
     get shape(): Readonly<GearShapeData> | undefined;
     set shape(shape: GearShapeData | undefined);
-    /**
-     * 장비 외형 아이콘
-     *
-     * 장비 외형이 설정되었을 경우 장비 외형 아이콘, 그렇지 않을 경우 장비 아이콘.
-     */
-    get shapeIcon(): string;
-    /**
-     * 장비 분류
-     */
-    get type(): GearType;
-    /**
-     * 장비 착용 제한
-     */
-    get req(): GearReq;
-    /**
-     * 장비 속성
-     */
-    get attributes(): GearAttribute;
-    /**
-     * 장비 최종 옵션
-     *
-     * 기본 옵션, 추가 옵션, 주문서 옵션, 스타포스 옵션의 합.
-     *
-     * 익셉셔널 옵션은 미포함.
-     */
-    get totalOption(): Readonly<GearBaseOption | GearAddOption | GearUpgradeOption | GearStarforceOption>;
-    /**
-     * 장비 순수 옵션
-     */
-    get baseOption(): Readonly<GearBaseOption>;
-    /**
-     * 장비 추가 옵션
-     */
-    get addOption(): Readonly<GearAddOption>;
-    /**
-     * 장비 주문서 강화 옵션
-     */
-    get upgradeOption(): Readonly<GearUpgradeOption>;
-    /**
-     * 장비 스타포스 옵션
-     */
-    get starforceOption(): Readonly<GearStarforceOption>;
-    /**
-     * 업그레이드 횟수
-     */
-    get scrollUpgradeCount(): number;
-    /**
-     * 복구 가능 횟수
-     */
-    get scrollResilienceCount(): number;
-    /**
-     * 업그레이드 가능 횟수
-     */
-    get scrollUpgradeableCount(): number;
-    /**
-     * 황금 망치 재련 적용
-     */
-    get goldenHammer(): number;
-    /**
-     * 전체 업그레이드 가능 횟수
-     *
-     * 성공, 실패, 황금 망치 적용 여부를 무시한 장비의 기본 업그레이드 가능 횟수입니다.
-     */
-    get scrollTotalUpgradeableCount(): number;
-    /**
-     * 강화 단계
-     */
-    get star(): number;
-    /**
-     * 최대 강화 단계
-     *
-     * 장비의 현재 강화 단계가 최대 강화 단계를 초과할 시 현재 강화 단계입니다.
-     * 놀라운 장비 강화 주문서가 사용되었을 경우 최대 `15`입니다.
-     */
-    get maxStar(): number;
-    /**
-     * 놀라운 장비 강화 주문서 사용 여부
-     */
-    get starScroll(): boolean;
-    /**
-     * 소울 인챈트 여부
-     */
-    get soulEnchanted(): boolean;
-    /**
-     * 소울
-     */
-    get soul(): ReadonlySoulData | undefined;
-    /**
-     * 소울 충전량
-     */
-    get soulCharge(): number;
-    /**
-     * 소울 충전 옵션
-     */
-    get soulChargeOption(): Readonly<SoulChargeOption>;
-    /**
-     * 잠재능력 등급
-     */
-    get potentialGrade(): PotentialGrade;
-    set potentialGrade(value: PotentialGrade);
-    /**
-     * 잠재능력 목록
-     */
-    get potentials(): PotentialData[];
-    set potentials(value: PotentialData[]);
-    /**
-     * 에디셔널 잠재능력 등급
-     */
-    get additionalPotentialGrade(): PotentialGrade;
-    set additionalPotentialGrade(value: PotentialGrade);
-    /**
-     * 에디셔널 잠재능력 목록
-     */
-    get additionalPotentials(): PotentialData[];
-    set additionalPotentials(value: PotentialData[]);
-    /**
-     * 장비 익셉셔널 옵션
-     */
-    get exceptionalOption(): Readonly<GearExceptionalOption>;
-    /**
-     * 익셉셔널 강화 횟수
-     */
-    get exceptionalUpgradeCount(): number;
-    /**
-     * 익셉셔널 강화 가능 횟수
-     */
-    get exceptionalUpgradeableCount(): number;
-    /**
-     * 전체 익셉셔널 강화 가능 횟수
-     */
-    get exceptionalTotalUpgradeableCount(): number;
     /**
      * 장비가 추가 옵션을 지원하는지 여부
-     *
-     * '스칼렛 숄더', '보스 아레나 엠블렘'일 경우 `false`를 반환합니다. 해당 동작은 변경될 수 있습니다.
      */
     get supportsAddOption(): boolean;
+    /**
+     * 장비에 추가 옵션을 적용할 수 있는 상태인지 여부
+     */
+    get canApplyAddOption(): boolean;
     /**
      * 장비에 추가 옵션을 적용합니다.
      * @param type 추가 옵션 종류.
-     * @param grade 추가 옵션 등급.
+     * @param grade 추가 옵션 단계.
      *
      * @throws {@link TypeError}
-     * 장비에 부여할 수 없는 추가 옵션을 지정했을 경우.
+     * 추가 옵션을 적용할 수 없는 상태일 경우.
+     *
+     * @throws {@link TypeError}
+     * 부여할 수 없는 추가 옵션을 지정했을 경우.
      */
     applyAddOption(type: AddOptionType, grade: AddOptionGrade): void;
+    /**
+     * 장비의 추가 옵션을 초기화할 수 있는 상태인지 여부
+     */
+    get canResetAddOption(): boolean;
     /**
      * 장비의 추가 옵션을 초기화합니다.
+     *
+     * @throws {@link TypeError}
+     * 추가 옵션을 초기화할 수 없는 상태의 장비일 경우.
      */
     resetAddOption(): void;
     /**
      * 장비가 주문서 강화를 지원하는지 여부
      */
     get supportsUpgrade(): boolean;
-    /**
-     * 장비에 황금 망치를 적용할 수 있는 상태인지 여부
-     */
-    get canApplyGoldenHammer(): boolean;
-    /**
-     * 장비에 황금 망치를 적용합니다.
-     *
-     * @throws {@link TypeError}
-     * 황금 망치를 적용할 수 없는 상태일 경우.
-     */
-    applyGoldenHammer(): void;
     /**
      * 장비에 주문서 실패를 적용할 수 있는 상태인지 여부
      */
-    get canApplyFailScroll(): boolean;
+    get canApplyScrollFail(): boolean;
     /**
      * 장비에 주문서 실패를 1회 적용합니다.
      *
@@ -235,7 +84,7 @@ export declare class Gear implements _Gear {
      * @throws {@link TypeError}
      * 업그레이드 가능 횟수를 복구할 수 없는 상태일 경우.
      */
-    applyScrollResile(): void;
+    applyResileScroll(): void;
     /**
      * 장비의 주문서 강화를 초기화할 수 있는 상태인지 여부
      */
@@ -329,6 +178,76 @@ export declare class Gear implements _Gear {
      * 장비의 스타포스 강화를 초기화합니다.
      */
     resetStarforce(): void;
+    /**
+     * 장비가 잠재능력을 지원하는지 여부
+     */
+    get supportsPotential(): boolean;
+    /**
+     * 장비의 잠재능력을 설정할 수 있는지 여부
+     */
+    get canSetPotential(): boolean;
+    /**
+     * 장비의 잠재능력을 설정합니다.
+     *
+     * `grade`는 `PotentialGrade.Normal`일 수 없습니다.
+     *
+     * `options`에 포함된 잠재옵션은 1개 이상 3개 이하여야 합니다.
+     * @param grade 잠재능력 등급.
+     * @param options 잠재옵션 목록.
+     *
+     * @throws {@link TypeError}
+     * 잠재능력을 설정할 수 없는 경우.
+     *
+     * @throws {@link TypeError}
+     * 설정하려는 잠재능력 등급이 Normal일 경우.
+     *
+     * @throws {@link TypeError}
+     * 잘못된 잠재옵션 목록을 지정했을 경우.
+     */
+    setPotential(grade: PotentialGrade, options: PotentialData[]): void;
+    /**
+     * 장비의 잠재능력을 초기화합니다.
+     *
+     * 에디셔널 잠재능력은 변경되지 않습니다.
+     *
+     * @throws {@link TypeError}
+     * 잠재능력을 초기화할 수 없는 경우.
+     */
+    resetPotential(): void;
+    /**
+     * 장비가 에디셔널 잠재능력을 지원하는지 여부
+     */
+    get supportsAdditionalPotential(): boolean;
+    /**
+     * 장비의 에디셔널 잠재능력을 설정할 수 있는지 여부
+     */
+    get canSetAdditionalPotential(): boolean;
+    /**
+     * 장비의 에디셔널 잠재능력을 설정합니다.
+     *
+     * `grade`는 `PotentialGrade.Normal`일 수 없습니다.
+     *
+     * `options`에 포함된 에디셔널 잠재옵션은 1개 이상 3개 이하여야 합니다.
+     * @param grade 에디셔널 잠재능력 등급.
+     * @param options 에디셔널 잠재옵션 목록.
+     *
+     * @throws {@link TypeError}
+     * 에디셔널 잠재능력을 설정할 수 없는 경우.
+     *
+     * @throws {@link TypeError}
+     * 설정하려는 에디셔널 잠재능력 등급이 Normal일 경우.
+     *
+     * @throws {@link TypeError}
+     * 잘못된 에디셔널 잠재옵션 목록을 지정했을 경우.
+     */
+    setAdditionalPotential(grade: PotentialGrade, options: PotentialData[]): void;
+    /**
+     * 장비의 에디셔널 잠재능력을 초기화합니다.
+     *
+     * @throws {@link TypeError}
+     * 에디셔널 잠재능력을 초기화할 수 없는 경우.
+     */
+    resetAdditionalPotential(): void;
     /**
      * 장비가 소울웨폰을 지원하는지 여부
      */
@@ -397,4 +316,3 @@ export declare class Gear implements _Gear {
      */
     resetExceptional(): void;
 }
-export {};

package/dist/lib/GearAttribute.d.ts

@@ -1,6 +1,8 @@
-import { AddOptionCan, GearAttributeData, GearCuttable, GearIncline, GearShare, GearTrade, PotentialCan } from './data';
-type OptionalProperty = 'attackSpeed' | 'cuttableCount' | 'growthExp' | 'growthLevel' | 'dateExpire';
-type _GearAttribute = Omit<Required<GearAttributeData>, OptionalProperty> & Pick<GearAttributeData, OptionalProperty>;
+import { GearAttributeData, GearCapability, GearCuttable, GearIncline, GearShare, GearTrade } from './data';
+type OptionalProperty = 'attackSpeed' | 'cuttableCount' | 'totalCuttableCount' | 'setItemId' | 'growthExp' | 'growthLevel' | 'dateExpire';
+type _GearAttribute = Omit<Omit<Required<GearAttributeData>, OptionalProperty> & Pick<GearAttributeData, OptionalProperty>, 'skills'> & {
+    skills: readonly string[];
+};
 export declare class GearAttribute implements _GearAttribute {
     /** 장비 속성 정보 */
     data: GearAttributeData;
@@ -14,31 +16,33 @@ export declare class GearAttribute implements _GearAttribute {
     get onlyEquip(): boolean;
     /** 월드 내 나의 캐릭터 간 이동 가능 여부 */
     get share(): GearShare;
-    /** 황금망치 사용 불가 */
-    get blockGoldenHammer(): boolean;
     /** 슈페리얼 */
     get superior(): boolean;
     /** 공격 속도 */
     get attackSpeed(): number | undefined;
-    /** 강화불가 */
-    get cannotUpgrade(): boolean;
+    /** 주문서 강화 가능 여부 */
+    get canScroll(): GearCapability;
+    /** 스타포스 강화 가능 여부 */
+    get canStarforce(): GearCapability;
     /** 추가옵션 설정 가능 여부 */
-    get canAddOption(): AddOptionCan;
+    get canAddOption(): GearCapability;
     /** 잠재능력 설정 가능 여부 */
-    get canPotential(): PotentialCan;
+    get canPotential(): GearCapability;
     /** 에디셔널 잠재능력 설정 가능 여부 */
-    get canAdditionalPotential(): PotentialCan;
+    get canAdditionalPotential(): GearCapability;
     /** 스페셜 아이템 여부 */
     get specialGrade(): boolean;
-    /** 착용 레벨 증가 */
-    get reqLevelIncrease(): number;
     /** 카르마의 가위 사용 가능 여부 */
     get cuttable(): GearCuttable;
     /** 가위 사용 가능 횟수 */
     get cuttableCount(): number | undefined;
     set cuttableCount(value: number | undefined);
+    /** 최대 가위 사용 가능 횟수 */
+    get totalCuttableCount(): number | undefined;
     /** 쉐어 네임 텍을 사용 가능 여부 */
     get accountShareTag(): boolean;
+    /** 세트 효과 ID */
+    get setItemId(): number | undefined;
     /** 럭키 아이템 */
     get lucky(): boolean;
     /** 장착 시 획득 경험치 */
@@ -46,6 +50,8 @@ export declare class GearAttribute implements _GearAttribute {
     set incline(value: Partial<GearIncline>);
     /** 보스 드롭 여부 */
     get bossReward(): boolean;
+    /** 사용 가능 스킬 */
+    get skills(): readonly string[];
     /** 성장 경험치 */
     get growthExp(): number | undefined;
     set growthExp(value: number | undefined);

package/dist/lib/GearReq.d.ts

@@ -12,25 +12,13 @@ export declare class GearReq implements GearReqData {
      */
     constructor(data: GearReqData);
     /**
-     * 착용 가능 레벨
+     * 기본 착용 가능 레벨
      */
     get level(): number;
     /**
-     * 착용 가능 STR
+     * 착용 가능 레벨 증가
      */
-    get str(): number;
-    /**
-     * 착용 가능 DEX
-     */
-    get dex(): number;
-    /**
-     * 착용 가능 INT
-     */
-    get int(): number;
-    /**
-     * 착용 가능 LUK
-     */
-    get luk(): number;
+    get levelIncrease(): number;
     /**
      * 착용 가능 직업 분류
      * */

package/dist/lib/ReadonlyGear.d.ts

@@ -0,0 +1,177 @@
+import { AddOptionData, GearAddOption, GearBaseOption, GearData, GearExceptionalOption, GearMetadata, GearShapeData, GearStarforceOption, GearType, GearUpgradeOption, PotentialGrade, ReadonlySoulData, SoulChargeOption } from './data';
+import { ReadonlyPotential } from './enhance/potential';
+import { GearAttribute } from './GearAttribute';
+import { GearReq } from './GearReq';
+type _Gear = Omit<GearData, 'attributes' | 'potentials' | 'additionalPotentials' | 'addOptions'> & {
+    attributes: GearAttribute;
+    addOptions: readonly Readonly<AddOptionData>[];
+    potentials: readonly ReadonlyPotential[];
+    additionalPotentials: readonly ReadonlyPotential[];
+};
+/**
+ * 장비 (읽기 전용)
+ *
+ * 생성자에 전달된 장비 정보와 `data` 속성 간에 엄격한 동등(`===`)을 보장합니다.
+ *
+ * 장비 정보의 모든 속성에 대해 읽기 전용 속성을 제공합니다.
+ */
+export declare class ReadonlyGear implements _Gear {
+    /** 장비 정보 */
+    protected readonly _data: Readonly<GearData>;
+    /**
+     * 장비 정보를 참조하는 장비 인스턴스를 생성합니다.
+     * @param data 장비 정보.
+     */
+    constructor(data: GearData);
+    /**
+     * 장비 정보
+     */
+    get data(): Readonly<GearData>;
+    /**
+     * 장비 메타데이터
+     */
+    get meta(): GearMetadata;
+    /**
+     * 장비명
+     */
+    get name(): string;
+    /**
+     * 장비 아이콘
+     */
+    get icon(): string;
+    /**
+     * 장비 설명
+     */
+    get desc(): string | undefined;
+    /**
+     * 장비 외형
+     */
+    get shape(): Readonly<GearShapeData> | undefined;
+    /**
+     * 장비 외형 아이콘
+     *
+     * 장비 외형이 설정되었을 경우 장비 외형 아이콘, 그렇지 않을 경우 장비 아이콘.
+     */
+    get shapeIcon(): string;
+    /**
+     * 장비 분류
+     */
+    get type(): GearType;
+    /**
+     * 장비 착용 제한
+     */
+    get req(): GearReq;
+    /**
+     * 장비 속성
+     */
+    get attributes(): GearAttribute;
+    /**
+     * 장비 최종 옵션
+     *
+     * 기본 옵션, 추가 옵션, 주문서 옵션, 스타포스 옵션의 합.
+     *
+     * 익셉셔널 옵션은 미포함.
+     */
+    get totalOption(): Readonly<GearBaseOption & GearAddOption & GearUpgradeOption & GearStarforceOption>;
+    /**
+     * 장비 순수 옵션
+     */
+    get baseOption(): Readonly<GearBaseOption>;
+    /**
+     * 장비 추가 옵션
+     */
+    get addOption(): Readonly<GearAddOption>;
+    /**
+     * 장비 주문서 강화 옵션
+     */
+    get upgradeOption(): Readonly<GearUpgradeOption>;
+    /**
+     * 장비 스타포스 옵션
+     */
+    get starforceOption(): Readonly<GearStarforceOption>;
+    /**
+     * 추가 옵션 목록
+     */
+    get addOptions(): readonly Readonly<AddOptionData>[];
+    /**
+     * 업그레이드 횟수
+     */
+    get scrollUpgradeCount(): number;
+    /**
+     * 복구 가능 횟수
+     */
+    get scrollResilienceCount(): number;
+    /**
+     * 업그레이드 가능 횟수
+     */
+    get scrollUpgradeableCount(): number;
+    /**
+     * 전체 업그레이드 가능 횟수
+     *
+     * 성공, 실패, 황금 망치 적용 여부를 무시한 장비의 기본 업그레이드 가능 횟수입니다.
+     */
+    get scrollTotalUpgradeableCount(): number;
+    /**
+     * 스타포스 강화 단계
+     */
+    get star(): number;
+    /**
+     * 최대 스타포스 강화 단계
+     *
+     * 놀라운 장비 강화 주문서가 사용되었을 경우 최대 `15`입니다.
+     */
+    get maxStar(): number;
+    /**
+     * 놀라운 장비 강화 주문서 사용 여부
+     */
+    get starScroll(): boolean;
+    /**
+     * 소울 인챈트 여부
+     */
+    get soulEnchanted(): boolean;
+    /**
+     * 소울
+     */
+    get soul(): ReadonlySoulData | undefined;
+    /**
+     * 소울 충전량
+     */
+    get soulCharge(): number;
+    /**
+     * 소울 충전 옵션
+     */
+    get soulChargeOption(): Readonly<SoulChargeOption>;
+    /**
+     * 잠재능력 등급
+     */
+    get potentialGrade(): PotentialGrade;
+    /**
+     * 잠재능력 목록
+     */
+    get potentials(): readonly ReadonlyPotential[];
+    /**
+     * 에디셔널 잠재능력 등급
+     */
+    get additionalPotentialGrade(): PotentialGrade;
+    /**
+     * 에디셔널 잠재능력 목록
+     */
+    get additionalPotentials(): readonly Readonly<ReadonlyPotential>[];
+    /**
+     * 장비 익셉셔널 옵션
+     */
+    get exceptionalOption(): Readonly<GearExceptionalOption>;
+    /**
+     * 익셉셔널 강화 횟수
+     */
+    get exceptionalUpgradeCount(): number;
+    /**
+     * 익셉셔널 강화 가능 횟수
+     */
+    get exceptionalUpgradeableCount(): number;
+    /**
+     * 전체 익셉셔널 강화 가능 횟수
+     */
+    get exceptionalTotalUpgradeableCount(): number;
+}
+export {};

package/dist/lib/data/AddOptionData.d.ts

@@ -0,0 +1,62 @@
+/**
+ * 추가 옵션 종류
+ */
+export declare enum AddOptionType {
+    /** STR */
+    str = "str",
+    /** DEX */
+    dex = "dex",
+    /** INT */
+    int = "int",
+    /** LUK */
+    luk = "luk",
+    /** STR, DEX */
+    str_dex = "str,dex",
+    /** STR, INT */
+    str_int = "str,int",
+    /** STR, LUK */
+    str_luk = "str,luk",
+    /** DEX, INT */
+    dex_int = "dex,int",
+    /** DEX, LUK */
+    dex_luk = "dex,luk",
+    /** INT, LUK */
+    int_luk = "int,luk",
+    /** 최대 HP */
+    maxHp = "maxHp",
+    /** 최대 MP */
+    maxMp = "maxMp",
+    /** 공격력 */
+    attackPower = "attackPower",
+    /** 마력 */
+    magicPower = "magicPower",
+    /** 방어력 */
+    armor = "armor",
+    /** 이동속도 */
+    speed = "speed",
+    /** 점프력 */
+    jump = "jump",
+    /** 보스 공격 시 데미지 증가(%) */
+    bossDamage = "bossDamage",
+    /** 데미지(%) */
+    damage = "damage",
+    /** 올스탯(%) */
+    allStat = "allStat",
+    /** 착용 레벨 감소 */
+    reqLevelDecrease = "reqLevelDecrease"
+}
+/**
+ * 추가 옵션 단계
+ */
+export type AddOptionGrade = 1 | 2 | 3 | 4 | 5 | 6 | 7;
+/**
+ * 추가 옵션 정보
+ */
+export interface AddOptionData {
+    /** 추가 옵션 종류 */
+    type: AddOptionType;
+    /** 추가 옵션 단계 */
+    grade: AddOptionGrade;
+    /** 추가 옵션 수치 */
+    value: number;
+}