Armor

Module used to manage armor's behavior.

Index

Interfaces

• ArmorGeneralFunction
• ArmorHurtFunction
• IArmorCallback
• IArmorHurtParams
• IArmorInfo
• IArmorJSCallback

Functions

• preventDamaging
• registerFuncs
• registerLocalOnTakeOffListener
• registerLocalOnTakeOnListener
• registerOnHurtListener
• registerOnLocalTickListener
• registerOnTakeOffListener
• registerOnTakeOnListener
• registerOnTickListener

Interfaces

ArmorGeneralFunction

• ArmorGeneralFunction(item: ItemInstance, slot: number, player: number): void

• Parameters

  • item: ItemInstance

  • slot: number

  • player: number

  Returns void

ArmorHurtFunction

• ArmorHurtFunction(item: ItemInstance, slot: number, player: number, value: number, type: number, attacker: number, bool1: boolean, bool2: boolean): void

• Parameters

  • item: ItemInstance

  • slot: number

  • player: number

  • value: number

  • type: number

  • attacker: number

  • bool1: boolean

  • bool2: boolean

  Returns void

IArmorCallback

IArmorCallback:

hurt

• hurt(params: IArmorHurtParams, slot: ItemInstance, index: number, armorInfo: IArmorInfo): boolean

• Parameters

  • params: IArmorHurtParams

  • slot: ItemInstance

  • index: number

  • armorInfo: IArmorInfo

  Returns boolean

tick

• tick(slot: ItemInstance, index: number, armorInfo: IArmorInfo): boolean

• Parameters

  • slot: ItemInstance

  • index: number

  • armorInfo: IArmorInfo

  Returns boolean

IArmorHurtParams

IArmorHurtParams:

attacker

attacker: number

Attacker entity or -1 if the damage was not caused by an entity.

bool1

bool1: boolean

TODO: Unknown param!

bool2

bool2: boolean

TODO: Unknown param!

damage

damage: number

Damage amount that was applied to the player.

type

type: number

Damage type.

IArmorInfo

IArmorInfo:

callback

callback: IArmorCallback

durability

durability: number

IArmorJSCallback

IArmorJSCallback:

hurt

• hurt(params: IArmorHurtParams, slot: ItemInstance, index: number, durability: number): boolean

• Called when player deals damage if player wears the armor.

  ---

  Parameters

  • params: IArmorHurtParams

    additional data about damage

  • slot: ItemInstance

    current armor item instance

  • index: number

    armor slot, one of the EArmorType values

  • durability: number

    maximum damage the armor

  Returns boolean

  true, if changes to the item parameter should be applied, false otherwise.

tick

• tick(slot: ItemInstance, index: number, durability: number): boolean

• Called every tick if player wears the armor.

  ---

  Parameters

  • slot: ItemInstance

    current armor item instance

  • index: number

    armor slot, one of the EArmorType values

  • durability: number

    maximum damage the armor

  Returns boolean

  true, if changes to the item parameter should be applied, false otherwise.

Functions

preventDamaging

• preventDamaging(id: string | number): void

• Prevents armor from being damaged.

  ---

  Parameters

  • id: string | number

    armor item string or numeric ID

  Returns void

registerFuncs

• registerFuncs(id: string | number, funcs: IArmorJSCallback): void

• Registers armor's hurt and tick functions.

  @deprecated

  Use multiplayer Armor.registerOnHurtListener and anothers or callbacks.

  ---

  Parameters

  • id: string | number

    armor item string or numeric ID

  • funcs: IArmorJSCallback

  Returns void

registerLocalOnTakeOffListener

• registerLocalOnTakeOffListener(id: number, func: ArmorGeneralFunction): void

• This event is called when local player takes off or changes this armor item.

  @since

  2.2.1b106

  ---

  Parameters

  • id: number

  • func: ArmorGeneralFunction

  Returns void

registerLocalOnTakeOnListener

• registerLocalOnTakeOnListener(id: number, func: ArmorGeneralFunction): void

• This event is called when local player takes on this armor, or spawns with it.

  @since

  2.2.1b106

  ---

  Parameters

  • id: number

  • func: ArmorGeneralFunction

  Returns void

registerOnHurtListener

• registerOnHurtListener(id: number, func: ArmorHurtFunction): void

• This event is called when the damage is dealt to the player that has this armor put on.

  ---

  Parameters

  • id: number

  • func: ArmorHurtFunction

  Returns void

  Item object to change armor item, if nothing is returned, armor will not be changed.

registerOnLocalTickListener

• registerOnLocalTickListener(id: number, func: ArmorGeneralFunction): void

• This event is called every tick for local player that has this armor put on.

  @since

  2.2.1b106

  ---

  Parameters

  • id: number

  • func: ArmorGeneralFunction

  Returns void

  Item object to change armor item, if nothing is returned, armor will not be changed.

registerOnTakeOffListener

• registerOnTakeOffListener(id: number, func: ArmorGeneralFunction): void

• This event is called when player takes off or changes this armor item.

  ---

  Parameters

  • id: number

  • func: ArmorGeneralFunction

  Returns void

registerOnTakeOnListener

• registerOnTakeOnListener(id: number, func: ArmorGeneralFunction): void

• This event is called when player takes on this armor, or spawns with it.

  ---

  Parameters

  • id: number

  • func: ArmorGeneralFunction

  Returns void

registerOnTickListener

• registerOnTickListener(id: number, func: ArmorGeneralFunction): void

• This event is called every tick for every player that has this armor put on.

  ---

  Parameters

  • id: number

  • func: ArmorGeneralFunction

  Returns void

  Item object to change armor item, if nothing is returned, armor will not be changed.