User Tools

Site Tools


en:tutorials:config:guide_to_the_orx_console

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
tutorials:guide_to_the_orx_console [2017/11/12 18:35 (6 years ago)] – Release sausageen:tutorials:config:guide_to_the_orx_console [2023/07/12 19:02 (9 months ago)] (current) – [Getting Help on a Command] iarwain
Line 11: Line 11:
 The Orx Console will save you many hours of fiddly experimentation. The Orx Console will save you many hours of fiddly experimentation.
  
-{{ :tutorials:bounce-app-console.png |}}+{{ tutorials:command:bounce-app-console.png |}}
  
 ==== Starting with a Common Project ==== ==== Starting with a Common Project ====
Line 17: Line 17:
 It will be helpful to use a common project that is available to everyone so that you can work with commands and configuration demonstrated in this guide. It will be helpful to use a common project that is available to everyone so that you can work with commands and configuration demonstrated in this guide.
  
-If you are using the [[https://github.com/orx/orx | git repo version of Orx]], you can use the Bounce Demo. Start it by executing: ''code/bin/orxd.exe''+If you are using the [[https://github.com/orx/orx | git repo version of Orx]], you can use the [[en:tutorials:config:bounce_demo|Bounce Demo]]. Start it by executing: ''code/bin/orxd.exe''
  
 The Bounce Demo is not available in the downloadable release versions of Orx. Otherwise just use a project of your own. The Bounce Demo is not available in the downloadable release versions of Orx. Otherwise just use a project of your own.
  
  
-{{ :tutorials:bounce-app.png |}}+{{ tutorials:command:bounce-app.png |}}
  
 ==== Starting the Orx Console ==== ==== Starting the Orx Console ====
Line 33: Line 33:
  
  
-{{ :tutorials:bounce-app-console.png |}}+{{ tutorials:command:bounce-app-console.png |}}
  
 ==== Finding Commands and Navigating ==== ==== Finding Commands and Navigating ====
Line 81: Line 81:
 The info in between the ''{}'' is the return value. Then the command itself. Values in between ''()'' are required values. Values in between ''[]'' are optional values. The info in between the ''{}'' is the return value. Then the command itself. Values in between ''()'' are required values. Values in between ''[]'' are optional values.
  
 +Commands utilize the following types:
 +
 +  * ''orxBOOL'': Must be either 'true' or 'false'.
 +  * ''orxFLOAT'': Any floating point value.
 +  * ''orxS32'': signed 32-bit value
 +  * ''orxS64'': signed 64-bit value
 +  * ''orxU32'': unsigned 32-bit value
 +  * ''orxU64'': unsigned 64-bit value
 +  * ''orxNUMERIC'': Any numerical type, ie. a string that can be interpreted as a vector, an int (decimal, hexa, octal, binary) or a float
 +  * ''orxSTRING'': Any String value.
 +  * ''orxVECTOR'': a 3-component vector (mathematics) 
 +
 +==== Copy/Paste Commands ====
 +
 +Rather than typing all your commands, you have the choice to copy commands from this tutorial directly into the console using the clipboard. Select the following command and copy it into your clipboard:
 +
 +''Command.Version''
 +
 +Now paste with Control-V into the command bar of the Orx Console. Your command will be pasted in, and you can press enter to execute it.
  
 ==== Basic Commands ==== ==== Basic Commands ====
Line 586: Line 605:
 Hopefully this guide was helpful and is giving you some great ideas of what is possible. Anything you do here in the Console can be used in tracks giving you the same power in-game. Hopefully this guide was helpful and is giving you some great ideas of what is possible. Anything you do here in the Console can be used in tracks giving you the same power in-game.
  
-Check out some of the [[tutorials:main#timelinestracks|track tutorials]] and [[examples:tracks_commands:main|track examples]] to see how you can apply this.+Check out some of the [[en:tutorials:main#timelinestracks|track tutorials]] and [[en:examples:tracks_commands:main|track examples]] to see how you can apply this.
  
en/tutorials/config/guide_to_the_orx_console.1510540554.txt.gz · Last modified: 2017/11/12 22:35 (6 years ago) (external edit)