FB2AmbitionComponent

Overview

• Component that manages ambitions.

Metadata

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

Properties (3)

Name	Type	Description
AmbitionItems	table<string, FB1AmbitionState>
CompletedAmbitionItemIds	string[]
PlayingAmbitionItemId	string

Functions (25)

Function	Parameters	Returns	Description
ApplyCharacterAttributeAmbition	InAmbitionItemId: string	-	Applies Character Attribute Ambition.
CheckAmbitionItemCondition	InAmbitionItemTableRow: FB1AmbitionItemTableRow	boolean	Checks Ambition Item Condition.
CompleteAllAmbition	IsAllCompleted: boolean	-
CompleteAmbition	InAmbitionItemId: string	-
FillChangeAmbitionInfo	OutChangeAmbitionInfo: FB1ChangeAmbitionInfo	-
FillPlayingAmbitionInfo	OutPlayingAmbitionInfo: FB1PlayingAmbitionInfo	-
FindAmbitionState	InAmbitionItemId: string	FB1AmbitionState	Finds and returns Ambition State.
GetAmbitionCurrentStep	InAmbitionItemId: string, InForUI: boolean	integer	Returns Ambition Current Step.
GetCompleteAmbitionCount	-	integer	Returns Complete Ambition Count.
GetDefaultCityMoveDataPolicy	-	EB1CityMoveDataPolicy	Returns Default City Move Data Policy.
GetPlayableAmbitionIds	OutAmbitionItemIds: string[]	-	Returns Playable Ambition Ids.
GetPlayingAmbitionItemId	-	string	Returns Playing Ambition Item Id.
IsCompleteAllAmbition	-	boolean	Returns whether Complete All Ambition.
IsCompleteAmbitionItem	InAmbitionItemId: string	boolean	Returns whether Complete Ambition Item.
IsCompletedAmbition	InAmbitionId: string	boolean	Returns whether Completed Ambition.
IsExpiredAmbitionItem	InAmbitionItemId: string	boolean	Returns whether Expired Ambition Item.
IsGrowthStepAvailable	-	boolean	Returns whether Growth Step Available.
IsPlayableAmbitionItem	InAmbitionItemId: string	boolean	Returns whether Playable Ambition Item.
IsPlayingAmbition	-	boolean	Returns whether Playing Ambition.
IsPlayingAmbitionItemId	InAmbitionItemId: string	boolean	Returns whether Playing Ambition Item Id.
OnFinishMission	InMissionDtKey: string, InMissionId: FB1MissionId	-	Callback invoked on Finish Mission.
PlayAmbition	InAmbitionItemId: string	boolean	Plays Ambition.
ReplaceContentData	InPrevGrowthStep: EB1GrowthStep, InCurrGrowthStep: EB1GrowthStep	-	GrowthChangeInterface Begin
ResetAmbition	InAmbitionItemId: string	-	Resets Ambition.
TryPlayAmbition	InAmbitionItemId: string	boolean

Override points (10)

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

Function	Parameters	Returns	Description
Override_ApplyCharacterAttributeAmbition	InAmbitionItemId: string	-	Applies Character Attribute Ambition.
Override_CheckAmbitionItemCondition	InAmbitionItemTableRow: FB1AmbitionItemTableRow	boolean	Checks Ambition Item Condition.
Override_CompleteAllAmbition	IsAllCompleted: boolean	-
Override_CompleteAmbition	InAmbitionItemId: string	-
Override_FindAmbitionState	InAmbitionItemId: string	FB1AmbitionState	Finds and returns Ambition State.
Override_OnFinishMission	InMissionDtKey: string, InMissionId: FB1MissionId	-	Callback invoked on Finish Mission.
Override_PlayAmbition	InAmbitionItemId: string	boolean	Plays Ambition.
Override_ReplaceContentData	InPrevGrowthStep: EB1GrowthStep, InCurrGrowthStep: EB1GrowthStep	-	GrowthChangeInterface Begin
Override_ResetAmbition	InAmbitionItemId: string	-	Resets Ambition.
Override_TryPlayAmbition	InAmbitionItemId: string	boolean