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

From SCS Modding Wiki
Jump to navigation Jump to search
(Update the g_mode command to reflect 1.53.x syntax.)
(35 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
{{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%"
 
{| class="wikitable sortable" width="100%"
 
!width="200px"|Name
 
!width="200px"|Name
−
!width="350px"|Parameters
+
!|Parameters
 
!|Description
 
!|Description
 
|-
 
|-
Line 34: Line 27:
 
|-
 
|-
 
| edit_build
 
| edit_build
−
| -
+
| TODO
−
| Rebuild editor in map editor.
+
| TODO
 
|-
 
|-
 
| edit_build_spawns
 
| edit_build_spawns
−
| -
+
| TODO
−
| Rebuild all spawn points in map editor.
+
| TODO
 
|-
 
|-
 
| edit_mark
 
| edit_mark
−
| See description for parameters
+
| TODO
−
| Marks or unmarks sector.
+
| TODO
−
 
 
−
* 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
−
| Saves the map in map editor for loading in game.
+
| TODO
 +
|-
 +
| edit_save_backend
 +
| TODO
 +
| TODO
 
|-
 
|-
 
| edit_save_text
 
| edit_save_text
−
| -
+
| TODO
−
| Save map in textual form for debugging purpose.
+
| TODO
 +
|-
 +
| edit_unit
 +
| TODO
 +
| TODO
 
|-
 
|-
 
| exec
 
| exec
Line 78: Line 71:
 
| <reason>
 
| <reason>
 
| Exit game command in case of error. (unloads profile)
 
| 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
−
| <index>
+
| TODO
−
| Delete item by given index in map editor
+
| TODO
 
|-
 
|-
 
| g_delete_uid
 
| g_delete_uid
−
| <uid>
+
| TODO
−
| Delete item by given unique index in map editor
+
| TODO
−
|-
 
−
| 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
−
| [asset extension]
+
| TODO
−
| Dumps map.
+
| TODO
 
|-
 
|-
 
| g_dump_signs
 
| g_dump_signs
−
| -
+
| TODO
−
| Dumps traffic signs.
+
| TODO
 
|-
 
|-
 
| g_find_prefab
 
| g_find_prefab
−
| <prefab name> [prefab name] [prefab name] ...
+
| TODO
−
| Find prefabs by its unit name suffix and dump them into bugs file.
+
| TODO
 +
|-
 +
| g_game_dump
 +
| TODO
 +
| TODO
 
|-
 
|-
 
| g_info
 
| g_info
−
| -
+
| TODO
−
| Prints application info. Output depends if you are in game or using map editor.
+
| TODO
 
|-
 
|-
 
| g_item_count
 
| g_item_count
−
| (model, prefab, building, anim, mover)
+
| TODO
−
| Display count of the item. If no parameter is given this function prints summary about all the items.
+
| TODO
 
|-
 
|-
 
| g_mode
 
| g_mode
−
| g_mode <width> <height> <refresh_rate> <fullscreen>
+
| TODO
−
| Change graphics mode. For instance, for windowed 1080p 60Hz: <pre>g_mode 1920 1080 60 0</pre>
+
| TODO
 
|-
 
|-
 
| g_msaa
 
| g_msaa
−
| <sample_count>
+
| TODO
−
| Change [https://en.wikipedia.org/wiki/Multisample_anti-aliasing msaa] sample count.
+
| TODO
 
|-
 
|-
 
| g_next_border_node
 
| g_next_border_node
−
| -
+
| TODO
−
| Finds next border node.
+
| TODO
 +
|-
 +
| g_path
 +
| TODO
 +
| TODO
 
|-
 
|-
 
| g_replace_prefab
 
| g_replace_prefab
−
| <old_token> <new_token>
+
| TODO
−
| Replace old prefab with new prefab. The token is unit name without "prefab." prefix.
+
| TODO
 
|-
 
|-
 
| g_save_curve_as_text
 
| g_save_curve_as_text
−
| <file_name>
+
| TODO
−
| Save curve to text file.
+
| TODO
 
|-
 
|-
 
| g_sel_dist
 
| g_sel_dist
−
| (short, close, middle, far),
+
| TODO
−
| Add to selection all items of given distance type.
+
| TODO
 
|-
 
|-
 
| g_sel_item
 
| g_sel_item
−
| <index>
+
| TODO
−
| Select item by index.
+
| TODO
 
|-
 
|-
 
| g_sel_type
 
| 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)
+
| TODO
−
| Select item by type.
+
| TODO
 
|-
 
|-
 
| g_sel_uid
 
| g_sel_uid
−
| <uid>
+
| TODO
−
| Select item by unique index.
+
| TODO
−
|-
 
−
| 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
−
| Recache ui draw buffers.
+
| TODO
 
|-
 
|-
 
| g_wander_output
 
| g_wander_output
−
| [fps/vm/sb/dc [error limit][warning limit][far plane]]"
+
| TODO
−
| Sets which wander output will be shown.
+
| TODO
 
|-
 
|-
 
| game
 
| game
Line 199: Line 157:
 
|-
 
|-
 
| goto
 
| goto
−
| <x;y;z> or <cityname>
+
| <x;y;z>
−
| Teleport debug camera to place on map. Press <code>CTRL</code> + <code>F9</code> to place your truck at the camera's location.
+
| Teleport debug camera to place on map
 +
|-
 +
| key
 +
| TODO
 +
| TODO
 
|-
 
|-
 
| mark_country
 
| mark_country
−
| <country_id>
+
| TODO
−
| Marks roads and prefabs belong to specified country.
+
| TODO
 
|-
 
|-
 
| mm_check
 
| mm_check
−
| -
+
| TODO
−
| Check integrity of resource manager system.
+
| TODO
 
|-
 
|-
 
| mm_defrag
 
| mm_defrag
Line 226: Line 188:
 
| Run memory manager garbage collector.
 
| Run memory manager garbage collector.
 
|-
 
|-
−
| [[Documentation/Engine/Console/Commands/multimon|multimon]]
+
| mm_sys
 +
| TODO
 +
| TODO
 +
|-
 +
| [[Engine/Console/Commands/multimon|multimon]]
 
| <operation> <mixed>
 
| <operation> <mixed>
 
| Allows configuration of multi monitor support.
 
| Allows configuration of multi monitor support.
Line 233: Line 199:
 
| -
 
| -
 
| Toggle game pause state
 
| Toggle game pause state
−
|-
 
−
| phys_info
 
−
| -
 
−
| Display informations about physical subsystem.
 
 
|-
 
|-
 
| preview
 
| preview
Line 246: Line 208:
 
* preview_editor - editor = start editor, game = start game
 
* preview_editor - editor = start editor, game = start game
 
* profile_to_load - Name of the profile to be loaded
 
* profile_to_load - Name of the profile to be loaded
 +
|-
 +
| profiler_autoshow
 +
| TODO
 +
| TODO
 +
|-
 +
| profiler_dump
 +
| TODO
 +
| TODO
 
|-
 
|-
 
| quit
 
| quit
Line 292: Line 262:
 
| uset
 
| uset
 
| <cvar> <value>
 
| <cvar> <value>
−
| Set value of the [[Documentation/Engine/Configuration variables|cvar]] by name - in case cvar was not found creates new.
+
| Set value of the cvar by name - in case cvar was not found creates new.
 
|-
 
|-
 
| validate
 
| validate
Line 301: Line 271:
 
| <speed>
 
| <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
 
| 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
 +
|-
 +
| g_set_skybox
 +
| TODO
 +
| TODO
 +
|-
 +
| g_set_climate
 +
| TODO
 +
| TODO
 +
|-
 +
| g_set_weather
 +
| TODO
 +
| TODO
 +
|-
 +
| g_set_time
 +
| TODO
 +
| TODO
 +
|-
 +
| phys_info
 +
| TODO
 +
| TODO
 
|-
 
|-
 
| ui
 
| ui
−
| <command[[:flags] name[:class] ["parameters"]]>
+
| TODO
−
| Internal ui operations command.
+
| TODO
−
 
 
−
*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.
 

Revision as of 10:27, 9 February 2016

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 TODO TODO
edit_build_spawns TODO TODO
edit_mark TODO TODO
edit_save TODO TODO
edit_save_backend TODO TODO
edit_save_text TODO TODO
edit_unit TODO TODO
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_delete_idx TODO TODO
g_delete_uid TODO TODO
g_dump TODO TODO
g_dump_signs TODO TODO
g_find_prefab TODO TODO
g_game_dump TODO TODO
g_info TODO TODO
g_item_count TODO TODO
g_mode TODO TODO
g_msaa TODO TODO
g_next_border_node TODO TODO
g_path TODO TODO
g_replace_prefab TODO TODO
g_save_curve_as_text TODO TODO
g_sel_dist TODO TODO
g_sel_item TODO TODO
g_sel_type TODO TODO
g_sel_uid TODO TODO
g_ui_recache TODO TODO
g_wander_output TODO TODO
game <save_slot> Start game.
goto <x;y;z> Teleport debug camera to place on map
key TODO TODO
mark_country TODO TODO
mm_check TODO TODO
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.
mm_sys TODO TODO
multimon <operation> <mixed> Allows configuration of multi monitor support.
pause - Toggle game pause state
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
profiler_autoshow TODO TODO
profiler_dump TODO TODO
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
g_set_skybox TODO TODO
g_set_climate TODO TODO
g_set_weather TODO TODO
g_set_time TODO TODO
phys_info TODO TODO
ui TODO TODO
Retrieved from "https://modding.scssoft.com/index.php?title=Documentation/Engine/Console/Commands&oldid=1006"