FB2Vehicle

Overview

No description available.

Metadata

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

Properties (50)

Name	Type	Description
`AccidentCount`	`integer`
`AccidentTargetId`	`FB1EntityId`
`AccidentTimeTaskId`	`FB1TimeTaskId`
`AccidentTriggerDriverId`	`FB1EntityId`
`ColorId`	`string`
`ColorLookUp`	`number`
`ControlSubject`	`EB1VehicleControlSubject`
`CrashMassLevel`	`integer`
`DespawnHoldTime`	`number`
`DespawnSpeed`	`number`
`Destination`	`FVector4`
`DetectedEntities`	`any[]`	UPROPERTY(Transient)
`HoldSeconds`	`number`
`HorizontalOffset`	`number`
`InputValue`	`number`
`LaneAdvancedDistance`	`number`
`LaneChangeDescription`	`FB2VehicleLaneChangeDescription`
`LaneIndex`	`integer`
`LaneUID`	`string`
`LightFlag`	`integer`
`MaximumSpawnRangeSquared`	`number`
`NearbyVehicles`	`any[]`	transient data below. UPROPERTY(Transient)
`NextLaneIndex`	`integer`
`NextLaneUID`	`string`
`NextRoadIndex`	`integer`
`NextRoadUID`	`string`
`OwnerContext`	`FB1VehicleOwnerContext`
`OwnerlessVehicleActorGuid`	`string`
`OwnerlessVehicleOriginalTransform`	`FTransform`
`PartsState`	`table<EB1VehiclePartType, string>`
`Policy`	`EB1VehiclePolicy`
`PreviousLaneIndex`	`integer`	indexes
`PreviousLaneUID`	`string`	uid's
`RandomFraction`	`number`
`RepresentationType`	`EB1VehicleRepresentationType`
`RoadIndex`	`integer`
`RoadUID`	`string`
`SimulationDriverId`	`FB1EntityId`
`SimulationDriverMeshId`	`string`
`Speed`	`number`
`SpeedRate`	`number`
`SteeringAngle`	`number`
`VehicleAssetDescription`	`FB1VehicleAssetDescription`
`VehicleDtId`	`string`
`VehicleObjects`	`FB2AttachedVehicleObject[]`	Objects added on top of the vehicle. Attached in B1.
`Velocity`	`FVector`
`bIsAccidentUIPlaying`	`boolean`
`bPendingDestory`	`boolean`
`bPendingLaneChange`	`boolean`
`bTargetOfDestruction`	`boolean`

Functions (136)

