FB2ControllerSystem

Overview

Controller (possession / input control) system.

Metadata

Field	Value
Kind	`system`
Environment	B2 - Simulation
Category	`systems`
Extends	`FB2Subsystem`
Require	`require('Systems.FB2ControllerSystem')`

Properties (12)

Name	Type	Description
`ActivityFeedData`	`FB2PlayerActivityFeedData`
`BuildModeSiteEntityId`	`FB1EntityId`
`CachedPossessedCharacter`	`any`	UPROPERTY(Transient)
`CheatSelectInteractionSequenceId`	`string`
`LastInputTime`	`number`
`PossessEntityId`	`FB1EntityId`
`PossessHouseholdId`	`FB1EntityId`	Caches the Family EntityId since the StatComponent looks it up often.
`RemainTickCountByActiveEvent`	`integer`
`UpdateShowActionPlayerInfoReaminTime`	`number`
`bIsShowActionPlayerInfo`	`boolean`
`bIsShowingInteractionBagRatio`	`boolean`
`bIsValidCheatSelectInteractionSequenceId`	`boolean`

Functions (25)

Function	Parameters	Returns	Description
`AddActivityFeed`	InParam: `FB1ActivityFeedParam`	`-`	Player-centric Activity Feed.
`CheckBirthdayEve`	`-`	`-`	Checks Birthday Eve.
`GetActivityFeedData`	`-`	`FB2PlayerActivityFeedData`	Returns Activity Feed Data.
`GetBuildModeSiteEntityId` (static)	`-`	`FB1EntityId`	Returns Build Mode Site Entity Id.
`GetPossessEntityId` (static)	`-`	`FB1EntityId`	Returns Possess Entity Id.
`GetPossessedHouseholdId` (static)	`-`	`FB1EntityId`	Returns Possessed Household Id.
`GetSinceTimeLastInput`	`-`	`number`	Returns Since Time Last Input.
`IsBuildMode` (static)	`-`	`boolean`	Returns whether Build Mode.
`IsPossessEntity`	InEntityId: `FB1EntityId`	`boolean`	Returns whether Possess Entity.
`IsPossessFamilyTreeEntity`	InEntityId: `FB1EntityId`	`boolean`	Returns whether Possess Family Tree Entity.
`IsPossessHouseholdEntity`	InEntityId: `FB1EntityId`	`boolean`	Returns whether Possess Household Entity.
`IsPossessRelationshipEntity`	InEntityId: `FB1EntityId`	`boolean`	Returns whether Possess Relationship Entity.
`IsPossessedEntityInRabbithole`	OutRabbitholeFinishTime: `integer`	`boolean`	Returns whether Possessed Entity In Rabbithole.
`IsPossessedHouseholdId` (static)	InHouseholdEntityId: `FB1EntityId`	`boolean`	Returns whether Possessed Household Id.
`RemoveAllFeeds`	`-`	`-`	Removes All Feeds.
`RemoveFeedsByCategory`	InCategory: `string`	`-`	Removes Feeds By Category.
`RemoveNewFeed`	InFeedId: `FB1ActivityFeedId`	`-`	Removes New Feed.
`SendInitActivityFeedToB1`	`-`	`-`	Sends Init Activity Feed To B1.
`SetBuildModeSiteEntityId`	InEntityId: `FB1EntityId`	`-`	Sets Build Mode Site Entity Id.
`SetIsShowingInteractionBagRatio`	InIsShow: `boolean`	`-`	Sets Is Showing Interaction Bag Ratio.
`ShowActionPlayerInfo`	IsOn: `boolean`	`-`
`Tick`	DeltaTime: `number`	`-`
`TriggerInput`	`-`	`-`
`TryChangePossessEntityId`	InEntityId: `FB1EntityId`, InCloseMapMode: `boolean`	`boolean`
`TryChangePossessHouseholdId`	InHouseholdId: `FB1EntityId`	`boolean`

Override points (11)

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

Function	Parameters	Returns	Description
`Override_AddActivityFeed`	InParam: `FB1ActivityFeedParam`	`-`	Player-centric Activity Feed.
`Override_CheckBirthdayEve`	`-`	`-`	Checks Birthday Eve.
`Override_RemoveAllFeeds`	`-`	`-`	Removes All Feeds.
`Override_RemoveFeedsByCategory`	InCategory: `string`	`-`	Removes Feeds By Category.
`Override_RemoveNewFeed`	InFeedId: `FB1ActivityFeedId`	`-`	Removes New Feed.
`Override_SendInitActivityFeedToB1`	`-`	`-`	Sends Init Activity Feed To B1.
`Override_ShowActionPlayerInfo`	IsOn: `boolean`	`-`
`Override_Tick`	DeltaTime: `number`	`-`
`Override_TriggerInput`	`-`	`-`
`Override_TryChangePossessEntityId`	InEntityId: `FB1EntityId`, InCloseMapMode: `boolean`	`boolean`
`Override_TryChangePossessHouseholdId`	InHouseholdId: `FB1EntityId`	`boolean`