VehicleSystem
PARTIALLY DOCUMENTED
We have limited information on how these commands function. More specifics will be added over time.
To invoke the vehicle system, use the following Global function:
vs = Game.GetVehicleSystem()
Following that, you can invoke sub-functions listed below as follows:
vs:EnableAllPlayerVehicles()
EnableAllPlayerVehicles();
Grant the player all available vehicles.
Usage
vs = Game.GetVehicleSystem()vs:EnableAllPlayerVehicles()
EnablePlayerVehicle(vehicle : String, enable : Bool, optional despawnIfDisabling : Bool)
Grant the player a specific player vehicle. See this list for currently known vehicle strings.
Usage
vs = Game.GetVehicleSystem()vs:EnablePlayerVehicle("Vehicle.v_sport1_quadra_turbo_r_player", true, false)
GetPlayerVehicles(out vehicles : array:PlayerVehicle);
List currently owned player vehicles.
TogglePlayerActiveVehicle(vehicleID : GarageVehicleID, vehicleType : gamedataVehicleType, enable : Bool)
Toggle the most recently used player vehicle.
Params to pass to this function are unknown
GetPlayerUnlockedVehicles(out unlockedVehicles : array:PlayerVehicle);
Returns a list of vehicles the player has unlocked.
SpawnPlayerVehicle(optional vehicleType : gamedataVehicleType);
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(vehicleID : GarageVehicleID);
De-spawn a player vehicle.
The param type to pass to this function is currently unknown
ToggleSummonMode();
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
vs = Game.GetVehicleSystem()vs:ToggleSummonMode()
We have limited or no information on what the below functions do nor how they are used at this time.
EnablePlayerVehicleCollision(enable : Bool);GetVehicleRestrictions() : array:CName;OnVehicleSystemAttach();
Vehicle.v_sport1_herrera_outlaw_playerVehicle.v_sport1_quadra_turbo_playerVehicle.v_sport1_quadra_turbo_r_playerVehicle.v_sport1_rayfield_aerondight_playerVehicle.v_sport1_rayfield_caliburn_playerVehicle.v_sport2_mizutani_shion_playerVehicle.v_sport2_mizutani_shion_nomad_playerVehicle.v_sport2_porsche_911turbo_playerVehicle.v_sport2_quadra_type66_playerVehicle.v_sport2_quadra_type66_avenger_playerVehicle.v_sport2_quadra_type66_nomad_playerVehicle.v_sport2_villefort_alvarado_playerVehicle.v_standard25_mahir_supron_playerVehicle.v_standard25_villefort_columbus_playerVehicle.v_standard25_thorton_colby_pickup_playerVehicle.v_standard2_archer_hella_playerVehicle.v_standard2_archer_quartz_playerVehicle.v_standard2_chevalier_thrax_playerVehicle.v_standard2_makigai_maimai_playerVehicle.v_standard2_thorton_colby_playerVehicle.v_standard2_thorton_galena_playerVehicle.v_standard2_thorton_galena_nomad_playerVehicle.v_standard2_villefort_cortes_playerVehicle.v_standard2_villefort_cortes_delamain_playerVehicle.v_standard3_chevalier_emperor_playerVehicle.v_standard3_thorton_mackinaw_playerVehicle.v_sportbike1_yaiba_kusanagi_playerVehicle.v_sportbike2_arch_playerVehicle.v_sportbike3_brennan_apollo_playerVehicle.v_sportbike3_brennan_apollo_nomad_playerVehicle.v_sportbike2_arch_jackie_playerVehicle.v_sportbike2_arch_jackie_tuned_playerVehicle.v_sport2_villefort_alvarado_valentinos_playerVehicle.v_standard2_thorton_galena_bobas_playerVehicle.v_standard3_thorton_mackinaw_ncu_playerVehicle.v_sport2_quadra_type66_nomad_ncu_playerVehicle.v_sportbike1_yaiba_kusanagi_tyger_playerVehicle.v_sportbike2_arch_tyger_playerVehicle.v_sport2_mizutani_shion_nomad_02_playerVehicle.v_sport1_rayfield_caliburn_02_playerVehicle.v_standard25_thorton_colby_pickup_02_player
Note: There is 1 player ownable vehicle missing from this list.
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.
