User Tools

Site Tools


en:tutorials:community:acksys:commandnotes

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
en:tutorials:community:acksys:commandnotes [2019/06/14 10:05 (4 weeks ago)]
sausage Replace core commands with the easy to read list
en:tutorials:community:acksys:commandnotes [2019/06/14 10:13 (4 weeks ago)]
sausage Clean up
Line 1: Line 1:
 ====== Command Module notes ====== ====== Command Module notes ======
  
-Bring up Console ​in game with tilde (~)+From the [[en:​tutorials:​bounce_demo|The Orx Bounce Demo]], or any of your own games, you can bring up the Orx Console with tilde (~).
  
-Command.ListCommands lists all commands +''​Command.ListCommands'' ​lists all commands 
-Command.ListCommands <​prefix>​ filters list by prefix.+''​Command.ListCommands <​prefix>​'' ​filters list by prefix.
  
-e.g. Command.ListCommands Config only shows commands for the config module+e.g. ''​Command.ListCommands Config'' ​only shows commands for the config module
  
-Command.Help <​command> ​gets the prototype of a command+''​Command.Help <​command>​''​ shows how to use a command.
  
 - Executing a command directly from code: - Executing a command directly from code:
-<​code ​c>+ 
 +<code c>
 orxCOMMAND_VAR stResult; ​ orxCOMMAND_VAR stResult; ​
 orxCommand_Evaluate("​Object.Create RedCar",​ &​stResult);​ orxCommand_Evaluate("​Object.Create RedCar",​ &​stResult);​
 </​code>​ </​code>​
  
-stResult.u64Value will contain the GUID of the created object.+''​stResult.u64Value'' ​will contain the GUID of the created object.
  
 Of course the string can be loaded from config for something more data-driven. Of course the string can be loaded from config for something more data-driven.
Line 22: Line 23:
 ====== Core Commands ====== ====== Core Commands ======
  
-These commands are registered by the orx system automatically. See below for the macro orxCOMMAND_REGISTER_CORE_COMMAND that registers these commands.+These commands are registered by the Orx system automatically. See below for the macro orxCOMMAND_REGISTER_CORE_COMMAND that registers these commands.
  
 To register your own commands, write a similar macro or register your command with orxCommand_Register. To register your own commands, write a similar macro or register your command with orxCommand_Register.
Line 289: Line 290:
 In code, create the "​Timer"​ object and the timeline is added to it immediately on creation. In code, create the "​Timer"​ object and the timeline is added to it immediately on creation.
  
-Currently, this is the timeline track template (from CreationSettings.ini):​+Currently, this is the [[en:​orx:​config:​settings_structure:​orxtimelinetrack|timeline track template]] (from [[https://​bitbucket.org/​orx/​orx/​src/​default/​code/​bin/​CreationTemplate.ini|CreationSettings.ini]]):
 <​code=ini>​ <​code=ini>​
 [TimeLineTrackTemplate] [TimeLineTrackTemplate]
en/tutorials/community/acksys/commandnotes.txt · Last modified: 2019/06/14 10:13 (4 weeks ago) by sausage