Skip to main content

FB2GiftManager

Overview

Manages gifts.

Metadata

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

Properties (3)

Name	Type	Description
`GiftBoxSpawnPointIndexMap`	`table<FB1EntityId, integer>`
`GiftDataMap`	`table<FB1EntityId, FB1RelationshipGiftData>`
`GiftOwnerMap`	`table<FB1EntityId, FB1EntityIdArray>`

Functions (8)

Function	Parameters	Returns	Description
`FindGiftData`	InGiftEntityId: `FB1EntityId`	`FB1RelationshipGiftData`	Finds and returns Gift Data.
`FindOwnedGifts`	InOwnerEntityId: `FB1EntityId`	`FB1EntityIdArray`	Finds and returns Owned Gifts.
`RemoveAllGiftBox`	InGiftOwnerId: `FB1EntityId`	`-`	Removes All Gift Box.
`RemoveGiftBoxByGiftEntity`	InGiftBoxEntityId: `FB1EntityId`	`-`	Removes Gift Box By Gift Entity.
`RemoveGiftBoxByOwnerPair`	InFromEntityId: `FB1EntityId`, InToEntityId: `FB1EntityId`	`-`	Removes Gift Box By Owner Pair.
`SendGiftBox`	InSiteEntityId: `FB1EntityId`, InGiftBoxObjectId: `string`, InObjectId: `string`, CarriableObjectType: `EB1CarriableObjectType`, InObjectCount: `integer`, InOwnerEntityId: `FB1EntityId`	`boolean`	Sends Gift Box.
`SendRelationshipGiftBoxByEntity`	InFromEntityId: `FB1EntityId`, InToEntityId: `FB1EntityId`, InGiftDtId: `string`	`-`	Sends Relationship Gift Box By Entity.
`SendRelationshipGiftBoxBySystem`	InFromSystemId: `string`, InToEntityId: `FB1EntityId`, InGiftDtId: `string`	`-`	Sends Relationship Gift Box By System.

Override points (4)

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

Function	Parameters	Returns	Description
`Override_FindGiftData`	InGiftEntityId: `FB1EntityId`	`FB1RelationshipGiftData`	Finds and returns Gift Data.
`Override_FindOwnedGifts`	InOwnerEntityId: `FB1EntityId`	`FB1EntityIdArray`	Finds and returns Owned Gifts.
`Override_RemoveAllGiftBox`	InGiftOwnerId: `FB1EntityId`	`-`	Removes All Gift Box.
`Override_SendGiftBox`	InSiteEntityId: `FB1EntityId`, InGiftBoxObjectId: `string`, InObjectId: `string`, CarriableObjectType: `EB1CarriableObjectType`, InObjectCount: `integer`, InOwnerEntityId: `FB1EntityId`	`boolean`	Sends Gift Box.