FB2PerspectiveComponent
Overview
- Component that manages perspective-related data.
Metadata
| Field | Value |
|---|---|
| Kind | component |
| Environment | B2 - Simulation |
| Category | components |
| Extends | FB2Component |
| Require | require('Components.B2PerspectiveComponent') |
Properties (4)
| Name | Type | Description |
|---|---|---|
BioComponent | any | |
Perspectives | table<string, FB1Perspective> | |
bIsEnableDailyPopup | boolean | |
bIsMainPerspectiveChange | boolean |
Functions (16)
| Function | Parameters | Returns | Description |
|---|---|---|---|
AddPerspectiveCoolTime | InPerspectiveId: string, InCategoryId: string, InInteractionBagId: string, InValue: number | - | Adds Perspective Cool Time. |
CalculateProbability | InCategoryId: string | boolean | |
GetDefaultCityMoveDataPolicy | - | EB1CityMoveDataPolicy | Returns Default City Move Data Policy. |
GetMainPerspective | - | string | Returns Main Perspective. |
GetPerspective | InPerspectiveId: string | number | Returns Perspective. |
GetPerspectiveMap | - | table<string, FB1Perspective> | Returns Perspective Map. |
InheritPerspective | InPrevGrowthStep: EB1GrowthStep, InCurrGrowthStep: EB1GrowthStep | string | |
InitPerspectiveByTrait | InTraitId: string | - | Initializes Perspective By Trait. |
IsCoolTimeReady | InPerspectiveId: string, InCategoryId: string, InInteractionBagId: string | boolean | Returns whether Cool Time Ready. |
IsCoolTimeReadyAtTime | InDateTime: FDateTime, InPerspectiveId: string, InCategoryId: string, InInteractionBagId: string | boolean | Returns whether Cool Time Ready At Time. |
IsMainPerspectiveChange | - | boolean | Returns whether Main Perspective Change. |
OnDayChanged | Before: FDateTime, After: FDateTime | - | Callback invoked on Day Changed. |
ResetPerspective | bIsValue: boolean | - | For AutomationTest. Don't use this for GamePlay |
SetMainPerspectiveChange | InMainPerspectiveChange: boolean | - | Sets Main Perspective Change. |
UpdateCoolTime | InPerspectiveId: string, InInteractionBagId: string | - | Updates Cool Time. |
UpdateMainPerspectiveUI | InMainPerspectiveId: string | - | Updates Main Perspective UI. |
Override points (8)
Implement these in Lua as FB2PerspectiveComponent.Override_Name = function(...) end.
| Function | Parameters | Returns | Description |
|---|---|---|---|
Override_AddPerspectiveCoolTime | InPerspectiveId: string, InCategoryId: string, InInteractionBagId: string, InValue: number | - | Adds Perspective Cool Time. |
Override_CalculateProbability | InCategoryId: string | boolean | |
Override_InheritPerspective | InPrevGrowthStep: EB1GrowthStep, InCurrGrowthStep: EB1GrowthStep | string | |
Override_InitPerspectiveByTrait | InTraitId: string | - | Initializes Perspective By Trait. |
Override_OnDayChanged | Before: FDateTime, After: FDateTime | - | Callback invoked on Day Changed. |
Override_ResetPerspective | bIsValue: boolean | - | For AutomationTest. Don't use this for GamePlay |
Override_UpdateCoolTime | InPerspectiveId: string, InInteractionBagId: string | - | Updates Cool Time. |
Override_UpdateMainPerspectiveUI | InMainPerspectiveId: string | - | Updates Main Perspective UI. |