FB2TrafficSystem

Overview

Traffic system.

Metadata

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

Properties (12)

Name	Type	Description
`CachedSimulationDriverData`	`table<string, FB1SimulationDriverData>`
`CachedVehicleBounds`	`table<string, FVector>`
`CityGraphTrafficLanes`	`FB2CityGraphTrafficLane[]`
`CityGraphTrafficVehicleLanes`	`FB2CityGraphTrafficLane[]`
`CityTrafficControlDataAsset`	`any`
`CityTrafficPolicy`	`FB1CityTrafficPolicy`
`DrivenVehicles`	`FB1EntityId[]`
`OwnedVehicles`	`FB1EntityId[]`
`SpawnRatio`	`number`
`SpawnableVehicleDtIdList`	`string[]`
`VehicleDensityModifier`	`number`	VehicleDensity option modifier value (0.0-1.0).
`VehicleStash`	`FB2TrafficVehicleStash`

Functions (26)

Function	Parameters	Returns	Description
`DestroyVehicle`	InVehicle: `FB2Vehicle`, InReason: `EB2EntityDestroyReason`	`-`
`DestroyVehicles`	`-`	`-`
`DestroyVehiclesOnLane`	InLaneIndex: `integer`	`-`
`GenerateVehicle`	`-`	`boolean`	Generates Vehicle.
`GetCityGraphTrafficLane`	InLaneIndex: `integer`	`FB2CityGraphTrafficLane`	Returns City Graph Traffic Lane.
`GetCityTrafficPolicy`	`-`	`FB1CityTrafficPolicy`	Returns City Traffic Policy.
`GetLocalVehicleCapacity`	`-`	`integer`	Returns Local Vehicle Capacity.
`GetLocalVehicleCount`	bSimulated: `boolean`	`integer`	Returns Local Vehicle Count.
`GetRandomSimulationMeshId`	InMeshSetId: `string`	`string`	Returns Random Simulation Mesh Id.
`GetVehicleCapacity`	`-`	`integer`	Returns Vehicle Capacity.
`GetVehicleCapacityByTime`	CurrentTime: `FDateTime`	`integer`	Returns Vehicle Capacity By Time.
`GetVehicleCount`	bSimulated: `boolean`	`integer`	Returns Vehicle Count.
`GetVehicleDensityModifier`	`-`	`number`	Returns Vehicle Density Modifier.
`GetVehicleIdsInCurrentCity`	`-`	`string[]`	Returns Vehicle Ids In Current City.
`GetVehicleSpawnRatio`	CurrentTime: `FDateTime`	`number`	Returns Vehicle Spawn Ratio.
`IsOccupyingTrafficLane`	InLaneIndex: `integer`, InVehicle: `FB2Vehicle`	`boolean`	Returns whether Occupying Traffic Lane.
`OccupyTrafficLane`	InLaneIndex: `integer`, InVehicle: `FB2Vehicle`	`boolean`
`OnChangedGameConfigModifierValue`	InModifierKey: `string`, InModifierValue: `number`	`-`	Callback invoked on Changed Game Config Modifier Value.
`QueryAvailableLanePoint`	InLaneIndex: `integer`, InLength: `number`, InCategory: `EB1CityGraphCategory`, OutPoint: `FB1CityGraphDetailPoint`, InOffset: `number`	`boolean`
`RegisterDrivenVehicle`	InEntityId: `FB1EntityId`	`-`	Registers Driven Vehicle.
`RegisterOwnedVehicle`	InEntityId: `FB1EntityId`	`-`	Registers Owned Vehicle.
`ReleaseTrafficLane`	InLaneIndex: `integer`, InVehicle: `FB2Vehicle`	`-`
`ReplaceValidSimulationMeshId`	InMeshSetId: `string`, InOutMeshId: `string`	`boolean`
`Tick`	DeltaTime: `number`, CurrentTime: `FDateTime`, GameDeltaMinutes: `number`	`-`
`UnregisterDrivenVehicle`	InEntityId: `FB1EntityId`	`-`	Unregisters Driven Vehicle.
`UnregisterOwnedVehicle`	InEntityId: `FB1EntityId`	`-`	Unregisters Owned Vehicle.

Override points (14)

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

Function	Parameters	Returns	Description
`Override_DestroyVehicle`	InVehicle: `FB2Vehicle`, InReason: `EB2EntityDestroyReason`	`-`
`Override_DestroyVehicles`	`-`	`-`
`Override_DestroyVehiclesOnLane`	InLaneIndex: `integer`	`-`
`Override_GenerateVehicle`	`-`	`boolean`	Generates Vehicle.
`Override_OccupyTrafficLane`	InLaneIndex: `integer`, InVehicle: `FB2Vehicle`	`boolean`
`Override_OnChangedGameConfigModifierValue`	InModifierKey: `string`, InModifierValue: `number`	`-`	Callback invoked on Changed Game Config Modifier Value.
`Override_QueryAvailableLanePoint`	InLaneIndex: `integer`, InLength: `number`, InCategory: `EB1CityGraphCategory`, OutPoint: `FB1CityGraphDetailPoint`, InOffset: `number`	`boolean`
`Override_RegisterDrivenVehicle`	InEntityId: `FB1EntityId`	`-`	Registers Driven Vehicle.
`Override_RegisterOwnedVehicle`	InEntityId: `FB1EntityId`	`-`	Registers Owned Vehicle.
`Override_ReleaseTrafficLane`	InLaneIndex: `integer`, InVehicle: `FB2Vehicle`	`-`
`Override_ReplaceValidSimulationMeshId`	InMeshSetId: `string`, InOutMeshId: `string`	`boolean`
`Override_Tick`	DeltaTime: `number`, CurrentTime: `FDateTime`, GameDeltaMinutes: `number`	`-`
`Override_UnregisterDrivenVehicle`	InEntityId: `FB1EntityId`	`-`	Unregisters Driven Vehicle.
`Override_UnregisterOwnedVehicle`	InEntityId: `FB1EntityId`	`-`	Unregisters Owned Vehicle.