Skip to main content

FB2Action_RabbitHole

Overview

Rabbit-hole action. The character disappears on execution, waits until the F1 time, then reappears in front of the home.

Metadata

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

Properties (3)

Name	Type	Description
`FinishTick`	`integer`	Absolute tick timestamp computed from FinishTime, compared against CurrentTime in OnTick to finish the action
`FinishTime`	`integer`	Time of day (HHMM) at which the rabbit hole action finishes, derived from Action.F1 or Action.F2 duration
`RabbitHoleId`	`string`	FB1RabbitHoleTableRow row id identifying which rabbit hole content to run

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_RabbitHole.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)