FB2FreelanceManager

Overview

Manages freelance orders/activity.

Metadata

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

Properties (17)

Name	Type	Description
`ActiveDecisionFlowInstanceId`	`FB1FreelanceOrderInstanceId`
`AvailableOrderTemplateIds`	`string[]`
`ContractIdGenerator`	`any`
`FreelanceClientToInstanceMap`	`table<FB1EntityId, FB1FreelanceOrderInstanceId>`
`FreelanceMissionSiteEntityIds`	`FB1EntityId[]`	List of SiteEntityIds currently showing a delivery-mission marker.
`InstanceIdGenerator`	`any`
`MissionTargetFxEntityId`	`FB1EntityId`	EntityId of the character currently showing the mission-target NPC FX.
`NextSummaryId`	`integer`
`OrderInstanceMap`	`table<FB1FreelanceOrderInstanceId, FB2FreelanceOrderInstance>`
`OrderSummaryMap`	`table<integer, FB1FreelanceOrderSummary>`
`PenaltyFlowMap`	`table<FB1EntityId, FB1FreelancePenaltyFlowState>`
`PendingFinishOrderInstanceIds`	`FB1FreelanceOrderInstanceId[]`
`RefreshOrdersTaskId`	`FB1TimeTaskId`
`SummaryEntityToSummaryIdMap`	`table<FB1EntityId, integer>`	Reverse lookup of OrderSummaryMap: NPC EntityId -> SummaryId (for O(1) Delivery Summary lookup).
`ZoiToInstanceMap`	`table<FB1EntityId, FB1FreelanceOrderInstanceId>`
`bFreelanceInitialized`	`boolean`
`bOrderGenerationInProgress`	`boolean`

Functions (31)

Function	Parameters	Returns	Description
`AcceptOrder`	InEntityId: `FB1EntityId`, InSummaryId: `integer`, OutInstanceId: `FB1FreelanceOrderInstanceId`, OutFailReason: `EB1FreelanceOrderAcceptFailReason`	`boolean`
`CheckAndRefreshOrders`	`-`	`-`	Checks And Refresh Orders.
`DeliverCraftObject`	InEntityId: `FB1EntityId`, InCraftObjectEntityId: `FB1EntityId`	`boolean`	Delivers a CraftObject: verifies the active order, completes the quest, removes it from inventory, and destroys the CraftObject.
`FindFreelanceClientInfo`	InEntityId: `FB1EntityId`	`FB1FreelanceClient`	Finds and returns Freelance Client Info.
`FindPenaltyFlowState`	InEntityId: `FB1EntityId`	`FB1FreelancePenaltyFlowState`	Finds and returns Penalty Flow State.
`GenerateRoyaltyContractId`	`-`	`FB1RoyaltyContractId`	Issues a Royalty ContractId (called from CareerComponent).
`GetActiveOrderInstance`	InEntityId: `FB1EntityId`	`FB2FreelanceOrderInstance`	Returns Active Order Instance.
`GetActiveOrderInstanceId`	InEntityId: `FB1EntityId`	`FB1FreelanceOrderInstanceId`	Returns Active Order Instance Id.
`GetAvailableTemplateIds`	`-`	`string[]`	Returns Available Template Ids.
`GetOrderInstance`	InInstanceId: `FB1FreelanceOrderInstanceId`	`FB2FreelanceOrderInstance`	Returns Order Instance.
`GetOrderSummaryMap`	`-`	`table<integer, FB1FreelanceOrderSummary>`	Returns Order Summary Map.
`HasActivePenaltyFlow`	InEntityId: `FB1EntityId`	`boolean`	Returns whether it has Active Penalty Flow.
`IsPlayingFreelanceOrder`	InEntityId: `FB1EntityId`	`boolean`	Returns whether Playing Freelance Order.
`MergeGeneratedOrders`	InSummaries: `FB1FreelanceOrderSummary[]`	`-`
`OnChangePossessEntityId`	InPrevEntityId: `FB1EntityId`, InNewEntityId: `FB1EntityId`	`-`	Callback invoked on Change Possess Entity Id.
`OnCharacterJoinedSiteEvent`	InEntityId: `FB1EntityId`, InEventTimeRange: `FB1SiteEventTimeRange`	`-`	Callback invoked on Character Joined Site Event.
`OnDeathCharacter`	InEntityId: `FB1EntityId`	`-`	Client/recipient exception handling: removes the OrderSummary on death.
`OnOrderExpired`	InInstanceId: `FB1FreelanceOrderInstanceId`	`-`	Callback invoked on Order Expired.
`OnPenaltyPaid`	InEntityId: `FB1EntityId`	`-`	Callback invoked on Penalty Paid.
`OnPenaltyTimerTriggered`	InEntityId: `FB1EntityId`	`-`	Callback invoked on Penalty Timer Triggered.
`OnQuestCompleted`	InEntityId: `FB1EntityId`, InQuestId: `string`, bInSuccess: `boolean`	`-`	Callback invoked on Quest Completed.
`OnQuestMissionStarted`	InEntityId: `FB1EntityId`, InQuestId: `string`, InMissionDtId: `string`	`-`	Callback invoked on Quest Mission Started.
`OnScheduleRegenerated`	InEntityId: `FB1EntityId`	`-`	On schedule regeneration, checks Delivery Summary time overlaps and removes conflicting Summaries.
`ResendMissionTargetFxIfNeeded`	InEntityId: `FB1EntityId`	`-`	Re-sends the mission target FX when mesh spawning completes.
`SendOrderSummaryList`	`-`	`-`	Sends Order Summary List.
`StaticIsPlayingDeliveryOrder` (static)	InEntityId: `FB1EntityId`	`boolean`
`TriggerDecisionMobileCall`	InInstanceId: `FB1FreelanceOrderInstanceId`	`-`
`TryCancelFreelanceOrderByEntityId`	InEntityId: `FB1EntityId`	`boolean`
`TryCancelFreelanceOrderByInstanceId`	InOrderInstanceId: `FB1FreelanceOrderInstanceId`	`boolean`
`TryStartDecisionFlow`	InInstanceId: `FB1FreelanceOrderInstanceId`	`boolean`
`ValidateAcceptOrder`	InEntityId: `FB1EntityId`, InSummaryId: `integer`	`EB1FreelanceOrderAcceptFailReason`

