Dev » Lua API » randomevent
← Back to all classes

randomevent

Definitions & Systems 4 Hooks

randomevent

Random events in Stranded III (e.g. storms, supply drops, animal migrations) are registered in def.randomEvent.*. They define condition checks and event lifecycle hooks.

Overview Hooks (4) Detailed Reference ↓

Overview

Hooks & Events (4)

Hook Signature Returns Summary
randomEvent:canOccur(day) boolean Validates if the random event can trigger on the given day.
randomEvent:onStart() boolean Triggered when the random event starts.
randomEvent:onStop() boolean Triggered when the random event ends.
randomEvent:onUpdate() void Triggered periodically while the event is active.

Detailed Reference

# canOccur HOOK
randomEvent:canOccur(day)
Validates if the random event can trigger on the given day.
Parameters
ParameterTypeDefaultDescription
daynumber

Current in-game day number.

Returns
boolean

True if event can occur.

Description

Called during hourly event checks to verify conditions.

def.randomEvent.supply_drop = {
    canOccur = function(day)
        return day >= 3
    end
}
# onStart HOOK
randomEvent:onStart()
Triggered when the random event starts.
Parameters
None
Returns
boolean

Return true to cancel starting.

Description

Called when the event begins.

# onStop HOOK
randomEvent:onStop()
Triggered when the random event ends.
Parameters
None
Returns
boolean

Return true to prevent stopping.

Description

Called when the event concludes or is terminated.

# onUpdate HOOK
randomEvent:onUpdate()
Triggered periodically while the event is active.
Parameters
None
Returns
None (void)
Description

Called every update cycle while the event is running.