FB2MissionComponent

Overview

Component that manages missions.

Metadata

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

Properties (5)

Name	Type	Description
`ActiveMissionIdByCondition`	`table<EB1MissionCondition, FB1MissionIdList>`
`MissionIdByWorldMissionDtId`	`table<string, FB1MissionId>`
`MissionMap`	`table<FB1MissionId, FB1MissionState>`
`TriggersIndex`	`integer`
`TriggersList`	`FB1MissionConditionTriggerList[]`	Triggers are batched to a later tick or another function rather than processed immediately. Processing inside Set/Add functions could spawn additional missions after one is achieved, and if a spawned mission is the same type, it could conflict while the mission list is still being modified at trigger time; batching is for stability.

Functions (73)

Function	Parameters	Returns	Description
`ActivateMission`	InMissionId: `FB1MissionId`	`-`
`ActivateMissions`	InMissionIds: `FB1MissionId[]`	`-`
`AddMission`	InRequestParam: `FB2RequestAddMissionParam`	`FB1MissionId`	Adds Mission.
`ApplyTrigger`	`-`	`-`	Applies Trigger.
`CheckEmployeeCountMission`	`-`	`-`	Checks the employee-count mission (called on ambition change or business-owner change).
`CheckHouseholdBizArrivedOperatingMission`	`-`	`-`	Checks whether the character arrived at a business location with a specific SiteTag during operating hours.
`CheckHouseholdBizLevelMission`	`-`	`-`	Checks Household Biz Level Mission.
`CompleteRandomPreferenceMission`	`-`	`-`
`FindMissionConditionState`	InMissionId: `FB1MissionId`, InIndex: `integer`	`FB1MissionConditionState`	Finds and returns Mission Condition State.
`FindMissionState`	InMissionId: `FB1MissionId`	`FB1MissionState`	Finds and returns Mission State.
`GetCityMovePolicyMap`	InCityMoveDataPolicyType: `EB1CityMoveDataPolicyType`	`table<string, EB1CityMoveDataPolicy>`	Returns City Move Policy Map.
`GetCurrentMissionCountStr`	InMissionId: `FB1MissionId`	`string`	Returns the current mission count as a string (for use when there is no UI, or for logging).
`GetDefaultCityMoveDataPolicy`	`-`	`EB1CityMoveDataPolicy`	Returns Default City Move Data Policy.
`GetMissionMap`	`-`	`table<FB1MissionId, FB1MissionState>`	Returns Mission Map.
`InactivateMission`	InMissionId: `FB1MissionId`	`-`
`InactivateMissions`	InMissionIds: `FB1MissionId[]`	`-`
`InitWorldMission`	`-`	`-`	Initializes World Mission.
`IsFinishedMission`	InMissionId: `FB1MissionId`	`boolean`	Returns whether Finished Mission.
`OnAddActionTime`	InActionId: `string`, InAddTime: `integer`	`-`	Callback invoked on Add Action Time.
`OnAddBuff`	InBuffId: `string`	`-`	Callback invoked on Add Buff.
`OnAddEntityTag`	InEntityTag: `string`	`-`	Callback invoked on Add Entity Tag.
`OnAddFamilyTreeMember`	`-`	`-`	Callback invoked on Add Family Tree Member.
`OnAddMuscle`	CurrentMuscleValue: `integer`	`-`	Callback invoked on Add Muscle.
`OnAddRumorMonger`	`-`	`-`	Callback invoked on Add Rumor Monger.
`OnAddStat`	InStatId: `string`, InCurrentStatValue: `number`	`-`	Callback invoked on Add Stat.
`OnBookRead`	InBookId: `string`	`-`	Callback invoked on Book Read.
`OnBuyBusinessBiz`	`-`	`-`	Callback invoked on Buy Business Biz.
`OnBuyObject`	InObjectTags: `string[]`, InObjectFIlterCategory: `string`, Price: `integer`	`-`	Callback invoked on Buy Object.
`OnChangeCurrency`	InCurrencyId: `string`, InChangeAmount: `integer`, InCurrentAmount: `integer`	`-`	Callback invoked on Change Currency.
`OnChangeDepartment`	InDepartment: `FB1DepartmentKey`, bRankUp: `boolean`	`-`	Callback invoked on Change Department.
`OnChangeRelationshipCount`	InRelationshipId: `string`, InCount: `integer`	`-`	Callback invoked on Change Relationship Count.
`OnCompleteAmbitionMission`	InAmbitionId: `string`	`-`	Callback invoked on Complete Ambition Mission.
`OnCraftBestQuality`	InCraftingId: `string`, InQuality: `EB1Quality`	`-`	Crafting-quality mission trigger (CondId1=CraftingId, CondId2=Quality).
`OnDayChanged`	`-`	`-`	Callback invoked on Day Changed.
`OnEnteredSiteArea`	InSiteId: `string`	`-`	Callback invoked on Entered Site Area.
`OnFinishCoop`	CoopMembers: `FB1EntityId[]`, InCoopId: `string`, bIsSuccess: `boolean`	`-`	Callback invoked on Finish Coop.
`OnFinishInteractionBagTag`	InInteractionBagTag: `string`, InTargetEntityId: `FB1EntityId`	`-`	Callback invoked on Finish Interaction Bag Tag.
`OnFinishInteractionTag`	InInteractionTag: `string`, TargetEntityId: `FB1EntityId`	`-`	Callback invoked on Finish Interaction Tag.
`OnFinishSiteEvent`	InSiteEventId: `FB1SiteEventId`, InSiteEventResult: `EB1SiteEventResult`	`-`	Callback invoked on Finish Site Event.
`OnFoodEaten`	InObjectId: `string`	`-`	Called when eating food completes (EatFood mission condition).
`OnFreelanceDeliveryObjectDelivered`	`-`	`-`	Called when delivering a freelance delivery object completes (DeliverFreelanceDeliveryObject mission condition).
`OnFreelanceDeliveryObjectReceived`	`-`	`-`	Called when receiving a freelance delivery object completes (ReceiveFreelanceDeliveryObject mission condition).
`OnFreelanceOrderCraftingCompleted`	`-`	`-`	Called when a freelance order crafting completes (CompleteFreelanceOrderCrafting mission condition).
`OnHireEmployee`	`-`	`-`	Callback invoked on Hire Employee.
`OnHouseholdBizAddActivityToRole`	InRoleType: `string`, InInteractionCategoryId: `string`	`-`	Called when an activity is added per business role. InRoleType: Customer, Employee, Manager.
`OnHouseholdBizAddRecipe`	InRecipeId: `string`	`-`	Called when a recipe is added to a business.
`OnHouseholdBizChangeOperatingHours`	`-`	`-`	Called when a business's operating hours change.
`OnHouseholdBizLevelChanged`	InBizEntityId: `FB1EntityId`	`-`	Callback invoked on Household Biz Level Changed.
`OnHouseholdBizOperationDayChanged`	`-`	`-`	Called when a business's number of operating days changes.
`OnHouseholdBizRevenue`	InBizEntityId: `FB1EntityId`, InRevenue: `integer`	`-`	Callback invoked on Household Biz Revenue.
`OnHouseholdBizRoleInteractionTagFinished`	InRoleType: `string`, InInteractionBagTags: `string[]`	`-`	Called when a per-role business interaction is performed. InRoleType: Customer, Employee, Manager.
`OnHouseholdBizSetPaidAdmissionFee`	`-`	`-`	Called when a business's admission fee is set to paid.
`OnInTerritoryMinuteChanged`	InTerritoryTag: `string`	`-`	Callback invoked on In Territory Minute Changed.
`OnInteractionFinished`	InInteractionBagId: `string`, IsCanceled: `boolean`, InTargetEntityId: `FB1EntityId`	`-`	Callback invoked on Interaction Finished.
`OnJoinSiteEvent`	InSiteEvent: `FB2SiteEventBase`	`-`	Callback invoked on Join Site Event.
`OnLeavedSiteArea`	InSiteId: `string`	`-`	Callback invoked on Leaved Site Area.
`OnMarriage`	InOwnerEntity: `FB1EntityId`, InPartnerEntityId: `FB1EntityId`	`-`	Callback invoked on Marriage.
`OnMinuteChanged`	InPrevTime: `FDateTime`, InCurrentTime: `FDateTime`	`-`	Callback invoked on Minute Changed.
`OnRecipeCompleted`	InRecipeId: `string`	`-`	Called when a recipe is cooked/completed (CompleteRecipe mission condition).
`OnRegidanceSiteChanged`	InOldSiteId: `FB1EntityId`, InCurrentSiteId: `FB1EntityId`	`-`	Callback invoked on Regidance Site Changed.
`OnRegisterHouseholdBiz`	`-`	`-`	Callback invoked on Register Household Biz.
`OnRemoveBuff`	InBuffId: `string`	`-`	Callback invoked on Remove Buff.
`OnRemovedFamilyTreeMember`	`-`	`-`	Callback invoked on Removed Family Tree Member.
`OnSendMessageBySelf`	InMobileMessageSendDtId: `string`	`-`	Callback invoked on Send Message By Self.
`OnSkillLevelUp`	InSkillId: `string`, InSkillLevel: `integer`	`-`	Callback invoked on Skill Level Up.
`OnTakeASubway`	`-`	`-`	Callback invoked on Take ASubway.
`OnTeamProjectPointAdded`	InPoints: `integer`	`-`	Called when a team-project contribution point is added (TeamProjectContribution mission condition).
`OnUpdateRelationship`	InRelationshipId: `string`	`-`	Callback invoked on Update Relationship.
`ReactivateMission`	InMissionId: `FB1MissionId`	`-`
`RemoveMission`	InMissionId: `FB1MissionId`	`boolean`	Removes Mission.
`RemoveMissions`	InMissionIds: `FB1MissionId[]`	`-`	Removes Missions.
`RemoveWorldMission`	InMissionDtid: `string`	`boolean`	Removes World Mission.
`ShouldUseScheduler`	`-`	`boolean`	Returns whether it should Use Scheduler.

