CooldownHandle
@zylem/game-lib / behavior / CooldownHandle
Interface: CooldownHandle
Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/cooldown.d.ts:27
Handle methods returned by entity.use(CooldownBehavior, ...).
Methods
fire()
fire(
name):void
Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/cooldown.d.ts:31
Fire (trigger) a named cooldown, resetting its timer
Parameters
name
string
Returns
void
getProgress()
getProgress(
name):number
Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/cooldown.d.ts:35
Get cooldown progress 0..1 (0 = just fired, 1 = ready)
Parameters
name
string
Returns
number
isReady()
isReady(
name):boolean
Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/cooldown.d.ts:29
Check if a named cooldown is ready
Parameters
name
string
Returns
boolean
reset()
reset(
name):void
Defined in: node_modules/.pnpm/@zylem+behaviors@0.8.9_@types+react@19.3.0_react@19.3.0_three@0.185.1/node_modules/@zylem/behaviors/dist/cooldown.d.ts:33
Force a cooldown to ready immediately
Parameters
name
string
Returns
void