Class ItemCooldownComponent

Hierarchy (View Summary)

ItemComponent
- ItemCooldownComponent

Index

Constructors

Properties

cooldownCategory cooldownTicks isValid typeId

Methods

getCooldownTicksRemaining isCooldownCategory startCooldown

Constructors

`Private`constructor

new ItemCooldownComponent(): ItemCooldownComponent
Returns ItemCooldownComponent
Overrides ItemComponent.constructor

Properties

`Readonly`cooldownCategory

cooldownCategory: string

Throws

This property can throw errors.

World Ready

This property can't be read in early-execution mode.

`Readonly`cooldownTicks

cooldownTicks: number

Throws

This property can throw errors.

World Ready

This property can't be read in early-execution mode.

`Readonly`isValid

isValid: boolean

`Readonly`typeId

typeId: string

Methods

getCooldownTicksRemaining

getCooldownTicksRemaining(player: Player): number
Parameters
- player: Player
Returns number
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

isCooldownCategory

isCooldownCategory(cooldownCategory: string): boolean
Parameters
- cooldownCategory: string
Returns boolean
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

startCooldown

startCooldown(player: Player): void
Parameters
- player: Player
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.