Override points (21)

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

Function	Parameters	Returns	Description
`Override_CheckAndRefreshOrders`	`-`	`-`	Checks And Refresh Orders.
`Override_DeliverCraftObject`	InEntityId: `FB1EntityId`, InCraftObjectEntityId: `FB1EntityId`	`boolean`	Delivers a CraftObject: verifies the active order, completes the quest, removes it from inventory, and destroys the CraftObject.
`Override_FindFreelanceClientInfo`	InEntityId: `FB1EntityId`	`FB1FreelanceClient`	Finds and returns Freelance Client Info.
`Override_FindPenaltyFlowState`	InEntityId: `FB1EntityId`	`FB1FreelancePenaltyFlowState`	Finds and returns Penalty Flow State.
`Override_GenerateRoyaltyContractId`	`-`	`FB1RoyaltyContractId`	Issues a Royalty ContractId (called from CareerComponent).
`Override_HasActivePenaltyFlow`	InEntityId: `FB1EntityId`	`boolean`	Returns whether it has Active Penalty Flow.
`Override_MergeGeneratedOrders`	InSummaries: `FB1FreelanceOrderSummary[]`	`-`
`Override_OnChangePossessEntityId`	InPrevEntityId: `FB1EntityId`, InNewEntityId: `FB1EntityId`	`-`	Callback invoked on Change Possess Entity Id.
`Override_OnCharacterJoinedSiteEvent`	InEntityId: `FB1EntityId`, InEventTimeRange: `FB1SiteEventTimeRange`	`-`	Callback invoked on Character Joined Site Event.
`Override_OnDeathCharacter`	InEntityId: `FB1EntityId`	`-`	Client/recipient exception handling: removes the OrderSummary on death.
`Override_OnOrderExpired`	InInstanceId: `FB1FreelanceOrderInstanceId`	`-`	Callback invoked on Order Expired.
`Override_OnPenaltyPaid`	InEntityId: `FB1EntityId`	`-`	Callback invoked on Penalty Paid.
`Override_OnPenaltyTimerTriggered`	InEntityId: `FB1EntityId`	`-`	Callback invoked on Penalty Timer Triggered.
`Override_OnQuestCompleted`	InEntityId: `FB1EntityId`, InQuestId: `string`, bInSuccess: `boolean`	`-`	Callback invoked on Quest Completed.
`Override_OnQuestMissionStarted`	InEntityId: `FB1EntityId`, InQuestId: `string`, InMissionDtId: `string`	`-`	Callback invoked on Quest Mission Started.
`Override_OnScheduleRegenerated`	InEntityId: `FB1EntityId`	`-`	On schedule regeneration, checks Delivery Summary time overlaps and removes conflicting Summaries.
`Override_ResendMissionTargetFxIfNeeded`	InEntityId: `FB1EntityId`	`-`	Re-sends the mission target FX when mesh spawning completes.
`Override_SendOrderSummaryList`	`-`	`-`	Sends Order Summary List.
`Override_TriggerDecisionMobileCall`	InInstanceId: `FB1FreelanceOrderInstanceId`	`-`
`Override_TryStartDecisionFlow`	InInstanceId: `FB1FreelanceOrderInstanceId`	`boolean`
`Override_ValidateAcceptOrder`	InEntityId: `FB1EntityId`, InSummaryId: `integer`	`EB1FreelanceOrderAcceptFailReason`