Entering Debug Mode
The Debug console can be used for performing debug functions.
To enter debug mode, start by opening the console by pressing the ` [back quote] key. Once it is opened, type “debug” and then press enter to enable debug mode. You will see a “have fun” message if you did it correctly.
Debug mode can only be entered while in an active free play or campaign game session. When enabling debug mode, you will not receive any achievements, campaign progress, or earn rewards from Campaigns/Challenges!
Console Help Command
With debug mode enabled, you can now type “help” into the console to get a list of possible functions. There are 2 types of functions:
- No Parameters: These are commands that do not require any additional information from the user. For example “WinEvent”, or “EndDay”.
- With Parameters: These are commands that require additional information from the user, for example: “AddMoney”, or “SetFreezePolice”.The “AddMoney” command needs to know how much money to add.
The “SetFreezePolice” needs a True or False so it knows how to affect the police behavior.
Function Help Command
Once you find a function you wish to use, you can learn more about it by providing the name of the function after typing in “help”. For example, to get more information on how to use the function “SpawnVehicle”, you would need to type “help SpawnVehicle”.
By combining “help” with a function name, you will see all parameters needed and what value those parameters can be.
Example: Using debug mode to spawn a custom vehicle
Press the ` [back quote] key and type “debug” into the console to enter debug mode.
Type “help” for a list of all possible functions.
Find the “SpawnVehicle” function in this list. You will see that this function requires ‘vehicleData’ as additional info, but this is not enough information to spawn a vehicle.
Type “help SpawnVehicle” to get more information about this function and what ‘vehicleData’ means.
You can now see more information and it’s clear now that “VehicleSpawnData” is represented by “(string vehicleData, string vehicleCondition, string array faults, string array permanent faults, string array upgrades)”.
You can also see what data can be used for each of these parameters in this new help list.
With all of the information provided by the help command, we can now spawn a custom vehicle.
Example: “SpawnVehicle (Car, New, [Faulty_battery, Bad_transmission], , [NOS])”.
Note that some parameters can have multiple inputs such as the “string array faults” or no inputs such as the “string permanent faults”. In the example above, we added two faults to our custom vehicle using “[Faulty_battery, Bad_transmission]” and no permanent faults using “”.