FB2Action_Sleep

Overview

• Sleep action. Override the OnPlay/OnFinish/OnPaused/OnCanceled/OnTick timing hooks in Lua.

Metadata

Field	Value
Kind	action
Environment	B2 - Simulation
Category	actions
Extends	FB2Action_Base
Require	require('Actions.B2Action_Sleep')

Properties (4)

Name	Type	Description
ProgressTime	number	Remaining sleep duration in minutes-as-seconds until WakeUpTime, computed by CalcProgressTime() and returned by GetProgressTime()
SleepBeginTime	integer	Game-time ticks at which sleep started, recorded in OnPlay and exposed via GetSleepBeginTime()
SleepPerSeconds	number	Sleep stat gained per real second, loaded from UB1StatDataAsset; falls back to a hardcoded 0.5 in OnTick if unset
WakeUpTime	integer	Game-time ticks at which self should wake up, computed by CalcWakeUpTime() in OnPlay and checked each OnTick

Functions (5)

Function	Parameters	Returns	Description
OnCanceled	-	-	Callback invoked on Canceled.
OnFinish	-	-	Callback invoked on Finish.
OnPaused	-	-	Callback invoked on Paused.
OnPlay	-	-	Callback invoked on Play.
OnTick	DeltaTime: number, CurrentTime: FDateTime, GameDeltaMinutes: number	-	Callback invoked on Tick.

Override points (5)

Implement these in Lua as FB2Action_Sleep.Override_Name = function(...) end.

Function	Parameters	Returns	Description
Override_OnCanceled	-	-	Timing hook called when the action is canceled.
Override_OnFinish	-	-	Timing hook called when the action finishes.
Override_OnPaused	-	-	Timing hook called when the action is paused.
Override_OnPlay	-	-	Timing hook called when the action starts (play). Override in Lua to replace the start behavior.
Override_OnTick	DeltaTime: number, CurrentTime: FDateTime, GameDeltaMinutes: number	-	Timing hook called every tick while the action runs. (performance-sensitive)