Variables are used to store information in a running game.
The variables overview is found in Editor > Variables.
Variable change templates are found in Editor > Variable Change Templates.
Variable condition templates are found in Editor > Variable Condition Templates.
What are Variables? #
Variables store information that can be used in your game, e.g. as conditions or to track progress of the game’s changes.
A variable consists of 2 parts:
- Key
The key (or name) of the variable is used to identify it.
This is always a string value (text). - Value
The value of the variable stores the information.
Variable Key #
The variable key is a string value (text), each key can have one value of each value type and a list of each value type.
You can define a variable key at any time and any place in your project. They don’t need to be pre-defined to be available.
Value Types #
The following value types are available for variables.
Bool #
A boolean value, either true or false.
The default value is false.
Double #
A floating point value (e.g. 1.5).
The default value is 0.
Long #
A whole number value (e.g. 8).
The default value is 0.
String #
A text.
The default value is an empty text.
Vector 3 #
A vector 3 value with 3 float value axes (X, Y, and Z).
You can often also access the different axes of a Vector 3 variable directly using Vector 3 Axis value types.
The default value is X=0, Y=0, Z=0.
Adding Custom Value Types #
You can add custom value types via scripting by adding multiple new classes extending from different variable base classes. Please refer to the source code to learn how the built-in variables are added. The built-in value types where added the same way.
Changing Variables #
Variables are changed using a Change Variables node most of the time, but there are a lot of other nodes that can change variables.
Beside changing variables in schematics, formulas or battle AIs through nodes, you can also change them at other times, e.g. using the Local Start Variables of machine components or the Initial Variables defined in the system settings.
Variable Change Templates #
You can create templates for variable changes if you often need the same changes in different schematics and other places.
Variable change templates are found in Editor > Variable Change Templates. They can be used in any place variables can be changed.
Getting and Checking Variables #
Variables can be used in most places of ORK, wherever a value type selection is available.
Checking variables is usually done in a Check Variables node, but can also be done in other nodes and in other parts of ORK, e.g. general conditions.
Variable Condition Templates #
You can create templates for variable conditions that are often used in your setup.
Variable condition templates are found in Editor > Variable Condition Templates. They can be used in any place variables can be checked.
Saving #
By default, variables are saved with save games – this can be changed in the save game settings. When variables are saved, you can optionally exclude defined variable keys from being saved. When not saving variables, you can optionally include variable keys to be saved.
Variable Origin #
The origin of a variable defines where it’s stored and how it can be accessed. There are 4 different variable origins – when dealing with variables (e.g. changing them, checking them or using their values), you’ll always need to select the origin.
Local #
Local variables are only available in a local context, e.g. a playing schematic or calculating formula. They’re best used for short lived information, like counting something within a schematic’s run or storing temporary values for use later in the schematic. Local variables can’t be saved with save games.
A crucial mechanic is sharing local variables between schematics and formulas (or schematics and other schematics started by them) that are started/used by each other – this allows passing on information and doing different things depending on where they’re started from.
E.g. an ability being animated by schematics will share local variables with all it’s schematics and all it’s formulas being used for status change calculations.
Changes made in a schematic will be available to any schematic or formula used afterwards.
Global #
Global variables are available everywhere and at any time – they’re persistent in the running game, i.e. they’ll be available in all machines/schematics, formulas and other parts of ORK. Global variables can be saved with save games.
Since global variables are persistent, you can use them to store information that needs to be remembered for longer periods of time, like a switch that was flipped by the player or remembering if the player talked to a specific NPC.
Object #
Object variables are bound to objects in your scene by an Object ID. Like global variables, they’re available everywhere and at any time. They can be saved with save games.
However, object variables don’t require an object in the scene and can be accessed by their Object ID instead. This e.g. allows to set up scene-based variables by using the scene name as object ID.
Object variables can be accessed either via an object or their object ID.
Object Variables Component #
Binding object variables to an object is done by adding an Object Variables component to the object. When objects share the same Object ID in their object variable components, they’ll share the same variables.
Optionally, the component can be set to be used in a local mode by enabling Local Variables. When used as local variables, the object variables are only available as long as the object exists and can’t be shared between objects.
Selected #
Variables can also be stored in selected data. The actual variables used by selected data are still coming from one of the other 3 origins (local, global or object).
Lists #
Beside storing single values into a variable, you can also add multiple values to a variable list. Lists are available for local, global and object variables.
If you want to use a list for storing or getting variables, this is also selected in the variable origin – e.g. to access a local variable list, select Local List instead of Local.
Adding to Lists #
When adding a value to a variable list, you can add it at different positions (index) of the list:
- Add
The value will be added at the end of the list. - Insert
The value will be inserted at a defined position.
Values at that position or later will be moved back by one position. - Set
The value will be set at a defined position.
A value currently at that position will be replaced.
If the list is currently not as long as the defind position, it will be filled up with default values (e.g. empty string, false, 0). - Random
The value will be set at a random position in the list.
A value currently at that position will be replaced. - Last
The value will be set at the last position in the list (i.e. the list wont grow).
The last value will be replaced by the new value.
This can be done e.g. using a Change Variables node.
Getting from Lists #
When getting a value from a variable list, you can get it from different positions (index) of the list:
- Index
The value will be taken from a defined position. - Random
The value will be taken from a random position. - Last
The value will be taken from the last position (i.e. the end of the list).
You can optionally remove the value from the list when getting it. This can be done wherever variables are used, e.g. in a Check Variables node.
Removing from Lists #
To remove values from a list, or a whole list, use a Change Variables node and enable Remove. When removing, the list change selection that’s used to add will be used to determine which position (index) will be removed:
- Add
The whole list is removed. - Insert
The value of the defined position will be removed. - Set
The value of the defined position will be removed. - Random
The value of a random position will be removed. - Last
The value of the last position will be removed (i.e. the end of the list).
Variable Overview #
The variables overview is found in Editor > Variables.
The overview allows you to see all variables used in your project and where they’re used.
Replace Variable Key #
You can replace variable keys throughout the project by defining the old key and the new key that should be used.
Define Variables #
You can optionally define variable keys that will be available in variable key selections.
This is not needed, though. You can define new keys wherever variable keys are defined.
Editor Variables #
Lists variables used in settings that are displayed by the ORK editor.
Scene Variables #
Lists variables used in your game’s scenes.
Prefab Variables #
Lists variables that are part of a prefab’s component setup.
Schematic Variables #
Lists variables used in your schematics.

