Difference between revisions of "Documentation/Engine/Console/Commands"

From SCS Modding Wiki
Jump to navigation Jump to search
 
(54 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
{| class="wikitable" width="100%"
+
{{Tip|Be aware that this page is obsolete, it should be updated with all commands in the future.}}
 +
 
 +
__TOC__
 +
 
 +
Further configuration parameters are available on the [[Documentation/Engine/Configuration variables|cvar]] page.<br>
 +
 
 +
=List=
 +
{| class="wikitable sortable" width="100%"
 
!width="200px"|Name
 
!width="200px"|Name
−
!|Parameters
+
!width="350px"|Parameters
−
!|Purpose
+
!|Description
−
|-
 
−
| cheat
 
−
| -
 
−
| Not available in final builds
 
 
|-
 
|-
 
| check
 
| check
−
| TODO
+
| <what>
−
| TODO
+
| Check if data is correct. At the moment the <what> parameter can be only "company" and then the command will validate if all connections between companies are correct.
 
|-
 
|-
 
| cs_export
 
| cs_export
−
| TODO
+
| <cutscene_name>
−
| TODO
+
| Export cutscene by name.
 
|-
 
|-
 
| dispatch
 
| dispatch
−
| TODO
+
| -
−
| TODO
+
| Handle entering initial state after game launch.
 
|-
 
|-
 
| echo
 
| echo
−
| TODO
+
| <message>
−
| TODO
+
| Prints message to console.
 
|-
 
|-
 
| edit
 
| edit
−
| TODO
+
| <map_name>
−
| TODO
+
| Start editor
 +
 
 +
map_name parameter is name of the map to be edited, if not set editor stars with empty map.
 
|-
 
|-
 
| edit_build
 
| edit_build
−
| TODO
+
| -
−
| TODO
+
| Rebuild editor in map editor.
 
|-
 
|-
 
| edit_build_spawns
 
| edit_build_spawns
−
| TODO
+
| -
−
| TODO
+
| Rebuild all spawn points in map editor.
 
|-
 
|-
 
| edit_mark
 
| edit_mark
−
| TODO
+
| See description for parameters
−
| TODO
+
| Marks or unmarks sector.
 +
 
 +
* edit_mark [set_filtered (base|dlc_foo|any) (dev|rel|any) [hexacolor]]
 +
* edit_mark [set sector_files [hexacolor]]
 +
* edit_mark [set_all hexacolor]
 +
* edit_mark [intersect first_file second_file [hexacolor]]
 +
* edit_mark [clear_all]
 +
* edit_mark [lock [sector_files]]
 +
* edit_mark [unlock [sector_files]]
 
|-
 
|-
 
| edit_save
 
| edit_save
−
| TODO
+
| -
−
| TODO
+
| Saves the map in map editor for loading in game.
−
|-
 
−
| edit_save_backend
 
−
| TODO
 
−
| TODO
 
 
|-
 
|-
 
| edit_save_text
 
| edit_save_text
−
| TODO
+
| -
−
| TODO
+
| Save map in textual form for debugging purpose.
−
|-
 
−
| edit_unit
 
−
| TODO
 
−
| TODO
 
 
|-
 
|-
 
| exec
 
| exec
−
| TODO
+
| <script file name>
−
| TODO
+
| Load and execute different command script.
 +
 
 +
For example if you put this script into My Documents/Euro Truck Simulator 2:
 +
<pre>
 +
# P3D Screenshot script.
 +
 
 +
echo "Taking screenshot.."
 +
screenshot
 +
echo "Screenshot has been taken"
 +
</pre>
 +
Run the game and then write in console "exec /home/script_file_name" it will execute.
 
|-
 
|-
 
| exit
 
| exit
−
| TODO
+
| <reason>
−
| TODO
+
| Exit game command in case of error. (unloads profile)
 +
|-
 +
| g_colbox
 +
| <mode>
 +
| Displays collision boxes while in editor. 1:on, 0:off
 
|-
 
|-
 
| g_delete_idx
 
| g_delete_idx
−
| TODO
+
| <index>
−
| TODO
+
| Delete item by given index in map editor
 
|-
 
|-
 
| g_delete_uid
 
| g_delete_uid
−
| TODO
+
| <uid>
−
| TODO
+
| Delete item by given unique index in map editor
 +
|-
 +
| g_disable_beacons
 +
| <mode>
 +
| Changes behaviour of flashing beacons on AI vehicles/trucks  (accessibility feature for epileptic people).
 +
* 0 - default
 +
* 1 - disables spot lights of strobes and beacons
 +
* 2 - as 1 and also disables their flares blinking by switching them on all the time
 
|-
 
|-
 
| g_dump
 
| g_dump
−
| TODO
+
| [asset extension]
−
| TODO
+
| Dumps map.
 
|-
 
|-
 
| g_dump_signs
 
| g_dump_signs
−
| TODO
+
| -
−
| TODO
+
| Dumps traffic signs.
 
|-
 
|-
 
| g_find_prefab
 
| g_find_prefab
−
| TODO
+
| <prefab name> [prefab name] [prefab name] ...
−
| TODO
+
| Find prefabs by its unit name suffix and dump them into bugs file.
−
|-
 
−
| g_game_dump
 
−
| TODO
 
−
| TODO
 
 
|-
 
|-
 
| g_info
 
| g_info
−
| TODO
+
| -
−
| TODO
+
| Prints application info. Output depends if you are in game or using map editor.
 
|-
 
|-
 
| g_item_count
 
| g_item_count
−
| TODO
+
| (model, prefab, building, anim, mover)
−
| TODO
+
| Display count of the item. If no parameter is given this function prints summary about all the items.
 
|-
 
|-
 
| g_mode
 
| g_mode
−
| TODO
+
| g_mode <driver> <device> <resolution> <fullscreen> [msaa]
−
| TODO
+
| Change graphics mode.
 
|-
 
|-
 
| g_msaa
 
| g_msaa
−
| TODO
+
| <sample_count>
−
| TODO
+
| Change [https://en.wikipedia.org/wiki/Multisample_anti-aliasing msaa] sample count.
 
|-
 
|-
 
| g_next_border_node
 
| g_next_border_node
−
| TODO
+
| -
−
| TODO
+
| Finds next border node.
−
|-
 
−
| g_path
 
−
| TODO
 
−
| TODO
 
 
|-
 
|-
 
| g_replace_prefab
 
| g_replace_prefab
−
| TODO
+
| <old_token> <new_token>
−
| TODO
+
| Replace old prefab with new prefab. The token is unit name without "prefab." prefix.
 
|-
 
|-
 
| g_save_curve_as_text
 
| g_save_curve_as_text
−
| TODO
+
| <file_name>
−
| TODO
+
| Save curve to text file.
 
|-
 
|-
 
| g_sel_dist
 
| g_sel_dist
−
| TODO
+
| (short, close, middle, far),
−
| TODO
+
| Add to selection all items of given distance type.
 
|-
 
|-
 
| g_sel_item
 
| g_sel_item
−
| TODO
+
| <index>
−
| TODO
+
| Select item by index.
 
|-
 
|-
 
| g_sel_type
 
| g_sel_type
−
| TODO
+
| (Terrain, Buildings, Road, Prefab, Model, Company, Services, Cut plane, Mover, No weather area, City, Hinge, Parking, Animated Model, Map Overlay, Ferry, Sound, Garage, Camera point, Walker, Trigger, Services, Sign, bus_stop, Traffic area, Bezier Patch, Compound Model)
−
| TODO
+
| Select item by type.
 
|-
 
|-
 
| g_sel_uid
 
| g_sel_uid
−
| TODO
+
| <uid>
−
| TODO
+
| Select item by unique index.
 +
|-
 +
| g_set_skybox
 +
| <skybox_idx>
 +
| Set current skybox by index.
 +
|-
 +
| g_set_climate
 +
| <nowiki><climate name> [i|f]</nowiki>
 +
| Set climate.
 +
 
 +
Parameter explanation:
 +
* i - interpolated change,
 +
* f - forced change
 +
|-
 +
| g_set_weather
 +
| <nowiki><weather_index> [i|f]</nowiki>
 +
| Set weather.
 +
 
 +
Parameter explanation:
 +
* weather_index
 +
**0 - nice
 +
**1 - bad
 +
* i - interpolated change,
 +
* f - forced change
 +
|-
 +
| g_set_time
 +
| <nowiki><hours> [minutes] [remove_traffic]</nowiki>
 +
| Set game time.
 +
 
 +
Parameters explanation:
 +
*remove_traffic
 +
**0 - no
 +
**1 - yes
 
|-
 
|-
 
| g_ui_recache
 
| g_ui_recache
−
| TODO
+
| -
−
| TODO
+
| Recache ui draw buffers.
 
|-
 
|-
 
| g_wander_output
 
| g_wander_output
−
| TODO
+
| [fps/vm/sb/dc [error limit][warning limit][far plane]]"
−
| TODO
+
| Sets which wander output will be shown.
 
|-
 
|-
 
| game
 
| game
−
| TODO
+
| <save_slot>
−
| TODO
+
| Start game.
 
|-
 
|-
 
| goto
 
| goto
−
| TODO
+
| <x;y;z> or <cityname>
−
| TODO
+
| Teleport debug camera to place on map. Press <code>CTRL</code> + <code>F9</code> to place your truck at the camera's location.
−
|-
 
−
| key
 
−
| TODO
 
−
| TODO
 
 
|-
 
|-
 
| mark_country
 
| mark_country
−
| TODO
+
| <country_id>
−
| TODO
+
| Marks roads and prefabs belong to specified country.
 
|-
 
|-
 
| mm_check
 
| mm_check
−
| TODO
+
| -
−
| TODO
+
| Check integrity of resource manager system.
 
|-
 
|-
 
| mm_defrag
 
| mm_defrag
−
| TODO
+
| -
−
| TODO
+
| Run memory manager defragmentation.
 
|-
 
|-
 
| mm_dump
 
| mm_dump
−
| TODO
+
| [?bim] (help, blocks, items, mlru) [c] (children)
−
| TODO
+
| Dump memory manager content.
 
|-
 
|-
 
| mm_flush
 
| mm_flush
−
| TODO
+
| -
−
| TODO
+
| Run memory manager garbage collector.
 
|-
 
|-
 
| mm_flush_repeatedly
 
| mm_flush_repeatedly
−
| TODO
+
| -
−
| TODO
+
| Run memory manager garbage collector.
 
|-
 
|-
−
| mm_sys
+
| [[Documentation/Engine/Console/Commands/multimon|multimon]]
−
| TODO
+
| <operation> <mixed>
−
| TODO
+
| Allows configuration of multi monitor support.
 
|-
 
|-
−
| multimon
+
| pause
−
| TODO
+
| -
−
| TODO
+
| Toggle game pause state
 
|-
 
|-
−
| pause
+
| phys_info
−
| TODO
+
| -
−
| TODO
+
| Display informations about physical subsystem.
 
|-
 
|-
 
| preview
 
| preview
−
| TODO
+
| <map_name> <preview_editor> <profile_to_load>
−
| TODO
+
| Start game in preview mode
−
|-
+
 
−
| profiler_autoshow
+
Parameters:
−
| TODO
+
* map_name - Name of the map to preview
−
| TODO
+
* preview_editor - editor = start editor, game = start game
−
|-
+
* profile_to_load - Name of the profile to be loaded
−
| profiler_dump
 
−
| TODO
 
−
| TODO
 
 
|-
 
|-
 
| quit
 
| quit
−
| TODO
+
| -
−
| TODO
+
| Closes the game
 
|-
 
|-
 
| route
 
| route
−
| TODO
+
| <start company name> <end company name>
−
| TODO
+
| Command runs navigation between two given points and marks examined road network for visual preview
 
|-
 
|-
 
| s_info
 
| s_info
−
| TODO
+
| -
−
| TODO
+
| Reports informations about sound subsystem
 
|-
 
|-
 
| save
 
| save
−
| TODO
+
| -
−
| TODO
+
| Forces game save
 
|-
 
|-
 
| screenshot
 
| screenshot
−
| TODO
+
| <custom_name>
−
| TODO
+
| Makes a screenshot.
 +
 
 +
The <custom_name> parameter sets custom name of screenshot file name. This parameter is optional.
 
|-
 
|-
 
| sdk
 
| sdk
−
| TODO
+
| <operation>
−
| TODO
+
| Perform SDK operation
−
|-
+
 
−
| set
+
<operation> parameter can be:
−
| -
+
* reinit - reinitializes the SDK
−
| -
+
* unload - unload all plugins
 +
* reload - reloads all plugins
 
|-
 
|-
 
| spawn
 
| spawn
−
| [object_type]
+
| <object_type>
 
| Spawn traffic object
 
| Spawn traffic object
 +
 +
Allowed object types:
 +
* vehicle - standard ai vehicle
 +
* vehicle_forced - forced ai vehicle (ignoring traffic origin and density)
 
|-
 
|-
 
| test
 
| test
Line 241: Line 291:
 
|-
 
|-
 
| uset
 
| uset
−
| [cvar] [value]
+
| <cvar> <value>
−
| Set value of the cvar by name - in case cvar was not found creates new.
+
| Set value of the [[Documentation/Engine/Configuration variables|cvar]] by name - in case cvar was not found creates new.
 
|-
 
|-
 
| validate
 
| validate
Line 249: Line 299:
 
|-
 
|-
 
| warp
 
| warp
−
| [speed <0.0001 .. 60.0>]
+
| <speed>
−
| Set speed of the gameplay
+
| Set speed of the gameplay. The correct value of the speed parameter is a floating point number in range from 0.0001 to 60.0
 +
|-
 +
| ui
 +
| <command[[:flags] name[:class] ["parameters"]]>
 +
| Internal ui operations command.
 +
 
 +
*command
 +
**'s'(how)    - shows a window. Parameters [ui_script [left=0 bottom=0]]
 +
**'h'(ide)    - hides a window
 +
**'t'(oggle)  - toggles window. For parameters see 's'
 +
**'i'(nsert)  - inserts a window. For parameters see 's'
 +
**'r'(emove)  - removes a window
 +
**'c'(ommand) - commands ui component. Parameters [component_name parameters]
 +
*flags
 +
**'v'(iew)  - hides a pointer atop this window
 +
**'l'(ock 0) - doesn't lock input when showing this window
 +
**'m'(odular)- makes a window modular
 +
**'f'(ocus 0)- doesn't grab focus when showing this window
 +
**'e'(vfiltr)- create as eventfilter
 +
**'t'(opmost)- create as topmost
 +
**'b'(ottomm)- create as bottommost
 
|}
 
|}
 +
 +
=Legend=
 +
'''Command parameters'''
 +
*Parameters surrounded by <> are required.
 +
*Parameters surrounded by [] are optional.
 +
*Parameters surrounded by () are values that can be used as this parameter - other values effect depends on the command.

Latest revision as of 01:51, 13 November 2023

TIP: Be aware that this page is obsolete, it should be updated with all commands in the future.

Contents

Further configuration parameters are available on the cvar page.

List

Name Parameters Description
check <what> Check if data is correct. At the moment the <what> parameter can be only "company" and then the command will validate if all connections between companies are correct.
cs_export <cutscene_name> Export cutscene by name.
dispatch - Handle entering initial state after game launch.
echo <message> Prints message to console.
edit <map_name> Start editor

map_name parameter is name of the map to be edited, if not set editor stars with empty map.

edit_build - Rebuild editor in map editor.
edit_build_spawns - Rebuild all spawn points in map editor.
edit_mark See description for parameters Marks or unmarks sector.
  • edit_mark [set_filtered (base|dlc_foo|any) (dev|rel|any) [hexacolor]]
  • edit_mark [set sector_files [hexacolor]]
  • edit_mark [set_all hexacolor]
  • edit_mark [intersect first_file second_file [hexacolor]]
  • edit_mark [clear_all]
  • edit_mark [lock [sector_files]]
  • edit_mark [unlock [sector_files]]
edit_save - Saves the map in map editor for loading in game.
edit_save_text - Save map in textual form for debugging purpose.
exec <script file name> Load and execute different command script.

For example if you put this script into My Documents/Euro Truck Simulator 2: 

# P3D Screenshot script.

echo "Taking screenshot.."
screenshot
echo "Screenshot has been taken"

Run the game and then write in console "exec /home/script_file_name" it will execute.

exit <reason> Exit game command in case of error. (unloads profile)
g_colbox <mode> Displays collision boxes while in editor. 1:on, 0:off
g_delete_idx <index> Delete item by given index in map editor
g_delete_uid <uid> Delete item by given unique index in map editor
g_disable_beacons <mode> Changes behaviour of flashing beacons on AI vehicles/trucks (accessibility feature for epileptic people).
  • 0 - default
  • 1 - disables spot lights of strobes and beacons
  • 2 - as 1 and also disables their flares blinking by switching them on all the time
g_dump [asset extension] Dumps map.
g_dump_signs - Dumps traffic signs.
g_find_prefab <prefab name> [prefab name] [prefab name] ... Find prefabs by its unit name suffix and dump them into bugs file.
g_info - Prints application info. Output depends if you are in game or using map editor.
g_item_count (model, prefab, building, anim, mover) Display count of the item. If no parameter is given this function prints summary about all the items.
g_mode g_mode <driver> <device> <resolution> <fullscreen> [msaa] Change graphics mode.
g_msaa <sample_count> Change msaa sample count.
g_next_border_node - Finds next border node.
g_replace_prefab <old_token> <new_token> Replace old prefab with new prefab. The token is unit name without "prefab." prefix.
g_save_curve_as_text <file_name> Save curve to text file.
g_sel_dist (short, close, middle, far), Add to selection all items of given distance type.
g_sel_item <index> Select item by index.
g_sel_type (Terrain, Buildings, Road, Prefab, Model, Company, Services, Cut plane, Mover, No weather area, City, Hinge, Parking, Animated Model, Map Overlay, Ferry, Sound, Garage, Camera point, Walker, Trigger, Services, Sign, bus_stop, Traffic area, Bezier Patch, Compound Model) Select item by type.
g_sel_uid <uid> Select item by unique index.
g_set_skybox <skybox_idx> Set current skybox by index.
g_set_climate <climate name> [i|f] Set climate.

Parameter explanation:

  • i - interpolated change,
  • f - forced change
g_set_weather <weather_index> [i|f] Set weather.

Parameter explanation:

  • weather_index
    • 0 - nice
    • 1 - bad
  • i - interpolated change,
  • f - forced change
g_set_time <hours> [minutes] [remove_traffic] Set game time.

Parameters explanation:

  • remove_traffic
    • 0 - no
    • 1 - yes
g_ui_recache - Recache ui draw buffers.
g_wander_output [fps/vm/sb/dc [error limit][warning limit][far plane]]" Sets which wander output will be shown.
game <save_slot> Start game.
goto <x;y;z> or <cityname> Teleport debug camera to place on map. Press CTRL + F9 to place your truck at the camera's location.
mark_country <country_id> Marks roads and prefabs belong to specified country.
mm_check - Check integrity of resource manager system.
mm_defrag - Run memory manager defragmentation.
mm_dump [?bim] (help, blocks, items, mlru) [c] (children) Dump memory manager content.
mm_flush - Run memory manager garbage collector.
mm_flush_repeatedly - Run memory manager garbage collector.
multimon <operation> <mixed> Allows configuration of multi monitor support.
pause - Toggle game pause state
phys_info - Display informations about physical subsystem.
preview <map_name> <preview_editor> <profile_to_load> Start game in preview mode

Parameters:

  • map_name - Name of the map to preview
  • preview_editor - editor = start editor, game = start game
  • profile_to_load - Name of the profile to be loaded
quit - Closes the game
route <start company name> <end company name> Command runs navigation between two given points and marks examined road network for visual preview
s_info - Reports informations about sound subsystem
save - Forces game save
screenshot <custom_name> Makes a screenshot.

The <custom_name> parameter sets custom name of screenshot file name. This parameter is optional.

sdk <operation> Perform SDK operation

<operation> parameter can be:

  • reinit - reinitializes the SDK
  • unload - unload all plugins
  • reload - reloads all plugins
spawn <object_type> Spawn traffic object

Allowed object types:

  • vehicle - standard ai vehicle
  • vehicle_forced - forced ai vehicle (ignoring traffic origin and density)
test - Not available in final builds
uset <cvar> <value> Set value of the cvar by name - in case cvar was not found creates new.
validate - Start validation
warp <speed> Set speed of the gameplay. The correct value of the speed parameter is a floating point number in range from 0.0001 to 60.0
ui <command[[:flags] name[:class] ["parameters"]]> Internal ui operations command.
  • command
    • 's'(how) - shows a window. Parameters [ui_script [left=0 bottom=0]]
    • 'h'(ide) - hides a window
    • 't'(oggle) - toggles window. For parameters see 's'
    • 'i'(nsert) - inserts a window. For parameters see 's'
    • 'r'(emove) - removes a window
    • 'c'(ommand) - commands ui component. Parameters [component_name parameters]
  • flags
    • 'v'(iew) - hides a pointer atop this window
    • 'l'(ock 0) - doesn't lock input when showing this window
    • 'm'(odular)- makes a window modular
    • 'f'(ocus 0)- doesn't grab focus when showing this window
    • 'e'(vfiltr)- create as eventfilter
    • 't'(opmost)- create as topmost
    • 'b'(ottomm)- create as bottommost

Legend

Command parameters

  • Parameters surrounded by <> are required.
  • Parameters surrounded by [] are optional.
  • Parameters surrounded by () are values that can be used as this parameter - other values effect depends on the command.
Retrieved from "https://modding.scssoft.com/index.php?title=Documentation/Engine/Console/Commands&oldid=5321"