FB2DrivableVehicleComponent

Overview

Component that manages drivable-vehicle state.

Metadata

Field	Value
Kind	`component`
Environment	B2 - Simulation
Category	`components`
Extends	`FB2Component`
Require	`require('Components.B2DrivableVehicleComponent')`

Properties (7)

Name	Type	Description
`LastTowingCheckTime`	`integer`
`NumberOfPassengers`	`integer`
`PassengerMap`	`table<EB1VehicleSeat, FB1EntityId>`
`PendingExitPassengerIdList`	`FB1EntityId[]`
`SeatLocationCacheMap`	`table<EB1VehicleSeat, FVector>`
`SeatSocketSlotNameMap`	`table<EB1VehicleSeat, string>`
`UnseatedPassengerMap`	`table<FB1EntityId, FB1UnseatedPassengerData>`

Functions (32)

Function	Parameters	Returns	Description
`CanShift`	InPassenger: `FB2Character`, InTagetVehicleSeat: `EB1VehicleSeat`, InTargetObjectEntityId: `FB1EntityId`	`boolean`	Returns whether it can Shift.
`FindEmptyVehicleSeat`	`-`	`EB1VehicleSeat`	Finds and returns Empty Vehicle Seat.
`ForceRemoveVehicleSeat`	InEntityId: `FB1EntityId`	`-`
`GetAllPassengerId`	`-`	`FB1EntityId[]`	Returns All Passenger Id.
`GetDriverId`	`-`	`FB1EntityId`	Returns Driver Id.
`GetGameObjectId`	InPassengerId: `FB1EntityId`	`FB1EntityId`	Returns Game Object Id.
`GetIn`	InVehicleSeat: `EB1VehicleSeat`, InPassenger: `FB2Character`, InEntityId: `FB1EntityId`	`boolean`	Returns In.
`GetInDuringRestore`	InPassengerId: `FB1EntityId`	`boolean`	Returns In During Restore.
`GetInteractionSlotLocation`	InVehicleSeat: `EB1VehicleSeat`	`FVector`	Returns Interaction Slot Location.
`GetMaxSeatNum`	`-`	`integer`	Returns Max Seat Num.
`GetOccupyingEntity`	InObjectId: `FB1EntityId`	`FB1EntityId`	Returns Occupying Entity.
`GetOutAll`	`-`	`-`	Returns Out All.
`GetPassengerId`	InVehicleSeat: `EB1VehicleSeat`	`FB1EntityId`	Returns Passenger Id.
`GetPassengerMap`	`-`	`table<EB1VehicleSeat, FB1EntityId>`	Returns Passenger Map.
`GetRemainVehicleSeatCount`	`-`	`integer`	Returns Remain Vehicle Seat Count.
`GetSeatSlotLocation`	InVehicleSeat: `EB1VehicleSeat`, bLocalLocation: `boolean`	`FVector`	Returns Seat Slot Location.
`GetVehicleSeatByEntityId`	InEntityId: `FB1EntityId`	`EB1VehicleSeat`	Returns Vehicle Seat By Entity Id.
`IsAnyCharacterInVehicle`	`-`	`boolean`	Returns whether Any Character In Vehicle.
`IsPassengerEmpty`	`-`	`boolean`	Returns whether Passenger Empty.
`IsUnseatedPassengerEmpty`	`-`	`boolean`	Returns whether Unseated Passenger Empty.
`IsValidSeat`	InVehicleSeat: `EB1VehicleSeat`	`boolean`	Returns whether Valid Seat.
`IsWaitingForPassenger`	InVehicleSeat: `EB1VehicleSeat`, bIgnoreOwner: `boolean`	`boolean`	Returns whether Waiting For Passenger.
`IsWaitingForPassengerIgnoreOwner`	InVehicleSeat: `EB1VehicleSeat`	`boolean`	Returns whether Waiting For Passenger Ignore Owner.
`PostGetIn`	InVehicleSeat: `EB1VehicleSeat`, InPassenger: `FB2Character`, InEntityId: `FB1EntityId`, InSlotName: `string`	`boolean`
`PostGetOut`	InPassengerId: `FB1EntityId`, bSuccess: `boolean`	`-`
`PostShift`	InPassenger: `FB2Character`, InTagetVehicleSeat: `EB1VehicleSeat`, InTargetObjectEntityId: `FB1EntityId`	`EB2PassengerShiftResult`
`RecallOwnerlessVehicle`	`-`	`boolean`
`RecallVehicle`	InToastMessageId: `string`	`-`
`RefreshMovableFlag`	`-`	`-`
`RefreshTowingCheckTime`	`-`	`-`
`RequestExitForAllPassengers`	InDriver: `FB2Character`	`-`	Requests Exit For All Passengers.
`Shift`	InPassenger: `FB2Character`, InTagetVehicleSeat: `EB1VehicleSeat`, InTargetObjectEntityId: `FB1EntityId`, InSlotName: `string`	`EB2PassengerShiftResult`

Override points (12)

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

Function	Parameters	Returns	Description
`Override_CanShift`	InPassenger: `FB2Character`, InTagetVehicleSeat: `EB1VehicleSeat`, InTargetObjectEntityId: `FB1EntityId`	`boolean`	Returns whether it can Shift.
`Override_FindEmptyVehicleSeat`	`-`	`EB1VehicleSeat`	Finds and returns Empty Vehicle Seat.
`Override_ForceRemoveVehicleSeat`	InEntityId: `FB1EntityId`	`-`
`Override_PostGetIn`	InVehicleSeat: `EB1VehicleSeat`, InPassenger: `FB2Character`, InEntityId: `FB1EntityId`, InSlotName: `string`	`boolean`
`Override_PostGetOut`	InPassengerId: `FB1EntityId`, bSuccess: `boolean`	`-`
`Override_PostShift`	InPassenger: `FB2Character`, InTagetVehicleSeat: `EB1VehicleSeat`, InTargetObjectEntityId: `FB1EntityId`	`EB2PassengerShiftResult`
`Override_RecallOwnerlessVehicle`	`-`	`boolean`
`Override_RecallVehicle`	InToastMessageId: `string`	`-`
`Override_RefreshMovableFlag`	`-`	`-`
`Override_RefreshTowingCheckTime`	`-`	`-`
`Override_RequestExitForAllPassengers`	InDriver: `FB2Character`	`-`	Requests Exit For All Passengers.
`Override_Shift`	InPassenger: `FB2Character`, InTagetVehicleSeat: `EB1VehicleSeat`, InTargetObjectEntityId: `FB1EntityId`, InSlotName: `string`	`EB2PassengerShiftResult`