Class ItemTypeCooldownComponent

constructor

• new ItemTypeCooldownComponent(
      type: ItemType,
      options?: Partial<ItemTypeCooldownComponentOptions>,
  ): ItemTypeCooldownComponent

  Create a new item type cooldown component.

  Parameters

  • type: ItemType

    The item type of the component.
  • Optionaloptions: Partial<ItemTypeCooldownComponentOptions>

    The options for the component.

  Returns ItemTypeCooldownComponent

Static Readonlyidentifier

getCategory

• getCategory(): string

  Get the category of the cooldown component.

  Returns string

  The category of the cooldown component.

getDuration

• getDuration(ticks?: boolean): number

  Get the duration of the cooldown component in seconds.

  Parameters

  • ticks: boolean = false

    Whether to return the duration in ticks; default is false.

  Returns number

  The duration of the cooldown component in seconds or ticks.

setCategory

• setCategory(value: string): void

  Set the category of the cooldown component.

  Parameters

  • value: string

    The category of the cooldown component.

  Returns void

setDuration

• setDuration(value: number, ticks?: boolean): void

  Set the duration of the cooldown component in seconds.

  Parameters

  • value: number

    The duration of the cooldown component in seconds or ticks.
  • ticks: boolean = false

    Whether the value is in ticks; default is false.

  Returns void