Skip to main content

FB2QuestComponent

Overview

  • Component that manages quests.

Metadata

FieldValue
Kindcomponent
EnvironmentB2 - Simulation
Categorycomponents
ExtendsFB2Component
Requirerequire('Components.B2QuestComponent')

Properties (6)

NameTypeDescription
ExecutingQuestMaptable<string, FB1ExecuteQuest>
PendingRemoveHistoryDataListFB1RemoveQuest[]
PendingSequentialQuestMaptable<string, FB2ReserveQuestList>
PendingUpdateHistoryDataListFB1UpdateQuest[]
ReserveQuestHeapFB1ReserveQuest[]
TodayQuestHistoryDatatable<string, FB1QuestHistoryData>

Functions (18)

FunctionParametersReturnsDescription
AddQuestInQuestId: string, InMissionType: EB1MissionType, InMissionParam: string-Adds Quest.
AddQuestForCheatInQuestId: string, InMissionDtId: string-If a MissionDtId is also passed, unconditionally adds the mission with that MissionDtId under the given QuestId (excluded from random selection).
ClearQuestsForCityMoveTravelInRemoveTargetTypes: EB1MissionType[], InCityMoveDataPolicyType: EB1CityMoveDataPolicyType-Clears Quests For City Move Travel.
GetDefaultCityMoveDataPolicy-EB1CityMoveDataPolicyReturns Default City Move Data Policy.
GetReserveQuestHeap-FB1ReserveQuest[]Returns Reserve Quest Heap.
HasActiveQuestHistoryInQuestId: stringbooleanReturns whether it has Active Quest History.
HasQuestInQuestId: string, InMissionDtId: stringbooleanReturns whether it has Quest.
IsProgressQuest-booleanReturns whether Progress Quest.
IsRemainQuestHistory-booleanReturns whether Remain Quest History.
OnChangePossess--Callback invoked on Change Possess.
OnEnterSite--Callback invoked on Enter Site.
OnFinishMissionInCurrentMissionType: EB1MissionType, InMissionId: string, bIsSuccess: boolean-Callback invoked on Finish Mission.
OnMinuteChangedInPrevTime: FDateTime, InCurrentTime: FDateTime-Callback invoked on Minute Changed.
RemoveQuestInQuestId: string, bRemoveElementToFail: boolean-bRemoveElementToFail decides, when removing a mission, whether to just delete it or mark it failed.
RequestRemoveQuestsByCategoryInQuestCategoryId: string-Bulk-removes in-progress (ExecutingQuestMap) quests whose QuestCategoryId matches. Used for category-level cleanup such as school dropout/graduation/expulsion/transfer.
RequestRemoveSpecificQuestsQuestIdPrefix: string-Requests Remove Specific Quests.
RequestSubmitQuestInQuestId: stringbooleanRequests Submit Quest.
TriggerImmediateQuestRefresh--Immediately refreshes the quest UI on returning from a city move (same as the show path in OnMinuteChanged).

Override points (13)

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

FunctionParametersReturnsDescription
Override_AddQuestInQuestId: string, InMissionType: EB1MissionType, InMissionParam: string-Adds Quest.
Override_AddQuestForCheatInQuestId: string, InMissionDtId: string-If a MissionDtId is also passed, unconditionally adds the mission with that MissionDtId under the given QuestId (excluded from random selection).
Override_ClearQuestsForCityMoveTravelInRemoveTargetTypes: EB1MissionType[], InCityMoveDataPolicyType: EB1CityMoveDataPolicyType-Clears Quests For City Move Travel.
Override_HasActiveQuestHistoryInQuestId: stringbooleanReturns whether it has Active Quest History.
Override_HasQuestInQuestId: string, InMissionDtId: stringbooleanReturns whether it has Quest.
Override_OnChangePossess--Callback invoked on Change Possess.
Override_OnEnterSite--Callback invoked on Enter Site.
Override_OnFinishMissionInCurrentMissionType: EB1MissionType, InMissionId: string, bIsSuccess: boolean-Callback invoked on Finish Mission.
Override_OnMinuteChangedInPrevTime: FDateTime, InCurrentTime: FDateTime-Callback invoked on Minute Changed.
Override_RemoveQuestInQuestId: string, bRemoveElementToFail: boolean-bRemoveElementToFail decides, when removing a mission, whether to just delete it or mark it failed.
Override_RequestRemoveSpecificQuestsQuestIdPrefix: string-Requests Remove Specific Quests.
Override_RequestSubmitQuestInQuestId: stringbooleanRequests Submit Quest.
Override_TriggerImmediateQuestRefresh--Immediately refreshes the quest UI on returning from a city move (same as the show path in OnMinuteChanged).