@rpg-engine/shared 0.7.81 → 0.7.82

package/dist/types/item.types.d.ts

@@ -1,361 +1,366 @@
-import { AnimationEffectKeys } from "./animation.types";
-import { ICharacterPermanentBuff } from "./buff.types";
-import { ICharacter } from "./character.types";
-import { EntityAttackType } from "./entity.types";
-import { IEquipmentSet } from "./equipment.types";
-import { IItemContainer } from "./itemContainer.types";
-import { MapLayers } from "./maps.types";
-import { IResource } from "./resource.types";
-export interface IItem extends IResource {
-    tiledId?: number;
-    owner?: ICharacter | string;
-    type: ItemType;
-    subType: ItemSubType;
-    name: string;
-    description: string;
-    fullDescription: string;
-    key: string;
-    textureAtlas: string;
-    texturePath: string;
-    textureKey: string;
-    attack?: number;
-    defense?: number;
-    weight: number;
-    rarity: string;
-    allowedEquipSlotType: ItemSlotType[];
-    isEquipable: boolean;
-    isStackable: boolean;
-    isTwoHanded: boolean;
-    hasUseWith: boolean;
-    maxStackSize: number;
-    stackQty?: number;
-    isUsable: boolean;
-    usableEffect?: string;
-    isStorable: boolean;
-    x?: number;
-    y?: number;
-    scene?: string;
-    layer?: MapLayers;
-    isSolid: boolean;
-    isItemContainer: boolean;
-    itemContainer?: string | IItemContainer;
-    generateContainerSlots?: number;
-    decayTime?: Date;
-    maxRange?: number;
-    requiredAmmoKeys?: string[];
-    rangeType?: EntityAttackType;
-}
-export declare enum ItemType {
-    Weapon = "Weapon",
-    Armor = "Armor",
-    Accessory = "Accessory",
-    Jewelry = "Jewelry",
-    Consumable = "Consumable",
-    Quest = "Quest",
-    Information = "Information",
-    Tool = "Tool",
-    Container = "Container",
-    Other = "Other",
-    CraftingResource = "CraftingResource"
-}
-export declare enum ItemRarities {
-    Common = "Common",
-    Uncommon = "Uncommon",
-    Rare = "Rare",
-    Epic = "Epic",
-    Legendary = "Legendary"
-}
-export declare enum ItemSubType {
-    Accessory = "Accessory",
-    CraftingResource = "CraftingResource",
-    Armor = "Armor",
-    Legs = "Legs",
-    Axe = "Axe",
-    Boot = "Boot",
-    Ranged = "Ranged",
-    Food = "Food",
-    Glove = "Glove",
-    Helmet = "Helmet",
-    Magic = "Magic",
-    Potion = "Potion",
-    Shield = "Shield",
-    Spear = "Spear",
-    Staff = "Staff",
-    Sword = "Sword",
-    Other = "Other",
-    DeadBody = "DeadBody",
-    Dagger = "Dagger",
-    Mace = "Mace",
-    Tool = "Tool",
-    Book = "Book"
-}
-export declare enum ItemSlotType {
-    Head = "Head",
-    Neck = "Neck",
-    Torso = "Torso",
-    LeftHand = "LeftHand",
-    RightHand = "RightHand",
-    Waist = "Waist",
-    Legs = "Legs",
-    Feet = "Feet",
-    Ring = "Ring",
-    Accessory = "Accessory",
-    Inventory = "Inventory"
-}
-export declare enum ItemSocketEvents {
-    Update = "Update",
-    UpdateAll = "UpdateAll",
-    Look = "Look",
-    Equip = "Equip",
-    Unequip = "Unequip",
-    Pickup = "Pickup",
-    Drop = "Drop",
-    Move = "Move",
-    Use = "Use",
-    UseWith = "Use with...",
-    GetItemInfo = "GetItemInfo",
-    ReadItemInfo = "ReadItemInfo",
-    ContainerOpen = "ContainerOpen",
-    ContainerRead = "ContainerRead",
-    ContainerTransfer = "ContainerTransfer",
-    EquipmentAndInventoryUpdate = "EquipmentAndInventoryUpdate",
-    RangedAttack = "RangedAttack",
-    Buy = "Buy",
-    Sell = "Sell",
-    InventoryOpen = "InventoryOpen",
-    LoadCraftBook = "LoadCraftBook",
-    CraftableItems = "CraftableItems",
-    CraftItem = "CraftItem"
-}
-interface IStringIndex {
-    [key: string]: any;
-}
-export declare const ItemSocketEventsDisplayLabels: IStringIndex;
-export interface IGetItemInfo {
-    id: string;
-    fields: string[];
-}
-export interface IReadItemInfo {
-    id: string;
-    information: string;
-}
-export interface IItemUpdate {
-    id: string;
-    textureAtlas: string;
-    texturePath: string;
-    type: ItemType;
-    subType: ItemSubType;
-    name: string;
-    x: number;
-    y: number;
-    scene?: string;
-    layer: MapLayers;
-    stackQty: number;
-    isStackable?: boolean;
-    isDeadBodyLootable?: boolean;
-}
-export interface IItemUpdateAll {
-    items: IItemUpdate[];
-}
-export interface IItemsInView {
-    [id: string]: IItemInViewBasicInfo;
-}
-export interface IItemInViewBasicInfo {
-    id: string;
-    x?: number;
-    y?: number;
-}
-export declare const ActionsForInventory: {
-    Equipment: ItemSocketEvents[];
-    Consumable: ItemSocketEvents[];
-    CraftingResource: ItemSocketEvents[];
-    Tool: ItemSocketEvents[];
-    Other: ItemSocketEvents[];
-    Container: ItemSocketEvents[];
-};
-export declare const ActionsForLoot: {
-    Equipment: ItemSocketEvents[];
-    Consumable: ItemSocketEvents[];
-    CraftingResource: ItemSocketEvents[];
-    Tool: ItemSocketEvents[];
-    Other: ItemSocketEvents[];
-};
-export declare const ActionsForEquipmentSet: {
-    Equipment: ItemSocketEvents[];
-    Container: ItemSocketEvents[];
-};
-export declare const ActionsForMapContainer: {
-    Equipment: ItemSocketEvents[];
-    Consumable: ItemSocketEvents[];
-    CraftingResource: ItemSocketEvents[];
-    Tool: ItemSocketEvents[];
-    Other: ItemSocketEvents[];
-};
-export interface IPayloadProps {
-    item: IItem | null;
-    actionType: ItemSocketEvents | string;
-}
-export interface IEquipItemPayload {
-    itemId: string;
-    itemContainerId: string;
-}
-export interface IUnequipItemPayload {
-    itemId: string;
-}
-export interface IEquipmentAndInventoryUpdatePayload {
-    equipment?: IEquipmentSet;
-    inventory?: IItemContainer;
-    openEquipmentSetOnUpdate?: boolean;
-    openInventoryOnUpdate?: boolean;
-}
-export declare type Direction = "down" | "up" | "left" | "right" | "down_right" | "down_left" | "up_right" | "up_left";
-export interface IRangedAttack {
-    attackerId: string;
-    targetId: string;
-    direction: Direction;
-    ammoKey?: string;
-    type?: string;
-}
-export interface IUseItemPayload {
-    itemId: string;
-}
-export declare enum SpellCastingType {
-    SelfCasting = "self-casting",
-    RangedCasting = "ranged-casting"
-}
-export interface ILoadCraftBookPayload {
-    itemSubType: string;
-}
-export interface ICraftItemPayload {
-    itemKey: string;
-    itemSubType?: string;
-}
-export interface ICraftableItemIngredient {
-    key: string;
-    name: string;
-    qty: number;
-    texturePath: string;
-}
-export interface ICraftableItem extends IItem {
-    canCraft: boolean;
-    ingredients: ICraftableItemIngredient[];
-    minCraftingRequirements?: [string, number];
-    levelIsOk?: boolean;
-}
-export declare enum RangeTypes {
-    UltraShort = 2,
-    Short = 6,
-    Medium = 7,
-    High = 9,
-    UltraHigh = 12
-}
-export interface IBaseItemBlueprint {
-    key: string;
-    type: ItemType;
-    subType: ItemSubType;
-    textureAtlas: string;
-    texturePath: string;
-    name: string;
-    description: string;
-    weight: number;
-    basePrice?: number;
-    canSell?: boolean;
-    maxStackSize?: number;
-    isTraining?: boolean;
-    minRequirements?: MinRequirements;
-}
-export interface MinRequirements {
-    level: number;
-    skill: {
-        name: string;
-        level: number;
-    };
-}
-export interface IEquippableItemBlueprint extends IBaseItemBlueprint {
-    defense?: number;
-    attack?: number;
-    allowedEquipSlotType: ItemSlotType[];
-    usableEffect?: (character: any) => void | Promise<void>;
-    equippedBuff?: ICharacterPermanentBuff;
-}
-export interface IEquippableRangedAmmoBlueprint extends IBaseItemBlueprint {
-    type: ItemType.Weapon;
-    subType: ItemSubType.Ranged;
-    attack: number;
-    allowedEquipSlotType: [ItemSlotType.Accessory];
-    maxStackSize: number;
-    entityEffects?: string[];
-    entityEffectChance?: number;
-}
-export interface IEquippableArmorBlueprint extends Omit<IEquippableItemBlueprint, "attack"> {
-}
-export interface IEquippableWeaponBlueprint extends IEquippableItemBlueprint {
-    type: ItemType.Weapon;
-    attack: number;
-    defense: number;
-    rangeType: EntityAttackType;
-    isTwoHanded?: boolean;
-    entityEffects?: string[];
-    entityEffectChance?: number;
-}
-export interface IEquippableRangedWeaponTwoHandedBlueprint extends Omit<IEquippableWeaponBlueprint, "defense"> {
-    rangeType: EntityAttackType.Ranged;
-    subType: ItemSubType.Ranged;
-    maxRange: RangeTypes;
-    requiredAmmoKeys: string[];
-    attack: number;
-    isTwoHanded: true;
-    allowedEquipSlotType: [ItemSlotType.LeftHand, ItemSlotType.RightHand];
-}
-export interface IEquippableRangedWeaponOneHandedBlueprint extends Omit<IEquippableWeaponBlueprint, "defense"> {
-    rangeType: EntityAttackType.Ranged;
-    subType: ItemSubType.Ranged;
-    maxRange: RangeTypes;
-    attack: number;
-    allowedEquipSlotType: [ItemSlotType.LeftHand, ItemSlotType.RightHand];
-}
-export interface ICraftableItemBlueprint extends IBaseItemBlueprint {
-    type: ItemType.Consumable | ItemType.CraftingResource;
-    maxStackSize?: number;
-    usableEffect?: (character: any) => void | Promise<void>;
-}
-export interface IToolItemBlueprint extends IBaseItemBlueprint {
-    attack?: number;
-    defense?: number;
-    allowedEquipSlotType: [ItemSlotType.LeftHand, ItemSlotType.RightHand];
-    rangeType: EntityAttackType;
-    hasUseWith: true;
-    useWithMaxDistanceGrid: RangeTypes;
-    canSell: false;
-    usableEffect?: (character: any, targetItem: any, itemCraftable: any, skillIncrease: any) => void | Promise<void>;
-    useWithTileEffect?: (originItem: any, targetTile: any, targetname: string, character: any, itemCraftable: any, skillIncrease: any) => Promise<void>;
-}
-export interface IConsumableItemBlueprint extends ICraftableItemBlueprint {
-    type: ItemType.Consumable;
-    usableEffect: (character: any) => void | Promise<void>;
-}
-export declare enum RunePower {
-    UltraLow = 5,
-    Low = 10,
-    Medium = 15,
-    High = 20,
-    UltraHigh = 25,
-    Fatal = 30
-}
-export interface IRuneItemBlueprint extends IBaseItemBlueprint {
-    hasUseWith: true;
-    canUseOnNonPVPZone: boolean;
-    maxStackSize: number;
-    useWithMaxDistanceGrid: RangeTypes;
-    power: RunePower;
-    animationKey: AnimationEffectKeys;
-    projectileAnimationKey: AnimationEffectKeys;
-    minMagicLevelRequired: number;
-    usableEffect?: (caster: any, target: any) => void | Promise<void> | Promise<number>;
-}
-export interface IEquippableStaffBlueprint extends IEquippableWeaponBlueprint {
-    projectileAnimationKey: AnimationEffectKeys;
-    maxRange: RangeTypes;
-}
-export {};
+import { AnimationEffectKeys } from "./animation.types";
+import { ICharacterPermanentBuff } from "./buff.types";
+import { ICharacter } from "./character.types";
+import { EntityAttackType } from "./entity.types";
+import { IEquipmentSet } from "./equipment.types";
+import { IItemContainer } from "./itemContainer.types";
+import { MapLayers } from "./maps.types";
+import { IResource } from "./resource.types";
+export interface IItem extends IResource {
+    tiledId?: number;
+    owner?: ICharacter | string;
+    type: ItemType;
+    subType: ItemSubType;
+    name: string;
+    description: string;
+    fullDescription: string;
+    key: string;
+    textureAtlas: string;
+    texturePath: string;
+    textureKey: string;
+    attack?: number;
+    defense?: number;
+    weight: number;
+    rarity: string;
+    allowedEquipSlotType: ItemSlotType[];
+    isEquipable: boolean;
+    isStackable: boolean;
+    isTwoHanded: boolean;
+    hasUseWith: boolean;
+    maxStackSize: number;
+    stackQty?: number;
+    isUsable: boolean;
+    usableEffect?: string;
+    isStorable: boolean;
+    x?: number;
+    y?: number;
+    scene?: string;
+    layer?: MapLayers;
+    isSolid: boolean;
+    isItemContainer: boolean;
+    itemContainer?: string | IItemContainer;
+    generateContainerSlots?: number;
+    decayTime?: Date;
+    maxRange?: number;
+    requiredAmmoKeys?: string[];
+    rangeType?: EntityAttackType;
+    minRequirements?: MinRequirements;
+    entityEffects?: string[];
+    entityEffectChance?: number;
+    usableEffectDescription?: string;
+    equippedBuffDescription?: string;
+}
+export declare enum ItemType {
+    Weapon = "Weapon",
+    Armor = "Armor",
+    Accessory = "Accessory",
+    Jewelry = "Jewelry",
+    Consumable = "Consumable",
+    Quest = "Quest",
+    Information = "Information",
+    Tool = "Tool",
+    Container = "Container",
+    Other = "Other",
+    CraftingResource = "CraftingResource"
+}
+export declare enum ItemRarities {
+    Common = "Common",
+    Uncommon = "Uncommon",
+    Rare = "Rare",
+    Epic = "Epic",
+    Legendary = "Legendary"
+}
+export declare enum ItemSubType {
+    Accessory = "Accessory",
+    CraftingResource = "CraftingResource",
+    Armor = "Armor",
+    Legs = "Legs",
+    Axe = "Axe",
+    Boot = "Boot",
+    Ranged = "Ranged",
+    Food = "Food",
+    Glove = "Glove",
+    Helmet = "Helmet",
+    Magic = "Magic",
+    Potion = "Potion",
+    Shield = "Shield",
+    Spear = "Spear",
+    Staff = "Staff",
+    Sword = "Sword",
+    Other = "Other",
+    DeadBody = "DeadBody",
+    Dagger = "Dagger",
+    Mace = "Mace",
+    Tool = "Tool",
+    Book = "Book"
+}
+export declare enum ItemSlotType {
+    Head = "Head",
+    Neck = "Neck",
+    Torso = "Torso",
+    LeftHand = "LeftHand",
+    RightHand = "RightHand",
+    Waist = "Waist",
+    Legs = "Legs",
+    Feet = "Feet",
+    Ring = "Ring",
+    Accessory = "Accessory",
+    Inventory = "Inventory"
+}
+export declare enum ItemSocketEvents {
+    Update = "Update",
+    UpdateAll = "UpdateAll",
+    Look = "Look",
+    Equip = "Equip",
+    Unequip = "Unequip",
+    Pickup = "Pickup",
+    Drop = "Drop",
+    Move = "Move",
+    Use = "Use",
+    UseWith = "Use with...",
+    GetItemInfo = "GetItemInfo",
+    ReadItemInfo = "ReadItemInfo",
+    ContainerOpen = "ContainerOpen",
+    ContainerRead = "ContainerRead",
+    ContainerTransfer = "ContainerTransfer",
+    EquipmentAndInventoryUpdate = "EquipmentAndInventoryUpdate",
+    RangedAttack = "RangedAttack",
+    Buy = "Buy",
+    Sell = "Sell",
+    InventoryOpen = "InventoryOpen",
+    LoadCraftBook = "LoadCraftBook",
+    CraftableItems = "CraftableItems",
+    CraftItem = "CraftItem"
+}
+interface IStringIndex {
+    [key: string]: any;
+}
+export declare const ItemSocketEventsDisplayLabels: IStringIndex;
+export interface IGetItemInfo {
+    id: string;
+    fields: string[];
+}
+export interface IReadItemInfo {
+    id: string;
+    information: string;
+}
+export interface IItemUpdate {
+    id: string;
+    textureAtlas: string;
+    texturePath: string;
+    type: ItemType;
+    subType: ItemSubType;
+    name: string;
+    x: number;
+    y: number;
+    scene?: string;
+    layer: MapLayers;
+    stackQty: number;
+    isStackable?: boolean;
+    isDeadBodyLootable?: boolean;
+}
+export interface IItemUpdateAll {
+    items: IItemUpdate[];
+}
+export interface IItemsInView {
+    [id: string]: IItemInViewBasicInfo;
+}
+export interface IItemInViewBasicInfo {
+    id: string;
+    x?: number;
+    y?: number;
+}
+export declare const ActionsForInventory: {
+    Equipment: ItemSocketEvents[];
+    Consumable: ItemSocketEvents[];
+    CraftingResource: ItemSocketEvents[];
+    Tool: ItemSocketEvents[];
+    Other: ItemSocketEvents[];
+    Container: ItemSocketEvents[];
+};
+export declare const ActionsForLoot: {
+    Equipment: ItemSocketEvents[];
+    Consumable: ItemSocketEvents[];
+    CraftingResource: ItemSocketEvents[];
+    Tool: ItemSocketEvents[];
+    Other: ItemSocketEvents[];
+};
+export declare const ActionsForEquipmentSet: {
+    Equipment: ItemSocketEvents[];
+    Container: ItemSocketEvents[];
+};
+export declare const ActionsForMapContainer: {
+    Equipment: ItemSocketEvents[];
+    Consumable: ItemSocketEvents[];
+    CraftingResource: ItemSocketEvents[];
+    Tool: ItemSocketEvents[];
+    Other: ItemSocketEvents[];
+};
+export interface IPayloadProps {
+    item: IItem | null;
+    actionType: ItemSocketEvents | string;
+}
+export interface IEquipItemPayload {
+    itemId: string;
+    itemContainerId: string;
+}
+export interface IUnequipItemPayload {
+    itemId: string;
+}
+export interface IEquipmentAndInventoryUpdatePayload {
+    equipment?: IEquipmentSet;
+    inventory?: IItemContainer;
+    openEquipmentSetOnUpdate?: boolean;
+    openInventoryOnUpdate?: boolean;
+}
+export declare type Direction = "down" | "up" | "left" | "right" | "down_right" | "down_left" | "up_right" | "up_left";
+export interface IRangedAttack {
+    attackerId: string;
+    targetId: string;
+    direction: Direction;
+    ammoKey?: string;
+    type?: string;
+}
+export interface IUseItemPayload {
+    itemId: string;
+}
+export declare enum SpellCastingType {
+    SelfCasting = "self-casting",
+    RangedCasting = "ranged-casting"
+}
+export interface ILoadCraftBookPayload {
+    itemSubType: string;
+}
+export interface ICraftItemPayload {
+    itemKey: string;
+    itemSubType?: string;
+}
+export interface ICraftableItemIngredient {
+    key: string;
+    name: string;
+    qty: number;
+    texturePath: string;
+}
+export interface ICraftableItem extends IItem {
+    canCraft: boolean;
+    ingredients: ICraftableItemIngredient[];
+    minCraftingRequirements?: [string, number];
+    levelIsOk?: boolean;
+}
+export declare enum RangeTypes {
+    UltraShort = 2,
+    Short = 6,
+    Medium = 7,
+    High = 9,
+    UltraHigh = 12
+}
+export interface IBaseItemBlueprint {
+    key: string;
+    type: ItemType;
+    subType: ItemSubType;
+    textureAtlas: string;
+    texturePath: string;
+    name: string;
+    description: string;
+    weight: number;
+    basePrice?: number;
+    canSell?: boolean;
+    maxStackSize?: number;
+    isTraining?: boolean;
+    minRequirements?: MinRequirements;
+}
+export interface MinRequirements {
+    level: number;
+    skill: {
+        name: string;
+        level: number;
+    };
+}
+export interface IEquippableItemBlueprint extends IBaseItemBlueprint {
+    defense?: number;
+    attack?: number;
+    allowedEquipSlotType: ItemSlotType[];
+    usableEffect?: (character: any) => void | Promise<void>;
+    equippedBuff?: ICharacterPermanentBuff;
+}
+export interface IEquippableRangedAmmoBlueprint extends IBaseItemBlueprint {
+    type: ItemType.Weapon;
+    subType: ItemSubType.Ranged;
+    attack: number;
+    allowedEquipSlotType: [ItemSlotType.Accessory];
+    maxStackSize: number;
+    entityEffects?: string[];
+    entityEffectChance?: number;
+}
+export interface IEquippableArmorBlueprint extends Omit<IEquippableItemBlueprint, "attack"> {
+}
+export interface IEquippableWeaponBlueprint extends IEquippableItemBlueprint {
+    type: ItemType.Weapon;
+    attack: number;
+    defense: number;
+    rangeType: EntityAttackType;
+    isTwoHanded?: boolean;
+    entityEffects?: string[];
+    entityEffectChance?: number;
+}
+export interface IEquippableRangedWeaponTwoHandedBlueprint extends Omit<IEquippableWeaponBlueprint, "defense"> {
+    rangeType: EntityAttackType.Ranged;
+    subType: ItemSubType.Ranged;
+    maxRange: RangeTypes;
+    requiredAmmoKeys: string[];
+    attack: number;
+    isTwoHanded: true;
+    allowedEquipSlotType: [ItemSlotType.LeftHand, ItemSlotType.RightHand];
+}
+export interface IEquippableRangedWeaponOneHandedBlueprint extends Omit<IEquippableWeaponBlueprint, "defense"> {
+    rangeType: EntityAttackType.Ranged;
+    subType: ItemSubType.Ranged;
+    maxRange: RangeTypes;
+    attack: number;
+    allowedEquipSlotType: [ItemSlotType.LeftHand, ItemSlotType.RightHand];
+}
+export interface ICraftableItemBlueprint extends IBaseItemBlueprint {
+    type: ItemType.Consumable | ItemType.CraftingResource;
+    maxStackSize?: number;
+    usableEffect?: (character: any) => void | Promise<void>;
+}
+export interface IToolItemBlueprint extends IBaseItemBlueprint {
+    attack?: number;
+    defense?: number;
+    allowedEquipSlotType: [ItemSlotType.LeftHand, ItemSlotType.RightHand];
+    rangeType: EntityAttackType;
+    hasUseWith: true;
+    useWithMaxDistanceGrid: RangeTypes;
+    canSell: false;
+    usableEffect?: (character: any, targetItem: any, itemCraftable: any, skillIncrease: any) => void | Promise<void>;
+    useWithTileEffect?: (originItem: any, targetTile: any, targetname: string, character: any, itemCraftable: any, skillIncrease: any) => Promise<void>;
+}
+export interface IConsumableItemBlueprint extends ICraftableItemBlueprint {
+    type: ItemType.Consumable;
+    usableEffect: (character: any) => void | Promise<void>;
+}
+export declare enum RunePower {
+    UltraLow = 5,
+    Low = 10,
+    Medium = 15,
+    High = 20,
+    UltraHigh = 25,
+    Fatal = 30
+}
+export interface IRuneItemBlueprint extends IBaseItemBlueprint {
+    hasUseWith: true;
+    canUseOnNonPVPZone: boolean;
+    maxStackSize: number;
+    useWithMaxDistanceGrid: RangeTypes;
+    power: RunePower;
+    animationKey: AnimationEffectKeys;
+    projectileAnimationKey: AnimationEffectKeys;
+    minMagicLevelRequired: number;
+    usableEffect?: (caster: any, target: any) => void | Promise<void> | Promise<number>;
+}
+export interface IEquippableStaffBlueprint extends IEquippableWeaponBlueprint {
+    projectileAnimationKey: AnimationEffectKeys;
+    maxRange: RangeTypes;
+}
+export {};
 //# sourceMappingURL=item.types.d.ts.map