Cyber Engine Tweaks
Modding
Dictionary
Other
External docs
Other Wikis
VehicleSystem
Documents the VehicleSystem class and its functions.
PARTIALLY DOCUMENTED
We have limited information on how these commands function. More specifics will be added over time.

Invoking VehicleSystem

To invoke the vehicle system, use the following Global function:
1
vs = Game.GetVehicleSystem()
Copied!
Following that, you can invoke sub-functions listed below as follows:
1
vs:EnableAllPlayerVehicles()
Copied!

Sub-Functions

EnableAllPlayerVehicles

EnableAllPlayerVehicles
Info & Usage
1
EnableAllPlayerVehicles();
Copied!
Grant the player all available vehicles.
Usage
1
vs = Game.GetVehicleSystem()
2
vs:EnableAllPlayerVehicles()
Copied!

EnablePlayerVehicle

EnablePlayerVehicle
Info & Usage
1
EnablePlayerVehicle(vehicle : String, enable : Bool, optional despawnIfDisabling : Bool)
Copied!
Grant the player a specific player vehicle. See this list for currently known vehicle strings.
Usage
1
vs = Game.GetVehicleSystem()
2
vs:EnablePlayerVehicle("Vehicle.v_sport1_quadra_turbo_r_player", true, false)
Copied!

GetPlayerVehicles

GetPlayerVehicles
Info & Usage
1
GetPlayerVehicles(out vehicles : array:PlayerVehicle);
Copied!
List currently owned player vehicles.

TogglePlayerActiveVehicle

TogglePlayerActiveVehicle
Info & Usage
1
TogglePlayerActiveVehicle(vehicleID : GarageVehicleID, vehicleType : gamedataVehicleType, enable : Bool)
Copied!
Toggle the most recently used player vehicle.
Params to pass to this function are unknown

GetPlayerUnlockedVehicles

GetPlayerUnlockedVehicles
Info & Usage
1
GetPlayerUnlockedVehicles(out unlockedVehicles : array:PlayerVehicle);
Copied!
Returns a list of vehicles the player has unlocked.

SpawnPlayerVehicle

SpawnPlayerVehicle
Info & Usage
1
SpawnPlayerVehicle(optional vehicleType : gamedataVehicleType);
Copied!
Spawns a specific player vehicle.
We cannot currently pass the params required for this function. We expect this to change as more parameter types are supported by CET.

DespawnPlayerVehicle

DespawnPlayerVehicle
Info & Usage
1
DespawnPlayerVehicle(vehicleID : GarageVehicleID);
Copied!
De-spawn a player vehicle.
The param type to pass to this function is currently unknown

ToggleSummonMode

ToggleSummonMode
Info & Usage
1
ToggleSummonMode();
Copied!
Using this command once makes it so that when you summon a vehicle, it instantly spawns in front of you as opposed to automatically driving to you. Use command again to revert to default behavior.
Usage
1
vs = Game.GetVehicleSystem()
2
vs:ToggleSummonMode()
Copied!

Unknown / Do Not Function

We have limited or no information on what the below functions do nor how they are used at this time.
1
EnablePlayerVehicleCollision(enable : Bool);
2
GetVehicleRestrictions() : array:CName;
3
OnVehicleSystemAttach();
Copied!

Currently Known Vehicle Strings

1
Vehicle.v_sport1_herrera_outlaw_player
2
Vehicle.v_sport1_quadra_turbo_player
3
Vehicle.v_sport1_quadra_turbo_r_player
4
Vehicle.v_sport1_rayfield_aerondight_player
5
Vehicle.v_sport1_rayfield_caliburn_player
6
Vehicle.v_sport2_mizutani_shion_player
7
Vehicle.v_sport2_mizutani_shion_nomad_player
8
Vehicle.v_sport2_porsche_911turbo_player
9
Vehicle.v_sport2_quadra_type66_player
10
Vehicle.v_sport2_quadra_type66_avenger_player
11
Vehicle.v_sport2_quadra_type66_nomad_player
12
Vehicle.v_sport2_villefort_alvarado_player
13
Vehicle.v_standard25_mahir_supron_player
14
Vehicle.v_standard25_villefort_columbus_player
15
Vehicle.v_standard25_thorton_colby_pickup_player
16
Vehicle.v_standard2_archer_hella_player
17
Vehicle.v_standard2_archer_quartz_player
18
Vehicle.v_standard2_chevalier_thrax_player
19
Vehicle.v_standard2_makigai_maimai_player
20
Vehicle.v_standard2_thorton_colby_player
21
Vehicle.v_standard2_thorton_galena_player
22
Vehicle.v_standard2_thorton_galena_nomad_player
23
Vehicle.v_standard2_villefort_cortes_player
24
Vehicle.v_standard2_villefort_cortes_delamain_player
25
Vehicle.v_standard3_chevalier_emperor_player
26
Vehicle.v_standard3_thorton_mackinaw_player
27
Vehicle.v_sportbike1_yaiba_kusanagi_player
28
Vehicle.v_sportbike2_arch_player
29
Vehicle.v_sportbike3_brennan_apollo_player
30
Vehicle.v_sportbike3_brennan_apollo_nomad_player
31
Vehicle.v_sportbike2_arch_jackie_player
32
Vehicle.v_sportbike2_arch_jackie_tuned_player
33
Vehicle.v_sport2_villefort_alvarado_valentinos_player
34
Vehicle.v_standard2_thorton_galena_bobas_player
35
Vehicle.v_standard3_thorton_mackinaw_ncu_player
36
Vehicle.v_sport2_quadra_type66_nomad_ncu_player
37
Vehicle.v_sportbike1_yaiba_kusanagi_tyger_player
38
Vehicle.v_sportbike2_arch_tyger_player
39
Vehicle.v_sport2_mizutani_shion_nomad_02_player
40
Vehicle.v_sport1_rayfield_caliburn_02_player
41
Vehicle.v_standard25_thorton_colby_pickup_02_player
Copied!
Note: There is 1 player ownable vehicle missing from this list.

Notes / Caveats

TweakDB currently contains entries for vehicles that aren't suffixed by _player. These vehicles cannot be added to owned vehicles due to flags in TweakDB which flags vehicles the player can own. Only vehicle strings that end in _player can be added to owned vehicles at this time.
Last modified 1yr ago