Skip to content

Cooldown

Auto-generated from src/stdlib/cooldown.mcrs — do not edit manually.

API


cooldown_start v1.2.0

Start (or restart) a cooldown for the given slot. The cooldown expires after ticks game ticks.

redscript
fn cooldown_start(name: string, ticks: int)

Parameters

ParameterDescription
nameCooldown slot identifier (reserved for future multi-slot support)
ticksDuration in game ticks (20 ticks = 1 second)

Example

redscript
cooldown_start("sword", 40); // 2-second cooldown

cooldown_ready v1.2.0

Check whether the cooldown has expired (i.e. is ready to fire again).

redscript
fn cooldown_ready(name: string) -> int

Parameters

ParameterDescription
nameCooldown slot identifier (reserved for future multi-slot support)

Returns: 1 if the cooldown is ready (inactive or ticks remaining ≤ 0), 0 otherwise

Example

redscript
if (cooldown_ready("sword") == 1) { attack(); cooldown_start("sword", 40); }

cooldown_tick v1.2.0

Advance the cooldown by one tick. Call this every tick from a @tick function. Automatically marks the cooldown inactive when the remaining ticks reach zero.

redscript
fn cooldown_tick(name: string)

Parameters

ParameterDescription
nameCooldown slot identifier (reserved for future multi-slot support)

Example

redscript
@tick fn game_tick() { cooldown_tick("sword"); }

Released under the MIT License.