Override points (66)

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

Function	Parameters	Returns	Description
`Override_ActivateMission`	InMissionId: `FB1MissionId`	`-`
`Override_ActivateMissions`	InMissionIds: `FB1MissionId[]`	`-`
`Override_ApplyTrigger`	`-`	`-`	Applies Trigger.
`Override_CheckEmployeeCountMission`	`-`	`-`	Checks the employee-count mission (called on ambition change or business-owner change).
`Override_CheckHouseholdBizArrivedOperatingMission`	`-`	`-`	Checks whether the character arrived at a business location with a specific SiteTag during operating hours.
`Override_CheckHouseholdBizLevelMission`	`-`	`-`	Checks Household Biz Level Mission.
`Override_CompleteRandomPreferenceMission`	`-`	`-`
`Override_FindMissionConditionState`	InMissionId: `FB1MissionId`, InIndex: `integer`	`FB1MissionConditionState`	Finds and returns Mission Condition State.
`Override_FindMissionState`	InMissionId: `FB1MissionId`	`FB1MissionState`	Finds and returns Mission State.
`Override_InactivateMission`	InMissionId: `FB1MissionId`	`-`
`Override_InactivateMissions`	InMissionIds: `FB1MissionId[]`	`-`
`Override_InitWorldMission`	`-`	`-`	Initializes World Mission.
`Override_OnAddActionTime`	InActionId: `string`, InAddTime: `integer`	`-`	Callback invoked on Add Action Time.
`Override_OnAddBuff`	InBuffId: `string`	`-`	Callback invoked on Add Buff.
`Override_OnAddEntityTag`	InEntityTag: `string`	`-`	Callback invoked on Add Entity Tag.
`Override_OnAddFamilyTreeMember`	`-`	`-`	Callback invoked on Add Family Tree Member.
`Override_OnAddMuscle`	CurrentMuscleValue: `integer`	`-`	Callback invoked on Add Muscle.
`Override_OnAddRumorMonger`	`-`	`-`	Callback invoked on Add Rumor Monger.
`Override_OnAddStat`	InStatId: `string`, InCurrentStatValue: `number`	`-`	Callback invoked on Add Stat.
`Override_OnBookRead`	InBookId: `string`	`-`	Callback invoked on Book Read.
`Override_OnBuyBusinessBiz`	`-`	`-`	Callback invoked on Buy Business Biz.
`Override_OnBuyObject`	InObjectTags: `string[]`, InObjectFIlterCategory: `string`, Price: `integer`	`-`	Callback invoked on Buy Object.
`Override_OnChangeCurrency`	InCurrencyId: `string`, InChangeAmount: `integer`, InCurrentAmount: `integer`	`-`	Callback invoked on Change Currency.
`Override_OnChangeDepartment`	InDepartment: `FB1DepartmentKey`, bRankUp: `boolean`	`-`	Callback invoked on Change Department.
`Override_OnChangeRelationshipCount`	InRelationshipId: `string`, InCount: `integer`	`-`	Callback invoked on Change Relationship Count.
`Override_OnCompleteAmbitionMission`	InAmbitionId: `string`	`-`	Callback invoked on Complete Ambition Mission.
`Override_OnCraftBestQuality`	InCraftingId: `string`, InQuality: `EB1Quality`	`-`	Crafting-quality mission trigger (CondId1=CraftingId, CondId2=Quality).
`Override_OnDayChanged`	`-`	`-`	Callback invoked on Day Changed.
`Override_OnEnteredSiteArea`	InSiteId: `string`	`-`	Callback invoked on Entered Site Area.
`Override_OnFinishCoop`	CoopMembers: `FB1EntityId[]`, InCoopId: `string`, bIsSuccess: `boolean`	`-`	Callback invoked on Finish Coop.
`Override_OnFinishInteractionBagTag`	InInteractionBagTag: `string`, InTargetEntityId: `FB1EntityId`	`-`	Callback invoked on Finish Interaction Bag Tag.
`Override_OnFinishInteractionTag`	InInteractionTag: `string`, TargetEntityId: `FB1EntityId`	`-`	Callback invoked on Finish Interaction Tag.
`Override_OnFinishSiteEvent`	InSiteEventId: `FB1SiteEventId`, InSiteEventResult: `EB1SiteEventResult`	`-`	Callback invoked on Finish Site Event.
`Override_OnFoodEaten`	InObjectId: `string`	`-`	Called when eating food completes (EatFood mission condition).
`Override_OnFreelanceDeliveryObjectDelivered`	`-`	`-`	Called when delivering a freelance delivery object completes (DeliverFreelanceDeliveryObject mission condition).
`Override_OnFreelanceDeliveryObjectReceived`	`-`	`-`	Called when receiving a freelance delivery object completes (ReceiveFreelanceDeliveryObject mission condition).
`Override_OnFreelanceOrderCraftingCompleted`	`-`	`-`	Called when a freelance order crafting completes (CompleteFreelanceOrderCrafting mission condition).
`Override_OnHireEmployee`	`-`	`-`	Callback invoked on Hire Employee.
`Override_OnHouseholdBizAddActivityToRole`	InRoleType: `string`, InInteractionBagTag: `string`	`-`	Called when an activity is added per business role. InRoleType: Customer, Employee, Manager.
`Override_OnHouseholdBizAddRecipe`	InRecipeId: `string`	`-`	Called when a recipe is added to a business.
`Override_OnHouseholdBizChangeOperatingHours`	`-`	`-`	Called when a business's operating hours change.
`Override_OnHouseholdBizLevelChanged`	InBizEntityId: `FB1EntityId`	`-`	Callback invoked on Household Biz Level Changed.
`Override_OnHouseholdBizOperationDayChanged`	`-`	`-`	Called when a business's number of operating days changes.
`Override_OnHouseholdBizRevenue`	InBizEntityId: `FB1EntityId`, InRevenue: `integer`	`-`	Callback invoked on Household Biz Revenue.
`Override_OnHouseholdBizRoleInteractionTagFinished`	InRoleType: `string`, InInteractionBagTags: `string[]`	`-`	Called when a per-role business interaction is performed. InRoleType: Customer, Employee, Manager.
`Override_OnHouseholdBizSetPaidAdmissionFee`	`-`	`-`	Called when a business's admission fee is set to paid.
`Override_OnInTerritoryMinuteChanged`	InTerritoryTag: `string`	`-`	Callback invoked on In Territory Minute Changed.
`Override_OnInteractionFinished`	InInteractionBagId: `string`, IsCanceled: `boolean`, InTargetEntityId: `FB1EntityId`	`-`	Callback invoked on Interaction Finished.
`Override_OnJoinSiteEvent`	InSiteEvent: `FB2SiteEventBase`	`-`	Callback invoked on Join Site Event.
`Override_OnLeavedSiteArea`	InSiteId: `string`	`-`	Callback invoked on Leaved Site Area.
`Override_OnMarriage`	InOwnerEntity: `FB1EntityId`, InPartnerEntityId: `FB1EntityId`	`-`	Callback invoked on Marriage.
`Override_OnMinuteChanged`	InPrevTime: `FDateTime`, InCurrentTime: `FDateTime`	`-`	Callback invoked on Minute Changed.
`Override_OnRecipeCompleted`	InRecipeId: `string`	`-`	Called when a recipe is cooked/completed (CompleteRecipe mission condition).
`Override_OnRegidanceSiteChanged`	InOldSiteId: `FB1EntityId`, InCurrentSiteId: `FB1EntityId`	`-`	Callback invoked on Regidance Site Changed.
`Override_OnRegisterHouseholdBiz`	`-`	`-`	Callback invoked on Register Household Biz.
`Override_OnRemoveBuff`	InBuffId: `string`	`-`	Callback invoked on Remove Buff.
`Override_OnRemovedFamilyTreeMember`	`-`	`-`	Callback invoked on Removed Family Tree Member.
`Override_OnSendMessageBySelf`	InMobileMessageSendDtId: `string`	`-`	Callback invoked on Send Message By Self.
`Override_OnSkillLevelUp`	InSkillId: `string`, InSkillLevel: `integer`	`-`	Callback invoked on Skill Level Up.
`Override_OnTakeASubway`	`-`	`-`	Callback invoked on Take ASubway.
`Override_OnTeamProjectPointAdded`	InPoints: `integer`	`-`	Called when a team-project contribution point is added (TeamProjectContribution mission condition).
`Override_OnUpdateRelationship`	InRelationshipId: `string`	`-`	Callback invoked on Update Relationship.
`Override_ReactivateMission`	InMissionId: `FB1MissionId`	`-`
`Override_RemoveMission`	InMissionId: `FB1MissionId`	`boolean`	Removes Mission.
`Override_RemoveMissions`	InMissionIds: `FB1MissionId[]`	`-`	Removes Missions.
`Override_RemoveWorldMission`	InMissionDtid: `string`	`boolean`	Removes World Mission.