Function	Parameters	Returns	Description
`BindPostVehicleAccident`	InDriverId: `FB1EntityId`, InAccidentTargetVehicleId: `FB1EntityId`	`-`
`CanAddInteractionWhenPicked`	`-`	`boolean`	Returns whether it can Add Interaction When Picked.
`CanAutonomy`	InEntityId: `FB1EntityId`	`boolean`	Returns whether it can Autonomy.
`ClearVehicleState`	`-`	`-`	Clears Vehicle State.
`CreateVehicleObjects`	`-`	`-`	Creates Vehicle Objects.
`FindSeatEntityId`	InVehicleSeat: `EB1VehicleSeat`	`FB1EntityId`	Finds and returns Seat Entity Id.
`ForcedPassengersExit`	`-`	`-`
`GetAcceleration`	`-`	`number`	Returns Acceleration.
`GetAccelerationRandomMultiplier`	`-`	`number`	Returns Acceleration Random Multiplier.
`GetAttachedObjectIdByTag`	InTag: `string`	`FB1EntityId`	Returns Attached Object Id By Tag.
`GetBoundsExtent`	`-`	`FVector`	Returns Bounds Extent.
`GetBrakingDistance`	`-`	`number`	Returns Braking Distance.
`GetBrakingDistanceByCurrentSpeed`	`-`	`number`	Returns Braking Distance By Current Speed.
`GetColorId`	`-`	`string`	Returns Color Id.
`GetColorLookUp`	`-`	`number`	Returns Color Look Up.
`GetControlSubject`	`-`	`EB1VehicleControlSubject`	Returns Control Subject.
`GetCrashMassLevel`	`-`	`integer`	Returns Crash Mass Level.
`GetCrosswalkRoadIndex`	`-`	`integer`	Returns Crosswalk Road Index.
`GetDeceleration`	`-`	`number`	Returns Deceleration.
`GetDecelerationRandomMultiplier`	`-`	`number`	Returns Deceleration Random Multiplier.
`GetDestination`	`-`	`FVector4`	Returns Destination.
`GetDriverId`	`-`	`FB1EntityId`	Returns Driver Id.
`GetDynamicData`	`-`	`FB1VehicleDynamicData`	Returns Dynamic Data.
`GetEmptySeatObjectIds`	`-`	`FB1EntityId[]`	Returns Empty Seat Object Ids.
`GetFieldOfView`	`-`	`number`	Returns Field Of View.
`GetFrontAxle`	`-`	`number`	Returns Front Axle.
`GetHalfHeight`	`-`	`number`	Returns Half Height.
`GetHalfLength`	`-`	`number`	Returns Half Length.
`GetHalfWidth`	`-`	`number`	Returns Half Width.
`GetHeight`	`-`	`number`	Returns Height.
`GetHorizontalOffset`	`-`	`number`	Returns Horizontal Offset.
`GetInfluenceLength`	`-`	`number`	Returns Influence Length.
`GetInputValue`	`-`	`number`	Returns Input Value.
`GetLaneAdvancedDistance`	`-`	`number`	Returns Lane Advanced Distance.
`GetLaneEndPoint`	`-`	`FB1CityGraphLanePoint`	Returns Lane End Point.
`GetLaneIndex`	`-`	`integer`	Returns Lane Index.
`GetLaneRemainingDistance`	`-`	`number`	Returns Lane Remaining Distance.
`GetLength`	`-`	`number`	Returns Length.
`GetMainTarget`	`-`	`FB1EntityId`	Returns Main Target.
`GetMaximumSpeed`	`-`	`number`	Returns Maximum Speed.
`GetNextLaneIndex`	`-`	`integer`	Returns Next Lane Index.
`GetNextRoadIndex`	`-`	`integer`	Returns Next Road Index.
`GetOwnerContext`	`-`	`FB1VehicleOwnerContext`	Returns Owner Context.
`GetOwnerEntityId`	`-`	`FB1EntityId`	Returns Owner Entity Id.
`GetOwnerlessVehicleGuid`	`-`	`string`	Returns Ownerless Vehicle Guid.
`GetOwnerlessVehicleOriginalTransform`	`-`	`FTransform`	Returns Ownerless Vehicle Original Transform.
`GetPath`	`-`	`FB1CityGraphPath`	Returns Path.
`GetPerceptionDistance`	`-`	`number`	Returns Perception Distance.
`GetPolicy`	`-`	`EB1VehiclePolicy`	Returns Policy.
`GetPreviousLaneIndex`	`-`	`integer`	Returns Previous Lane Index.
`GetReactionDistance`	InVehicle: `FB2Vehicle`	`number`	Returns Reaction Distance.
`GetRearAxle`	`-`	`number`	Returns Rear Axle.
`GetRelativeLocation`	InVehicle: `FB2Vehicle`	`FVector`	Returns Relative Location.
`GetRepresentationType`	`-`	`EB1VehicleRepresentationType`	Returns Representation Type.
`GetRoadIndex`	`-`	`integer`	Returns Road Index.
`GetSimulationDriverId`	`-`	`FB1EntityId`	Returns Simulation Driver Id.
`GetSimulationDriverMeshId`	`-`	`string`	Returns Simulation Driver Mesh Id.
`GetSpaceCushion`	`-`	`number`	Returns Space Cushion.
`GetSpeed`	`-`	`number`	Returns Speed.
`GetSpeedRate`	`-`	`number`	Returns Speed Rate.
`GetSteeringAngle`	`-`	`number`	Returns Steering Angle.
`GetStopLineDisregardDistance`	`-`	`number`	Returns Stop Line Disregard Distance.
`GetStopLineMaintainDistance`	`-`	`number`	Returns Stop Line Maintain Distance.
`GetStopPosition`	`-`	`number`	Returns Stop Position.
`GetTransform`	`-`	`FTransform`	Returns Transform.
`GetType`	`-`	`EB2EntityType`	Vehicle Interface
`GetUnseatableObjectIds`	`-`	`FB1EntityId[]`	Returns Unseatable Object Ids.
`GetVehicleDtId`	`-`	`string`	Returns Vehicle Dt Id.
`GetVehicleSeatByObjectEntityId`	InEntityId: `FB1EntityId`	`EB1VehicleSeat`	Returns Vehicle Seat By Object Entity Id.
`GetVehicleType`	`-`	`EB1VehicleType`	Returns Vehicle Type.
`GetVelocity`	`-`	`FVector`	Returns Velocity.
`GetWidth`	`-`	`number`	Returns Width.
`HasPassengerInVehicle`	`-`	`boolean`	Returns whether it has Passenger In Vehicle.
`IsAccidentUIPlaying`	`-`	`boolean`	Returns whether Accident UIPlaying.
`IsBoundPostVehicleAccidentFunc`	`-`	`boolean`	Returns whether Bound Post Vehicle Accident Func.
`IsLaneChanging`	`-`	`boolean`	Returns whether Lane Changing.
`IsLightsOn`	InVehicleLight: `EB1VehicleLight`	`boolean`	Returns whether Lights On.
`IsNeedSpawnUpdate`	`-`	`boolean`	Returns whether Need Spawn Update.
`IsOnCrosswalk`	`-`	`boolean`	Returns whether On Crosswalk.
`IsParked`	`-`	`boolean`	Returns whether Parked.
`IsParkedOnPrivate`	`-`	`boolean`	Returns whether Parked On Private.
`IsParkedOnUnauthorizedPrivate`	`-`	`boolean`	Returns whether Parked On Unauthorized Private.
`IsPendingLaneChange`	`-`	`boolean`	Returns whether Pending Lane Change.
`IsPlayerCharacterOwned`	`-`	`boolean`	Returns whether Player Character Owned.
`IsRestoreValid`	`-`	`boolean`	Returns whether Restore Valid.
`NeedToTurnOnHeadLights`	`-`	`boolean`
`OccupyOwnerlessVehicleSiteGrid`	`-`	`-`
`OnBeginOverlap`	OtherEntityId: `FB1EntityId`	`-`	Callback invoked on Begin Overlap.
`OnEnterLane`	InLaneIndex: `integer`	`-`	Callback invoked on Enter Lane.
`OnExitLane`	InLaneIndex: `integer`	`-`	Callback invoked on Exit Lane.
`OnSpawnedChildObject`	InChildObject: `FB2GameObject`	`-`	Callback invoked on Spawned Child Object.
`OnSpawnedVehicle`	`-`	`-`	Callback invoked on Spawned Vehicle.
`PostVehicleAccident`	`-`	`-`
`ProcessRidingEntityDeath`	InRidingEntityId: `FB1EntityId`	`-`
`RecallOwnerlessVehicleToOriginalTransform`	`-`	`-`
`RecentlyRendered`	`-`	`boolean`
`RefreshHeadLights`	`-`	`-`
`RefreshPartData`	`-`	`-`
`Reset`	InReason: `EB2EntityStateChangeReason`	`-`	Cleans up the simulation state and deactivates.
`ResetAllPartsState`	`-`	`-`	Resets All Parts State.
`SendUpdateTransform`	`-`	`-`	Sends Update Transform.
`SetAccidentTimeTaskId`	InTimeTaskId: `FB1TimeTaskId`	`-`	Sets Accident Time Task Id.
`SetAccidentUIPlaying`	bPlaying: `boolean`	`-`	Sets Accident UIPlaying.
`SetColorId`	InColorId: `string`	`-`	Sets Color Id.
`SetColorLookUp`	InColorLookUp: `number`	`-`	Sets Color Look Up.
`SetControlSubject`	InControlSubject: `EB1VehicleControlSubject`	`-`	Sets Control Subject.
`SetDestination`	InPosition: `FVector`	`-`	Sets Destination.
`SetHorizontalOffset`	InHorizontalOffset: `number`	`-`	Sets Horizontal Offset.
`SetInputValue`	InValue: `number`	`-`	Sets Input Value.
`SetIsOwnerlessVehicle`	bIsOwnerless: `boolean`	`-`	Sets Is Ownerless Vehicle.
`SetIsStolenDriving`	bInIsStolenDriving: `boolean`	`-`	Sets Is Stolen Driving.
`SetLaneAdvancedDistance`	InAdvancedDistance: `number`	`-`	Sets Lane Advanced Distance.
`SetLaneIndex`	InLaneIndex: `integer`	`-`	Sets Lane Index.
`SetLightFlag`	InVehicleLight: `EB1VehicleLight`, bOn: `boolean`, bSkipPacketSend: `boolean`	`-`	Sets Light Flag.
`SetLocationAndControlSubject`	InPoint: `FB1CityGraphDetailPoint`, InControlSubject: `EB1VehicleControlSubject`	`-`	Sets Location And Control Subject.
`SetNextLaneIndex`	InLaneIndex: `integer`	`-`	Sets Next Lane Index.
`SetNextRoadIndex`	InRoadIndex: `integer`	`-`	Sets Next Road Index.
`SetOwnerEntityId`	InOwnerId: `FB1EntityId`	`-`	Sets Owner Entity Id.
`SetOwnerlessVehicleGuid`	InGuid: `string`	`-`	Sets Ownerless Vehicle Guid.
`SetOwnerlessVehicleOriginalTransform`	InLocation: `FVector`, InRotation: `FRotator`	`-`	Sets Ownerless Vehicle Original Transform.
`SetPartState`	InPartType: `EB1VehiclePartType`, InState: `string`, bForceFinish: `boolean`, InStartPosition: `number`	`-`	Sets Part State.
`SetPendingDestory`	`-`	`-`	Sets Pending Destory.
`SetPendingLaneChange`	bInPending: `boolean`	`-`	Sets Pending Lane Change.
`SetPolicy`	InPolicy: `EB1VehiclePolicy`	`-`	Sets Policy.
`SetRepresentationType`	InRepresentationType: `EB1VehicleRepresentationType`	`-`	Sets Representation Type.
`SetSimulationDriverId`	InDriverId: `FB1EntityId`	`-`	Sets Simulation Driver Id.
`SetSimulationDriverMeshId`	InMeshId: `string`	`-`	Sets Simulation Driver Mesh Id.
`SetSpeed`	InSpeed: `number`	`-`	Sets Speed.
`SetSpeedRate`	InSpeedRate: `number`	`-`	Sets Speed Rate.
`SetSteeringAngle`	InSteeringAngle: `number`	`-`	Sets Steering Angle.
`SetVehicleDtId`	InVehicleDtId: `string`	`-`	Sets Vehicle Dt Id.
`SetVelocity`	InVelocity: `FVector`	`-`	Sets Velocity.
`ShouldSendPacket`	`-`	`boolean`	Returns whether it should Send Packet.
`TransferOwnership`	NewOwnerEntityId: `FB1EntityId`	`-`
`UnbindVehicleAccident`	`-`	`-`
`UnoccupyOwnerlessVehicleSiteGrid`	`-`	`-`

