Skip to main content

FB2Ship

Overview

No description available.

Metadata

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

Properties (2)

Name	Type	Description
`DistFromDriverSqr`	`number`
`RelativeDisembarkLocations`	`FVector[]`

Functions (13)

Function	Parameters	Returns	Description
`CanAddInteractionWhenPicked`	`-`	`boolean`	Returns whether it can Add Interaction When Picked.
`CanAutonomy`	InEntityId: `FB1EntityId`	`boolean`	Returns whether it can Autonomy.
`ForcedPassengersExit`	`-`	`-`
`GetIsAnchorDown`	`-`	`boolean`	Returns Is Anchor Down.
`GetOutAllPassengersForShipwreck`	InDisasterId: `string`	`-`	Returns Out All Passengers For Shipwreck.
`GetVehicleType`	`-`	`EB1VehicleType`	Returns Vehicle Type.
`IsDocked`	`-`	`boolean`	Returns whether Docked.
`OnSpawnedChildObject`	InChildObject: `FB2GameObject`	`-`	Callback invoked on Spawned Child Object.
`ProcessRidingEntityDeath`	InRidingEntityId: `FB1EntityId`	`-`
`SetDocked`	InDocked: `boolean`	`-`	Sets Docked.
`SetIsAnchorDown`	InIsAnchorDown: `boolean`	`-`	Sets Is Anchor Down.
`SetOwnerEntityId`	InOwnerId: `FB1EntityId`	`-`	Sets Owner Entity Id.
`TryDisembarkingVehicle`	InEntityId: `FB1EntityId`, bClearCharacterState: `boolean`	`boolean`

Override points (4)

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

Function	Parameters	Returns	Description
`Override_ForcedPassengersExit`	`-`	`-`
`Override_GetOutAllPassengersForShipwreck`	InDisasterId: `string`	`-`	Returns Out All Passengers For Shipwreck.
`Override_ProcessRidingEntityDeath`	InRidingEntityId: `FB1EntityId`	`-`
`Override_TryDisembarkingVehicle`	InEntityId: `FB1EntityId`, bClearCharacterState: `boolean`	`boolean`