Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Armor

Module used to manage armor's behavior

Index

Interfaces

Functions

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: { hurt: any; tick: any }): void

  • Registers armor's hurt and tick functions

    deprecated,

    does not work in multiplayer

    Parameters

    • id: string | number

      armor item string or numeric id

    • funcs: { hurt: any; tick: any }
      • hurt:function
        • hurt(params: { attacker: number; b1: boolean; b2: boolean; damage: number; type: number }, item: ItemInstance, index: number, maxDamage: number): boolean

        • Parameters

          • params: { attacker: number; b1: boolean; b2: boolean; damage: number; type: number }
            • attacker: number
            • b1: boolean
            • b2: boolean
            • damage: number
            • type: number
          • item: ItemInstance
          • index: number
          • maxDamage: number

          Returns boolean

      • tick:function
        • tick(item: ItemInstance, index: number, maxDamage: number): boolean

    Returns void

registerOnHurtListener

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

    Parameters

    Returns ItemInstance | void

    the {id: , count: , data: , extra: } object to change armor item, if nothing is returned, armor will be damaged by default.

registerOnTakeOffListener

registerOnTakeOnListener

registerOnTickListener

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

    Parameters

    Returns ItemInstance | void

    the {id: , count: , data: , extra: } object to change armor item, if nothing is returned, armor will not be changed.

Generated using TypeDoc