Override points (15)

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

Function	Parameters	Returns	Description
`Override_BindPostVehicleAccident`	InDriverId: `FB1EntityId`, InAccidentTargetVehicleId: `FB1EntityId`	`-`
`Override_ClearVehicleState`	`-`	`-`	Clears Vehicle State.
`Override_CreateVehicleObjects`	`-`	`-`	Creates Vehicle Objects.
`Override_ForcedPassengersExit`	`-`	`-`
`Override_OccupyOwnerlessVehicleSiteGrid`	`-`	`-`
`Override_ProcessRidingEntityDeath`	InRidingEntityId: `FB1EntityId`	`-`
`Override_RecallOwnerlessVehicleToOriginalTransform`	`-`	`-`
`Override_RefreshHeadLights`	`-`	`-`
`Override_RefreshPartData`	`-`	`-`
`Override_Reset`	InReason: `EB2EntityStateChangeReason`	`-`	Cleans up the simulation state and deactivates.
`Override_ResetAllPartsState`	`-`	`-`	Resets All Parts State.
`Override_SendUpdateTransform`	`-`	`-`	Sends Update Transform.
`Override_TransferOwnership`	NewOwnerEntityId: `FB1EntityId`	`-`
`Override_UnbindVehicleAccident`	`-`	`-`
`Override_UnoccupyOwnerlessVehicleSiteGrid`	`-`	`-`