Skip to main content

FB2RabbitHoleComponent

Overview

Component that manages rabbit-hole (off-screen site activity).

Metadata

Field	Value
Kind	`component`
Environment	B2 - Simulation
Category	`components`
Extends	`FB2Component`
Require	`require('Components.B2RabbitHoleComponent')`

Properties (8)

Name	Type	Description
`ChoiceCards`	`FB1ChoiceCardTimeInfo[]`
`CurrentRabbitHoleId`	`string`
`CurrentRabbitHoleInteractionId`	`string`
`DelayRabbitHoleInteractionTimeTaskId`	`FB1TimeTaskId`
`InteractionStartTime`	`integer`
`RabbitHoleFinishTime`	`integer`
`RabbitHoleInteractionDelayTickCount`	`integer`
`RabbitHoleInteractionDelayTicks`	`integer`

Functions (16)

Function	Parameters	Returns	Description
`GetChoiceCards`	`-`	`FB1ChoiceCardTimeInfo[]`	Returns Choice Cards.
`GetCurrentRabbitHoleId`	`-`	`string`	Returns Current Rabbit Hole Id.
`GetCurrentRabbitHoleInteractionId`	`-`	`string`	Returns Current Rabbit Hole Interaction Id.
`GetDefaultCityMoveDataPolicy`	`-`	`EB1CityMoveDataPolicy`	Returns Default City Move Data Policy.
`GetFinishTime`	`-`	`integer`	Returns Finish Time.
`GetInteractionStartTime`	`-`	`integer`	Returns Interaction Start Time.
`IsInRabbitHole`	`-`	`boolean`	Returns whether In Rabbit Hole.
`OnHourChanged`	InPrevTime: `FDateTime`, InCurrentTime: `FDateTime`	`-`	Callback invoked on Hour Changed.
`OnMinuteChanged`	InPrevTime: `FDateTime`, InCurrentTime: `FDateTime`	`-`	Callback invoked on Minute Changed.
`SendAvailableRabbitHoleInteractionIdList`	`-`	`-`	Sends Available Rabbit Hole Interaction Id List.
`SendUpdateCurrentRabbitHoleId`	`-`	`-`	Sends Update Current Rabbit Hole Id.
`SetCurrentRabbitHoleId`	InRabbitHoleId: `string`, InReason: `EB1RabbitHoleInteractionReason`, InFinishTime: `integer`	`-`	Sets Current Rabbit Hole Id.
`SetRabbitHoleInteractionDelayTicks`	InTicks: `integer`	`-`	Sets Rabbit Hole Interaction Delay Ticks.
`TryFinishCurrentRabbitHoleInteraction`	InReason: `EB1RabbitHoleInteractionReason`	`boolean`
`TryStartNextRandomRabbitHoleInteraction`	InReason: `EB1RabbitHoleInteractionReason`	`-`
`TryStartRabbitHoleInteraction`	InRabbitHoleInteractionId: `string`, InReason: `EB1RabbitHoleInteractionReason`	`boolean`

Override points (5)

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

Function	Parameters	Returns	Description
`Override_SendAvailableRabbitHoleInteractionIdList`	`-`	`-`	Sends Available Rabbit Hole Interaction Id List.
`Override_SendUpdateCurrentRabbitHoleId`	`-`	`-`	Sends Update Current Rabbit Hole Id.
`Override_TryFinishCurrentRabbitHoleInteraction`	InReason: `EB1RabbitHoleInteractionReason`	`boolean`
`Override_TryStartNextRandomRabbitHoleInteraction`	InReason: `EB1RabbitHoleInteractionReason`	`-`
`Override_TryStartRabbitHoleInteraction`	InRabbitHoleInteractionId: `string`, InReason: `EB1RabbitHoleInteractionReason`	`boolean`