Skip to main content

FB2HouseholdMonitoringComponent

Overview

Component that monitors household state.

Metadata

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

Properties (3)

Name	Type	Description
`CurrentTimeTaskIds`	`FB1TimeTaskId[]`
`HouseholdMonitoringNotificationList`	`FB1HouseholdMonitoringNotificationData[]`
`UnreadHouseholdMonitoringNotificationCount`	`integer`

Functions (11)

Function	Parameters	Returns	Description
`AddHouseholdMonitoringNotification`	InParam: `FB1HouseholdMonitoringNotificationParam`, InDelayHHMM: `integer`	`-`	Adds Household Monitoring Notification.
`AddHouseholdMonitoringNotificationImmediate`	InParam: `FB1HouseholdMonitoringNotificationParam`	`boolean`	Adds Household Monitoring Notification Immediate.
`GetDefaultCityMoveDataPolicy`	`-`	`EB1CityMoveDataPolicy`	Returns Default City Move Data Policy.
`HasHouseholdMonitoringNotification`	InNotificationId: `string`	`boolean`	Returns whether it has Household Monitoring Notification.
`MakeNotificationDataFromParam`	InParam: `FB1HouseholdMonitoringNotificationParam`, OutData: `FB1HouseholdMonitoringNotificationData`	`boolean`	Converts notification parameters into actual notification data.
`OnOwnerHouseholdPossessed`	`-`	`-`	Callback invoked on Owner Household Possessed.
`RemoveAllHouseholdMonitoringNotificationTimeTasks`	`-`	`-`	Removes All Household Monitoring Notification Time Tasks.
`RemoveAllHouseholdMonitoringNotifications`	`-`	`-`	Removes All Household Monitoring Notifications.
`RemoveHouseholdMonitoringNotificationsById`	InNotificationId: `string`	`-`	Removes Household Monitoring Notifications By Id.
`RemoveTimeTaskId`	InTimeTaskId: `FB1TimeTaskId`	`-`	Removes Time Task Id.
`ResetUnreadHouseholdMonitoringNotificationCount`	`-`	`-`	Resets Unread Household Monitoring Notification Count.

Override points (6)

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

Function	Parameters	Returns	Description
`Override_AddHouseholdMonitoringNotification`	InParam: `FB1HouseholdMonitoringNotificationParam`, InDelayHHMM: `integer`	`-`	Adds Household Monitoring Notification.
`Override_AddHouseholdMonitoringNotificationImmediate`	InParam: `FB1HouseholdMonitoringNotificationParam`	`boolean`	Adds Household Monitoring Notification Immediate.
`Override_OnOwnerHouseholdPossessed`	`-`	`-`	Callback invoked on Owner Household Possessed.
`Override_RemoveAllHouseholdMonitoringNotificationTimeTasks`	`-`	`-`	Removes All Household Monitoring Notification Time Tasks.
`Override_RemoveHouseholdMonitoringNotificationsById`	InNotificationId: `string`	`-`	Removes Household Monitoring Notifications By Id.
`Override_RemoveTimeTaskId`	InTimeTaskId: `FB1TimeTaskId`	`-`	Removes Time Task Id.