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
Next revision
Previous revision
en:tutorials:community:acksys:commandnotes [2018/02/14 04:46 (17 months ago)]
iarwain ↷ Page moved from tutorials:community:acksys:commandnotes to en:tutorials:community:acksys:commandnotes
en:tutorials:community:acksys:commandnotes [2019/06/14 10:13 (5 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.
  
 <​code>​ <​code>​
-CommandHelp, "​Help",​ orxCOMMAND_VAR_TYPE_STRING,​ 0, 1, {"Command ​= \"​\"",​ orxCOMMAND_VAR_TYPE_STRING});​ +Camera.Create 
-CommandListCommands, "​Counter",​ orxCOMMAND_VAR_TYPE_U32,​ 0, 1, {"​Prefix = \"​\"",​ orxCOMMAND_VAR_TYPE_STRING});​ +Camera.Delete 
-Command, AddAlias, "​Alias",​ orxCOMMAND_VAR_TYPE_STRING,​ 2, 1, {"​Alias",​ orxCOMMAND_VAR_TYPE_STRING},​ {"Command/​Alias",​ orxCOMMAND_VAR_TYPE_STRING},​ {"​Arguments",​ orxCOMMAND_VAR_TYPE_STRING});​ +Camera.Get 
-CommandRemoveAlias, "​Alias",​ orxCOMMAND_VAR_TYPE_STRING,​ 1, 0, {"​Alias",​ orxCOMMAND_VAR_TYPE_STRING});​ +Camera.GetID 
-Command, ListAliases,​ "​Counter",​ orxCOMMAND_VAR_TYPE_U32,​ 0, 1, {"​Prefix = \"​\"",​ orxCOMMAND_VAR_TYPE_STRING});​ +Camera.GetName 
-Config, Load, "​Success?",​ orxCOMMAND_VAR_TYPE_BOOL,​ 1, 0, {"​FileName",​ orxCOMMAND_VAR_TYPE_STRING});​ +Camera.GetParent 
-Config, Save, "​Success?",​ orxCOMMAND_VAR_TYPE_BOOL,​ 1, 2, {"​FileName",​ orxCOMMAND_VAR_TYPE_STRING},​ {"​OnlyOrigin = false",​ orxCOMMAND_VAR_TYPE_BOOL},​ {"​Encrypt = false",​ orxCOMMAND_VAR_TYPE_BOOL});​ +Camera.GetPosition 
-Config, Reload, "​Success?",​ orxCOMMAND_VAR_TYPE_BOOL,​ 0, 0); +Camera.GetRotation 
-ConfigGetParent, "​Parent",​ orxCOMMAND_VAR_TYPE_STRING,​ 1, 0, {"​Section",​ orxCOMMAND_VAR_TYPE_STRING});​ +Camera.GetZoom 
-Config, SetParent, "​Section",​ orxCOMMAND_VAR_TYPE_STRING,​ 1, 1, {"​Section",​ orxCOMMAND_VAR_TYPE_STRING},​ {"​Parent = <​void>",​ orxCOMMAND_VAR_TYPE_STRING});​ +Camera.SetFrustum 
-Config, CreateSection,​ "​Section",​ orxCOMMAND_VAR_TYPE_STRING,​ 1, 0, {"​Section",​ orxCOMMAND_VAR_TYPE_STRING});​ +Camera.SetParent 
-ConfigHasSection, "​Section?",​ orxCOMMAND_VAR_TYPE_BOOL,​ 1, 0, {"​Section",​ orxCOMMAND_VAR_TYPE_STRING});​ +Camera.SetPosition 
-Config, ClearSection,​ "​Section",​ orxCOMMAND_VAR_TYPE_STRING,​ 1, 0, {"​Section",​ orxCOMMAND_VAR_TYPE_STRING});​ +Camera.SetRotation 
-Config, HasValue, "​Value?",​ orxCOMMAND_VAR_TYPE_BOOL,​ 2, 0, {"​Section",​ orxCOMMAND_VAR_TYPE_STRING},​ {"​Key",​ orxCOMMAND_VAR_TYPE_STRING});​ +Camera.SetZoom 
-Config, GetValue, "​Value",​ orxCOMMAND_VAR_TYPE_STRING,​ 2, 1, {"​Section",​ orxCOMMAND_VAR_TYPE_STRING},​ {"​Key",​ orxCOMMAND_VAR_TYPE_STRING},​ {"​[Index = -1]", orxCOMMAND_VAR_TYPE_S32});​ +Clock.SetFrequency 
-Config, SetValue, "​Value",​ orxCOMMAND_VAR_TYPE_STRING,​ 3, 0, {"​Section",​ orxCOMMAND_VAR_TYPE_STRING},​ {"​Key",​ orxCOMMAND_VAR_TYPE_STRING},​ {"​Value",​ orxCOMMAND_VAR_TYPE_STRING});​ +Clock.SetModifier 
-Config, GetListCounter,​ "​Counter",​ orxCOMMAND_VAR_TYPE_S32,​ 2, 0, {"​Section",​ orxCOMMAND_VAR_TYPE_STRING},​ {"​Key",​ orxCOMMAND_VAR_TYPE_STRING});​ +Command.Add 
-Locale, SelectLanguage,​ "​Language",​ orxCOMMAND_VAR_TYPE_STRING,​ 1, 0, {"​Language",​ orxCOMMAND_VAR_TYPE_STRING});​ +Command.AddAlias 
-Locale, GetCurrentLanguage,​ "​Language",​ orxCOMMAND_VAR_TYPE_STRING,​ 0, 0); +Command.And 
-Locale, SetString, "​Key",​ orxCOMMAND_VAR_TYPE_STRING,​ 2, 0, {"​Key",​ orxCOMMAND_VAR_TYPE_STRING},​ {"​String",​ orxCOMMAND_VAR_TYPE_STRING});​ +Command.AreEqual 
-Locale, GetString, "​String",​ orxCOMMAND_VAR_TYPE_STRING,​ 1, 0, {"​Key",​ orxCOMMAND_VAR_TYPE_STRING});​ +Command.Clamp 
-Screenshot, Capture, "​File",​ orxCOMMAND_VAR_TYPE_STRING,​ 0, 0); +Command.Compare 
-Input, SelectSet, "​Set",​ orxCOMMAND_VAR_TYPE_STRING,​ 1, 0, {"​Set",​ orxCOMMAND_VAR_TYPE_STRING});​ +Command.CRC 
-InputGetCurrentSet, "​Set",​ orxCOMMAND_VAR_TYPE_STRING,​ 0, 0); +Command.Divide 
-Input, SetValue, "Input", orxCOMMAND_VAR_TYPE_STRING,​ 2, 1, {"Input", orxCOMMAND_VAR_TYPE_STRING},​ {"​Value",​ orxCOMMAND_VAR_TYPE_FLOAT},​ {"​Permanent = false",​ orxCOMMAND_VAR_TYPE_BOOL});​ +Command.Evaluate 
-InputResetValue, "Input", orxCOMMAND_VAR_TYPE_U64,​ 1, 0, {"​Input",​ orxCOMMAND_VAR_TYPE_STRING});​ +Command.EvaluateIf 
-Input, GetValue, "​Value",​ orxCOMMAND_VAR_TYPE_FLOAT,​ 1, 0, {"​Input",​ orxCOMMAND_VAR_TYPE_STRING});​ +Command.Exit 
-MouseGetPosition, "​Position",​ orxCOMMAND_VAR_TYPE_VECTOR,​ 0, 0); +Command.GetClipboard 
-MouseSetPosition, "​Position",​ orxCOMMAND_VAR_TYPE_VECTOR,​ 1, 0, {"​Position",​ orxCOMMAND_VAR_TYPE_VECTOR});​ +Command.GetStringFromID 
-MouseShowCursor, "​Shown",​ orxCOMMAND_VAR_TYPE_BOOL,​ 1, 0, {"​Shown",​ orxCOMMAND_VAR_TYPE_BOOL});​ +Command.GetStringID 
-Object, Create, "Object", orxCOMMAND_VAR_TYPE_U64,​ 1, 0, {"​Name",​ orxCOMMAND_VAR_TYPE_STRING});​ +Command.Help 
-Object, Delete, "Object", orxCOMMAND_VAR_TYPE_U64,​ 1, 0, {"​Object",​ orxCOMMAND_VAR_TYPE_U64});​ +Command.If 
-Object, GetID, "​Object",​ orxCOMMAND_VAR_TYPE_U64,​ 1, 0, {"​Object",​ orxCOMMAND_VAR_TYPE_U64});​ +Command.IsGreater 
-Object, SetPosition,​ "​Object",​ orxCOMMAND_VAR_TYPE_U64,​ 2, 1, {"​Object",​ orxCOMMAND_VAR_TYPE_U64},​ {"​Position",​ orxCOMMAND_VAR_TYPE_VECTOR},​ {"​Global = false",​ orxCOMMAND_VAR_TYPE_BOOL});​ +Command.IsLesser 
-Object, SetRotation,​ "​Object",​ orxCOMMAND_VAR_TYPE_U64,​ 2, 1, {"​Object",​ orxCOMMAND_VAR_TYPE_U64},​ {"​Rotation",​ orxCOMMAND_VAR_TYPE_FLOAT},​ {"​Global = false",​ orxCOMMAND_VAR_TYPE_BOOL});​ +Command.ListAliases 
-Object, SetScale, "​Object",​ orxCOMMAND_VAR_TYPE_U64,​ 2, 1, {"​Object",​ orxCOMMAND_VAR_TYPE_U64},​ {"​Scale",​ orxCOMMAND_VAR_TYPE_VECTOR},​ {"​Global = false",​ orxCOMMAND_VAR_TYPE_BOOL});​ +Command.ListCommands 
-Object, GetPosition,​ "​Position",​ orxCOMMAND_VAR_TYPE_VECTOR,​ 1, 1, {"​Object",​ orxCOMMAND_VAR_TYPE_U64},​ {"​Global = false",​ orxCOMMAND_VAR_TYPE_BOOL});​ +Command.LogAllStructures 
-Object, GetRotation,​ "​Rotation",​ orxCOMMAND_VAR_TYPE_FLOAT,​ 1, 1, {"​Object",​ orxCOMMAND_VAR_TYPE_U64},​ {"​Global = false",​ orxCOMMAND_VAR_TYPE_BOOL});​ +Command.Maximum 
-Object, GetScale, "​Scale",​ orxCOMMAND_VAR_TYPE_VECTOR,​ 1, 1, {"​Object",​ orxCOMMAND_VAR_TYPE_U64},​ {"​Global = false",​ orxCOMMAND_VAR_TYPE_BOOL});​ +Command.Minimum 
-Object, SetSpeed, "​Object",​ orxCOMMAND_VAR_TYPE_U64,​ 2, 1, {"​Object",​ orxCOMMAND_VAR_TYPE_U64},​ {"​Speed",​ orxCOMMAND_VAR_TYPE_VECTOR},​ {"​Relative = false",​ orxCOMMAND_VAR_TYPE_BOOL});​ +Command.Multiply 
-Object, SetAngularVelocity,​ "​Object",​ orxCOMMAND_VAR_TYPE_U64,​ 2, 0, {"​Object",​ orxCOMMAND_VAR_TYPE_U64},​ {"​AngularVelocity",​ orxCOMMAND_VAR_TYPE_FLOAT});​ +Command.Normalize 
-Object, SetCustomGravity,​ "​Object",​ orxCOMMAND_VAR_TYPE_U64,​ 2, 0, {"​Object",​ orxCOMMAND_VAR_TYPE_U64},​ {"​CustomGravity",​ orxCOMMAND_VAR_TYPE_VECTOR});​ +Command.Not 
-Object, GetSpeed, "​Speed",​ orxCOMMAND_VAR_TYPE_VECTOR,​ 1, 1, {"​Object",​ orxCOMMAND_VAR_TYPE_U64},​ {"​Relative = false",​ orxCOMMAND_VAR_TYPE_BOOL});​ +Command.Or 
-Object, GetAngularVelocity,​ "​AngularVelocity",​ orxCOMMAND_VAR_TYPE_FLOAT,​ 1, 0, {"​Object",​ orxCOMMAND_VAR_TYPE_U64});​ +Command.RemoveAlias 
-ObjectGetCustomGravity, "​CustomGravity",​ orxCOMMAND_VAR_TYPE_VECTOR,​ 1, 0, {"Object", orxCOMMAND_VAR_TYPE_U64});​ +Command.Repeat 
-Object, SetText, "Object", orxCOMMAND_VAR_TYPE_U64,​ 2, 0, {"​Object",​ orxCOMMAND_VAR_TYPE_U64},​ {"​Text",​ orxCOMMAND_VAR_TYPE_STRING});​ +Command.Return 
-Object, GetText, "​Text",​ orxCOMMAND_VAR_TYPE_STRING,​ 1, 0, {"Object", orxCOMMAND_VAR_TYPE_U64});​ +Command.SetClipboard 
-ObjectGetName, "​Name",​ orxCOMMAND_VAR_TYPE_STRING,​ 1, 0, {"Object", orxCOMMAND_VAR_TYPE_U64});​ +Command.Subtract 
-Object, SetLifeTime,​ "Object", orxCOMMAND_VAR_TYPE_U64,​ 2, 0, {"Object", orxCOMMAND_VAR_TYPE_U64},​ {"​LifeTime",​ orxCOMMAND_VAR_TYPE_FLOAT});​ +Command.Version 
-Object, GetLifeTime,​ "​LifeTime",​ orxCOMMAND_VAR_TYPE_FLOAT,​ 1, 0, {"Object", orxCOMMAND_VAR_TYPE_U64});​ +Command.XOr 
-Object, SetColor, "Object", orxCOMMAND_VAR_TYPE_U64,​ 2, 0, {"Object", orxCOMMAND_VAR_TYPE_U64},​ {"​Color",​ orxCOMMAND_VAR_TYPE_VECTOR});​ +Config.AppendValue 
-Object, GetColor, "​Color",​ orxCOMMAND_VAR_TYPE_VECTOR,​ 1, 0, {"Object", orxCOMMAND_VAR_TYPE_U64});​ +Config.ClearSection 
-Object, SetAlpha, "Object", orxCOMMAND_VAR_TYPE_U64,​ 2, 0, {"Object", orxCOMMAND_VAR_TYPE_U64},​ {"​Alpha",​ orxCOMMAND_VAR_TYPE_FLOAT});​ +Config.ClearValue 
-Object, GetAlpha, "​Alpha",​ orxCOMMAND_VAR_TYPE_FLOAT,​ 1, 0, {"​Object",​ orxCOMMAND_VAR_TYPE_U64});​ +Config.CreateSection 
-Object, Enable, "Object", orxCOMMAND_VAR_TYPE_U64,​ 2, 1, {"​Object",​ orxCOMMAND_VAR_TYPE_U64},​ {"​Enable",​ orxCOMMAND_VAR_TYPE_BOOL},​ {"​Recursive = false",​ orxCOMMAND_VAR_TYPE_BOOL});​ +Config.GetCurrentSection 
-ObjectPause, "Object", orxCOMMAND_VAR_TYPE_U64,​ 2, 1, {"Object", orxCOMMAND_VAR_TYPE_U64},​ {"​Pause",​ orxCOMMAND_VAR_TYPE_BOOL},​ {"​Recursive = false",​ orxCOMMAND_VAR_TYPE_BOOL});​ +Config.GetListCount 
-Object, SetParent, "​Object",​ orxCOMMAND_VAR_TYPE_U64,​ 1, 1, {"​Object",​ orxCOMMAND_VAR_TYPE_U64},​ {"​Parent = <​void>",​ orxCOMMAND_VAR_TYPE_U64});​ +Config.GetOrigin 
-Object, Attach, "Object", orxCOMMAND_VAR_TYPE_U64,​ 1, 1, {"​Object",​ orxCOMMAND_VAR_TYPE_U64},​ {"​Parent = <​void>",​ orxCOMMAND_VAR_TYPE_U64});​ +Config.GetParent 
-Object, Detach, "​Object",​ orxCOMMAND_VAR_TYPE_U64,​ 1, 0, {"​Object",​ orxCOMMAND_VAR_TYPE_U64});​ +Config.GetRawValue 
-Object, SetOwner, "​Object",​ orxCOMMAND_VAR_TYPE_U64,​ 1, 1, {"​Object",​ orxCOMMAND_VAR_TYPE_U64},​ {"​Owner = <​void>",​ orxCOMMAND_VAR_TYPE_U64});​ +Config.GetValue 
-Object, GetOwner, "​Owner",​ orxCOMMAND_VAR_TYPE_U64,​ 1, 0, {"​Object",​ orxCOMMAND_VAR_TYPE_U64});​ +Config.HasSection 
-Object, GetOwnedChild,​ "Owned Child",​ orxCOMMAND_VAR_TYPE_U64,​ 1, 0, {"​Object",​ orxCOMMAND_VAR_TYPE_U64});​ +Config.HasValue 
-Object, GetOwnedSibling,​ "Owned Sibling",​ orxCOMMAND_VAR_TYPE_U64,​ 1, 0, {"​Object",​ orxCOMMAND_VAR_TYPE_U64});​ +Config.Load 
-Object, AddTrack, "​Object",​ orxCOMMAND_VAR_TYPE_U64,​ 2, 0, {"​Object",​ orxCOMMAND_VAR_TYPE_U64},​ {"​TimeLine",​ orxCOMMAND_VAR_TYPE_STRING});​ +Config.Reload 
-Object, RemoveTrack,​ "​Object",​ orxCOMMAND_VAR_TYPE_U64,​ 2, 0, {"​Object",​ orxCOMMAND_VAR_TYPE_U64},​ {"​TimeLine",​ orxCOMMAND_VAR_TYPE_STRING});​ +Config.Save 
-Object, AddFX, "​Object",​ orxCOMMAND_VAR_TYPE_U64,​ 2, 0, {"​Object",​ orxCOMMAND_VAR_TYPE_U64},​ {"​FX",​ orxCOMMAND_VAR_TYPE_STRING});​ +Config.SetParent 
-Object, RemoveFX, "​Object",​ orxCOMMAND_VAR_TYPE_U64,​ 2, 0, {"​Object",​ orxCOMMAND_VAR_TYPE_U64},​ {"​FX",​ orxCOMMAND_VAR_TYPE_STRING});​ +Config.SetValue 
-Object, AddShader, "​Object",​ orxCOMMAND_VAR_TYPE_U64,​ 2, 0, {"​Object",​ orxCOMMAND_VAR_TYPE_U64},​ {"​Shader",​ orxCOMMAND_VAR_TYPE_STRING});​ +Console.Echo 
-Object, RemoveShader,​ "​Object",​ orxCOMMAND_VAR_TYPE_U65,​ 2, 0, {"​Object",​ orxCOMMAND_VAR_TYPE_U64},​ {"​Shader",​ orxCOMMAND_VAR_TYPE_STRING});​ +Console.Enable 
-Object, AddSound, "​Object",​ orxCOMMAND_VAR_TYPE_U64,​ 2, 0, {"​Object",​ orxCOMMAND_VAR_TYPE_U64},​ {"​Sound",​ orxCOMMAND_VAR_TYPE_STRING});​ +Console.Log 
-Object, RemoveSound,​ "​Object",​ orxCOMMAND_VAR_TYPE_U64,​ 2, 0, {"​Object",​ orxCOMMAND_VAR_TYPE_U64},​ {"​Sound",​ orxCOMMAND_VAR_TYPE_STRING});​ +Console.SetColor 
-Object, SetVolume, "​Object",​ orxCOMMAND_VAR_TYPE_U64,​ 2, 0, {"​Object",​ orxCOMMAND_VAR_TYPE_U64},​ {"​Volume",​ orxCOMMAND_VAR_TYPE_FLOAT});​ +Input.EnableSet 
-ObjectSetPitch, "Object", orxCOMMAND_VAR_TYPE_U64,​ 2, 0, {"Object", orxCOMMAND_VAR_TYPE_U64},​ {"​Pitch",​ orxCOMMAND_VAR_TYPE_FLOAT});​ +Input.GetCurrentSet 
-Object, SetAnim, "Object", orxCOMMAND_VAR_TYPE_U64,​ 2, 1, {"Object", orxCOMMAND_VAR_TYPE_U64},​ {"​Anim",​ orxCOMMAND_VAR_TYPE_STRING},​ {"​Current = false",​ orxCOMMAND_VAR_TYPE_BOOL});​ +Input.GetValue 
- +Input.HasNewStatus 
-/** Variable type enum +Input.IsActive 
- */ +Input.IsSetEnabled 
-typedef enum __orxCOMMAND_VAR_TYPE_t +Input.ResetValue 
-{ +Input.SelectSet 
-  ​orxCOMMAND_VAR_TYPE_STRING = 0, +Input.SetValue 
-  ​orxCOMMAND_VAR_TYPE_FLOAT,​ +Locale.GetCurrentLanguage 
-  ​orxCOMMAND_VAR_TYPE_S32,​ +Locale.GetString 
-  ​orxCOMMAND_VAR_TYPE_U32,​ +Locale.SelectLanguage 
-  ​orxCOMMAND_VAR_TYPE_S64,​ +Locale.SetString 
-  ​orxCOMMAND_VAR_TYPE_U64,​ +Mouse.GetPosition 
-  ​orxCOMMAND_VAR_TYPE_BOOL,​ +Mouse.SetCursor 
-  ​orxCOMMAND_VAR_TYPE_VECTOR,​ +Mouse.SetPosition 
- +Mouse.ShowCursor 
-  ​orxCOMMAND_VAR_TYPE_NUMBER,​ +Object.AddFX 
- +Object.AddShader 
-  ​orxCOMMAND_VAR_TYPE_NONE = orxENUM_NONE +Object.AddSound 
- +Object.AddTrack 
-} orxCOMMAND_VAR_TYPE;​ +Object.Attach 
- +Object.Create 
- +Object.Delete 
-/** Variable definition structure +Object.Detach 
- */ +Object.Enable 
-typedef struct __orxCOMMAND_VAR_DEF_t +Object.FindNext 
-{ +Object.GetAlpha 
-  ​orxSTRING ​            ​zName; ​                       /**< Name : 4 */ +Object.GetAngularVelocity 
-  ​orxCOMMAND_VAR_TYPE ​  ​eType; ​                       /**< Type : 8 */ +Object.GetChild 
- +Object.GetClock 
-} orxCOMMAND_VAR_DEF;​ +Object.GetColor 
- +Object.GetCount 
-/** Variable structure */ +Object.GetCustomGravity 
-typedef struct __orxCOMMAND_VAR_t +Object.GetGroup 
-{ +Object.GetHSL 
-  union +Object.GetHSV 
-  { +Object.GetID 
-    ​orxVECTOR ​          ​vValue; ​                      /​**<​ Vector value : 12 */ +Object.GetLifeTime 
-    const orxSTRING ​    ​zValue; ​                      /​**<​ String value : 4 */ +Object.GetName 
-    ​orxU32 ​             u32Value; ​                    /​**<​ U32 value : 4 */ +Object.GetOrigin 
-    ​orxS32 ​             s32Value; ​                    /​**<​ S32 value : 4 */ +Object.GetOwnedChild 
-    ​orxU64 ​             u64Value; ​                    /​**<​ U64 value : 8 */ +Object.GetOwnedSibling 
-    ​orxS64 ​             s64Value; ​                    /​**<​ S64 value : 8 */ +Object.GetOwner 
-    ​orxFLOAT ​           fValue; ​                      /​**<​ Float value : 4 */ +Object.GetParent 
-    ​orxBOOL ​            ​bValue; ​                      /​**<​ Bool value : 4 */ +Object.GetPivot 
-  }; +Object.GetPosition 
- +Object.GetRepeat 
-  ​orxCOMMAND_VAR_TYPE ​  ​eType; ​                       /**< Type : 16 */ +Object.GetRGB 
- +Object.GetRotation 
-} orxCOMMAND_VAR;​ +Object.GetScale 
- +Object.GetSibling 
-/** Command function type */ +Object.GetSize 
-typedef void (orxFASTCALL *orxCOMMAND_FUNCTION)(orxU32 _u32ArgNumber,​ const orxCOMMAND_VAR *_astArgList,​ orxCOMMAND_VAR *_pstResult);​ +Object.GetSpeed 
- +Object.GetText 
- +Object.IsEnabled 
-/** Command registration helpers +Object.IsPaused 
- */ +Object.Pause 
-#define orxCOMMAND_REGISTER_CORE_COMMAND(MODULE,​ COMMAND, RESULT_NAME,​ RESULT_TYPE,​ REQ_PARAM_NUMBER,​ OPT_PARAM_NUMBER, ​...)                                \ +Object.Play 
-do                                                                                                                                                          \ +Object.RemoveFX 
-{                                                                                                                                                           \ +Object.RemoveShader 
-  ​orxCOMMAND_VAR_DEF ​ stResult; ​                                                                                                                            \ +Object.RemoveSound 
-  orxCOMMAND_VAR_DEF ​ astParamList[REQ_PARAM_NUMBER + OPT_PARAM_NUMBER + 1] = {__VA_ARGS__}; ​                                                               \ +Object.RemoveTrack 
-  orxSTATUS ​          ​eStatus; ​                                                                                                                             \ +Object.SetAlpha 
-  stResult.eType    = RESULT_TYPE; ​                                                                                                                         \ +Object.SetAngularVelocity 
-  ​stResult.zName    = RESULT_NAME; ​                                                                                                                         \ +Object.SetAnim 
-  ​eStatus ​          = orxCommand_Register(#​MODULE"​."#​COMMAND,​ orx##​MODULE##​_Command##​COMMAND,​ +Object.SetAnimFrequency 
-                      ​REQ_PARAM_NUMBER,​ OPT_PARAM_NUMBER,​ astParamList,​ &​stResult);​ \ +Object.SetClock 
-  orxASSERT(eStatus != orxSTATUS_FAILURE); ​                                                                                                                 \ +Object.SetColor 
-} while(orxFALSE)+Object.SetCustomGravity 
 +Object.SetGroup 
 +Object.SetHSL 
 +Object.SetHSV 
 +Object.SetLifeTime 
 +Object.SetOrigin 
 +Object.SetOwner 
 +Object.SetParent 
 +Object.SetPitch 
 +Object.SetPivot 
 +Object.SetPosition 
 +Object.SetRepeat 
 +Object.SetRGB 
 +Object.SetRotation 
 +Object.SetScale 
 +Object.SetSize 
 +Object.SetSpeed 
 +Object.SetText 
 +Object.SetVolume 
 +Object.Stop 
 +Render.GetScreenPosition 
 +Render.GetWorldPosition 
 +Resource.AddStorage 
 +Resource.GetPath 
 +Resource.GetTotalPendingOpCount 
 +Resource.Locate 
 +Resource.ReloadStorage 
 +Resource.RemoveStorage 
 +Screenshot.Capture 
 +Sound.GetBusChild 
 +Sound.GetBusParent 
 +Sound.GetBusPitch 
 +Sound.GetBusSibling 
 +Sound.GetBusVolume 
 +Sound.SetBusParent 
 +Sound.SetBusPitch 
 +Sound.SetBusVolume 
 +Texture.Create 
 +Texture.Delete 
 +Texture.Find 
 +Texture.GetLoadCount 
 +Texture.GetName 
 +Texture.GetSize 
 +Texture.Save 
 +Viewport.AddShader 
 +Viewport.Create 
 +Viewport.Delete 
 +Viewport.Enable 
 +Viewport.EnableShader 
 +Viewport.Get 
 +Viewport.GetCamera 
 +Viewport.GetID 
 +Viewport.GetName 
 +Viewport.GetPosition 
 +Viewport.GetRelativeSize 
 +Viewport.GetSize 
 +Viewport.IsEnabled 
 +Viewport.IsShaderEnabled 
 +Viewport.RemoveShader 
 +Viewport.SetBlendMode 
 +Viewport.SetCamera 
 +Viewport.SetPosition 
 +Viewport.SetRelativePosition 
 +Viewport.SetRelativeSize 
 +Viewport.SetSize
  
-#define orxCOMMAND_UNREGISTER_CORE_COMMAND(MODULE,​ COMMAND) ​                                                                                                \ 
-do                                                                                                                                                          \ 
-{                                                                                                                                                           \ 
-  orxCommand_Unregister(#​MODULE"​."#​COMMAND); ​                                                                                                               \ 
-} while(orxFALSE) 
 </​code>​ </​code>​
  
Line 230: 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 (5 weeks ago) by sausage