FB2CarriableObject

Overview

No description available.

Metadata

Field	Value
Kind	`struct`
Environment	B2 - Simulation
Category	`structs`
Extends	`FB2GameObject`
Require	`require('Objects.B2CarriableObject')`

Properties (8)

Name	Type	Description
`BargainHistory`	`table<FB1EntityId, FDateTime>`	Object bargaining history.
`CarriableObjectId`	`string`
`CarriableObjectType`	`EB1CarriableObjectType`
`InteractionOwnerEntityId`	`FB1EntityId`
`PendingFloorLocation`	`FVector`	Location where it will be placed when the put-down-on-floor executes.
`PendingFloorRotation`	`FRotator`	Rotation at which it will be placed when the put-down-on-floor executes.
`bPendingPutDown`	`boolean`	Flag indicating a put-down is scheduled.
`bPutDownOnFloor`	`boolean`

Functions (20)

Function	Parameters	Returns	Description
`GetCarriableObjectId`	`-`	`string`	Returns Carriable Object Id.
`GetCarriableObjectType`	`-`	`EB1CarriableObjectType`	Returns Carriable Object Type.
`GetInteractionOwnerEntityId`	`-`	`FB1EntityId`	Returns Interaction Owner Entity Id.
`GetInteractionTags`	`-`	`string[]`	Returns Interaction Tags.
`GetLocatedSiteId`	`-`	`FB1EntityId`	Returns Located Site Id.
`GetPendingFloorLocation`	`-`	`FVector`	Returns Pending Floor Location.
`GetPendingFloorRotation`	`-`	`FRotator`	Returns Pending Floor Rotation.
`GetPendingPutDown`	`-`	`boolean`	Returns Pending Put Down.
`GetPutDownOnFloor`	`-`	`boolean`	Returns Put Down On Floor.
`GetSalePrice`	InTargetId: `FB1EntityId`	`integer`	Returns Sale Price.
`HasBargainCoolTime`	InCharacterId: `FB1EntityId`	`boolean`	Returns whether it has Bargain Cool Time.
`IsAccessApproved`	InInteracter: `FB1EntityId`	`boolean`	Returns whether Access Approved.
`IsCleanUpTarget`	InCleanUpTarget: `EB1CleanUpObjectType`	`boolean`	Returns whether Clean Up Target.
`SetInteractionOwnerEntityId`	InOwnerEntity: `FB1EntityId`	`-`	Sets Interaction Owner Entity Id.
`SetPendingFloorLocation`	InFloorLocation: `FVector`	`-`	Sets Pending Floor Location.
`SetPendingFloorRotation`	InFloorRotation: `FRotator`	`-`	Sets Pending Floor Rotation.
`SetPendingPutDown`	InPendingPutDown: `boolean`	`-`	Sets Pending Put Down.
`SetPutDownOnFloor`	InPutDownOnFloor: `boolean`	`-`	Sets Put Down On Floor.
`ShouldDestroyOnDetach`	`-`	`boolean`	Returns whether it should Destroy On Detach.
`UpdateBargainHistory`	InCharacterId: `FB1EntityId`	`-`	Updates Bargain History.

Override points (1)

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

Function	Parameters	Returns	Description
`Override_UpdateBargainHistory`	InCharacterId: `FB1EntityId`	`-`	Updates Bargain History.