FB2GameOptionManager

Overview

Manages game option settings.

Metadata

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

Properties (20)

Name	Type	Description
`ActiveActionEnergyCost`	`integer`
`AgeProgressRate`	`table<EB1GrowthStep, number>`
`CostumeVarietyLevel`	`integer`
`FreezeAgeToOtherZois`	`boolean`
`FreezeAgeToPossessHousehold`	`boolean`
`MaxCostumeVarietyLevel`	`integer`
`MaxWaitingFamilyZoiCount`	`integer`
`PregnancyDurationRate`	`number`
`RecommendedInteractionLevel`	`integer`
`SimulationPreset`	`EB1SimulationPreset`	Simulation preset (Custom/Minimum..Ultra). The Custom path falls back to OptimizeAutonomy.
`TemperatureEffect`	`EB1TemperatureEffect`
`bAutonomyMultiInteraction`	`boolean`
`bEnableActiveAction`	`boolean`
`bEnableGhost`	`boolean`
`bFreezeMuscle`	`boolean`
`bFreezeObesity`	`boolean`
`bOptimizeAutonomy`	`boolean`
`bPlayFamilyAutoSchedule`	`boolean`
`bTeleportToDestinationPopup`	`boolean`
`bVehicleQuickTravelEnabled`	`boolean`

Functions (37)

Function	Parameters	Returns	Description
`AdjustPlayFamilyAutoSchedule`	InPrevHouseholdEntityId: `FB1EntityId`, InCurrHouseholdEntityId: `FB1EntityId`	`-`
`GetActiveActionEnergyCost`	`-`	`integer`	Returns Active Action Energy Cost.
`GetAgeProgressRate`	InGrowthStep: `EB1GrowthStep`	`number`	Returns Age Progress Rate.
`GetCostumeVarietyLevel`	`-`	`integer`	Returns Costume Variety Level.
`GetMaxCostumeVarietyLevel`	`-`	`integer`	Returns Max Costume Variety Level.
`GetMaxWaitingFamilyZoiCount`	`-`	`integer`	Returns Max Waiting Family Zoi Count.
`GetPregnancyDurationRate`	`-`	`number`	Returns Pregnancy Duration Rate.
`GetRecommendedInteractionLevel`	`-`	`integer`	Returns Recommended Interaction Level.
`GetSimulationPreset`	`-`	`EB1SimulationPreset`	Returns Simulation Preset.
`GetTeleportToDestinationPopup`	`-`	`boolean`	Returns Teleport To Destination Popup.
`GetTemperatureEffect`	`-`	`EB1TemperatureEffect`	Returns Temperature Effect.
`GetType`	`-`	`EB2ManagerType`	Returns Type.
`IsAgingPaused`	InPossessHousehold: `boolean`	`boolean`	Returns whether Aging Paused.
`IsAutonomyMultiInteractionEnabled`	`-`	`boolean`	Returns whether Autonomy Multi Interaction Enabled.
`IsFreezeMuscle`	`-`	`boolean`	Returns whether Freeze Muscle.
`IsFreezeObesity`	`-`	`boolean`	Returns whether Freeze Obesity.
`IsGhostEnabled`	`-`	`boolean`	Returns whether Ghost Enabled.
`IsOptimizeAutonomyEnabled`	`-`	`boolean`	Returns whether Optimize Autonomy Enabled.
`IsPlayFamilyAutoSchedule`	`-`	`boolean`	Returns whether Play Family Auto Schedule.
`OnChangePossessHouseholdEntityId`	InPrevHouseholdEntityId: `FB1EntityId`, InCurrHouseholdEntityId: `FB1EntityId`	`-`	Callback invoked on Change Possess Household Entity Id.
`SetActiveActionEnergyCost`	InCost: `integer`	`-`	Sets Active Action Energy Cost.
`SetAgeProgressRate`	InGrowthStep: `EB1GrowthStep`, InValue: `number`	`-`	Sets Age Progress Rate.
`SetAutonomyMultiInteraction`	InAutonomyMultiInteraction: `boolean`	`-`	Sets Autonomy Multi Interaction.
`SetCostumeVariety`	InLevel: `integer`, InMaxLevel: `integer`	`-`	Sets Costume Variety.
`SetEnableGhost`	bInEnableGhost: `boolean`	`-`	Sets Enable Ghost.
`SetFreezeAgeToOtherZois`	InFreezeAge: `boolean`	`-`	Sets Freeze Age To Other Zois.
`SetFreezeAgeToPossessHousehold`	InFreezeAge: `boolean`	`-`	Sets Freeze Age To Possess Household.
`SetFreezeMuscle`	bInFreezeMuscle: `boolean`	`-`	Sets Freeze Muscle.
`SetFreezeObesity`	bInFreezeObesity: `boolean`	`-`	Sets Freeze Obesity.
`SetMaxWaitingFamilyZoiCount`	InMaxWaitingFamilyZoiCount: `integer`	`-`	Sets Max Waiting Family Zoi Count.
`SetOptimizeAutonomy`	bInValue: `boolean`	`-`	Sets Optimize Autonomy.
`SetPlayFamilyAutoSchedule`	bInValue: `boolean`	`-`	Sets Play Family Auto Schedule.
`SetPregnancyDurationRate`	InValue: `number`	`-`	Sets Pregnancy Duration Rate.
`SetRecommendedInteractionLevel`	InLevel: `integer`	`-`	Sets Recommended Interaction Level.
`SetSimulationPreset`	InPreset: `EB1SimulationPreset`	`-`	Links the simulation preset; the top-priority input for deciding the SLOD2 spread-out interval.
`SetTeleportToDestinationPopup`	InTeleportToDestinationPopup: `boolean`	`-`	Sets Teleport To Destination Popup.
`SetTemperatureEffect`	InLevel: `EB1TemperatureEffect`	`-`	Sets Temperature Effect.

Override points (2)

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

Function	Parameters	Returns	Description
`Override_AdjustPlayFamilyAutoSchedule`	InPrevHouseholdEntityId: `FB1EntityId`, InCurrHouseholdEntityId: `FB1EntityId`	`-`
`Override_OnChangePossessHouseholdEntityId`	InPrevHouseholdEntityId: `FB1EntityId`, InCurrHouseholdEntityId: `FB1EntityId`	`-`	Callback invoked on Change Possess Household Entity Id.