ORK 4 RPG Framework Logo
  • ORK 4 GUIDE
    • Documentation
    • Tutorials
    • Extensions
    • API
  • ORK 3 GUIDE
    • Documentation
    • Tutorials
    • API
  • Support
  • Forum
  • Get ORK

ORK 4 Documentation

  • Getting Started
    • Welcome
    • First Steps (Unity)
  • Features
    • The Status System
    • Schematics
    • Schematic Nodes
    • Dialogue Importer
    • Variables
    • Selected Data
  • Components
    • Battle Components
    • Combatant Components
    • Control Components
    • Cursor Prefab Components
    • Game Starters
    • Interactable Components
    • Move AI Components
    • Scene Setup Components
  • Editor
    • The ORK 4 Editor
    • Sections & Sub-Sections
    • Node Editor
    • Schematic Editor
    • Asset Sources
    • Unity Overlay Toolbar
  • Section: System
    • System Settings
    • Languages
    • Organizer Types
    • Game States & Conditions
    • General Condition Templates
    • Object Pools
    • Prefab Savers
    • Scene Connections
  • Section: Controls
    • Game Controls
    • Interaction Settings
    • Player Controls
    • Camera Controls
    • Input Keys
    • Control Maps
    • Camera Positions
    • Battle Camera
  • Section: Gameplay
    • Game Settings
    • Formulas
    • Difficulties
    • Shortcut Slots & Settings
    • Custom Settings & Global Custom Settings
    • Global Machines
    • Machine Templates
  • Section: Status
    • Status Values
    • Status Effects
    • Attack Modifiers
    • Defence Modifiers
    • Abilities & Ability Developments
    • Status Developments
    • Research Trees
    • Damage Types
    • Status Bonuses & Templates
    • Status Condition Templates
  • Section: Inventory
    • Inventory Settings
    • Inventory Containers
    • Currencies
    • Items
    • AI Rulesets
    • Crafting Recipes
    • Equipment Slots & Slot Set Templates
    • Equipment & Available Equipment Templates
    • Shops
    • Loot
  • Section: Combatants
    • Combatants
    • Combatant Groups
    • Class Slots
    • Classes
    • Factions & Faction Benefits
    • Animations
    • Move AIs
    • Formations
    • Action Combos
  • Section: Battles
    • Battle Systems
    • Turn Based Battles
    • Active Time Battles
    • Real Time Battles
    • Phase Battles
    • Battle Spots
    • Battle AIs
    • Battle Actions Settings
    • Special Commands Settings
    • Target Settings
    • Target Selection Templates
    • Battle Range Templates
    • Battle Grid Settings
    • Battle Grid Highlights
    • Battle Grid Cell Types
    • Battle Grid Formations
  • Section: Content
    • Content Types
    • Music
    • Sound Templates
    • Areas
    • Teleports
    • Quests & Quest Tasks
    • Logs & Log Texts
    • Object Contents
  • Section: UI
    • UI Settings
    • UI Layers
    • UI Layouts
    • UI Boxes
    • HUDs
    • Notifications
    • Cursor Settings
  • Section: Menus
    • Start Menu
    • Save Game Settings
    • Option Categories
    • Menu Screens
    • Menu Requirements
    • Battle Menus
    • Loot Dialogues
    • Item Collection
    • Combatant Selections
    • Quantity Selections
    • Shop Layouts
  • Section: Texts
    • Text Settings
    • Formatting Settings
    • Flying Texts
    • Use Cost Display
    • Status Preview Display
    • Bonus Display
    • Status Change Display
    • Console Settings & Console Types
    • Text Codes
  • Sections: Editor
    • Editor Settings
    • Backups
    • Variables
    • Plugins
  • Scripting
    • Access Handler
    • Custom Nodes
    • Custom Save Data
    • Custom Component Save Data

ORK 4 Tutorials

  • ORK 4 Unity Quickstart Tutorials (3D)
    • ORK 4 Unity Quickstart 3D
    • 01 Initial ORK Setup
    • 02 Player Setup
    • 03 Music & Scenes
    • 04 UI System Setup
    • 05 UI Boxes
    • 06 Flying Texts
    • 07 Status Values
    • 08 Status Effects
    • 09 First Abilities
    • 10 Fighter Setup
    • 11 First Enemies & Battle AI
    • 12 Battle System Setup
    • 13 Animating Battle Start and End
    • 14 Random Battles
    • 15 Animating Actions
    • 16 Player Battle HUD
    • 17 Elemental Attacks
    • 18 Animating More Actions
    • 19 Inventory & Loot
    • 20 Equipment
    • 21 Loot, Start Equipment & Viewers
    • 22 Magic Abilities
    • 23 Caster Setup
    • 24 More Enemies
    • 25 Start Menu & Save Games
    • 26 Menu Screens
    • 27 Interactions
    • 28 Item Collectors
    • Quickstart Extended
  • Battle Tutorials
    • Active Time Battles
    • Phase Battles
    • Real TT 01 Real Time Battles & Tab Targeting
    • Real TT 02 Control Map, Use Ranges & Battle Area
    • Real TT 03 Camera Control, Battle AI & Reuse Time
    • Real TT 04 Damage Detection, Action Animation & Player HUD
    • Real TT 05 Switch Player & Final Adjustments
    • Hit & Miss
    • Critical Hits
    • Cast Time
    • Reuse Time
    • Grid 01: Battle Grid Setup
    • Grid 02: Highlights
    • Grid 03: Cell Types
    • Grid 04: Move Command
    • Grid 05: Scene Grid Setup
    • Grid 06: Battle Ready
    • Grid 07 Use & Affect Ranges
    • Grid 08: Better Camera Control
  • Gameplay Tutorials
    • Multiple Interaction Controllers
    • Player Group Spawn & Follow
    • Spawn Hunting Enemies
    • Gamepad Controls (Unity Input System)
    • Combined Inputs
    • Control Map for Keyboard (Shortcuts)
    • Control Map for Gamepad (Shortcuts)
    • Quests 01: Menu Screen
    • Quests 02: Hunting
    • Quests 03: Collect Potion Materials
    • Quests 04: Collect Equipment Materials
    • Quests 05: Quest Mark HUDs
    • Crafting 01: Menu Screen
    • Crafting 02: Materials & Recipes
    • Crafting 03: Getting Materials
    • Crafting 04: Proficiency & Critical Outcome
    • Shop
    • Inventory Containers
  • Schematics Tutorials
    • UI Animation Schematics
    • Flying Text Animation Schematics
    • HUD Conditional Schematics
  • UI Tutorials
    • Unity UI: Initial Setup
    • Unity UI: Status Value UI Setup
    • Unity UI: Status Effect UI Setup
    • Unity UI: Shortcut UI Setup
    • Unity UI: Dragging Notification
    • Unity UI: Interaction HUD
    • Unity UI: Shortcut HUD
    • Unity UI: Turn Order HUD
    • Unity UI: Cast Time HUD
    • Unity UI: Quest HUD
    • Unity UI: Tooltip HUD
    • Unity UI: Move Range HUD
    • Menus 01 UI Box Setup
    • Menus 02 Template HUDs
    • Menus 03 Menu Setup
    • Menus 04 Main Menu
    • Menus 05 Inventory
    • Menus 06 Equipment
    • Menus 07 Ability
    • Menus 08 Group
    • Menus 09 Quest
    • Menus 10 Crafting
  • Module 01: Status System
    • Introduction to Modular Tutorials
    • M01.1: Status Values
      • Introduction to Status Values
      • Health
      • Mana
      • Barrier
      • Base Experience
      • Class Experience
      • Spendable Experience
      • Normal Stats
    • M01.2: Modifiers
      • Introduction to Modifiers
      • Element
      • Attack Type
      • Size
      • Race
    • M01.3: Status Effects
      • Introduction to Status Effects
      • Buffs
      • Debuffs
      • Poison
      • Regeneration
      • Blind
      • Stun
      • Sleep
      • Silence
      • Enchants
      • Charm
      • Doom
      • Reflect
  • Module 02: Actions
    • Introduction to Actions
    • M02.1: Formulas
      • Introduction to Formulas
      • Physical Damage Formula
      • Magical Damage Formula
      • Hit Chance
      • Critical Chance
    • M02.2: Abilities
      • Introduction to Abilities
      • Base Attack
      • Elemental Magic Spells
      • Steal Ability
      • Drain
      • Healing Spell
      • Cure
      • Buff Abilities
      • Debuff Abilities

ORK 4 Extensions

  • Plugins
    • Save Game Compression Plugin
  • Schematic Nodes
    • Footstepper Nodes (Unity)
  • Scripts
    • A* Pathfinding Movement Component (Unity)
    • PolyNav 2D Movement Component (Unity)
    • Cinemachine Camera Control Type (Unity)
    • Rewired Input Key (Unity)
    • Unity Legacy Input Key (Unity)
    • Core GameKit Wrapper (Unity)
    • Pool Boss Wrapper (Unity)
View Categories
  • Guide
  • ORK 4
  • ORK 4 Documentation
  • Features

Variables

0:00 / 8:29
  • View as Markdown Open this page as plain Markdown (opens in a new tab)
  • Open in ChatGPT Ask questions about this page (opens in a new tab)
  • Open in Claude Ask questions about this page (opens in a new tab)
  • Open in Google AI Studio Ask questions about this page (Google account required) (opens in a new tab)

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.

Table of Contents
  • What are Variables?
    • Variable Key
    • Value Types
      • Bool
      • Double
      • Long
      • String
      • Vector 3
      • Adding Custom Value Types
    • Changing Variables
      • Variable Change Templates
    • Getting and Checking Variables
      • Variable Condition Templates
    • Saving
  • Variable Origin
    • Local
    • Global
    • Object
      • Object Variables Component
    • Selected
  • Lists
    • Adding to Lists
    • Getting from Lists
      • Removing from Lists
  • Variable Overview
    • Replace Variable Key
    • Define Variables
    • Editor Variables
    • Scene Variables
    • Prefab Variables
    • Schematic Variables
Sitemap
  • Showcase
  • ORK 4 Guide
    • Documentation
    • Tutorials
    • Extensions
    • API
  • ORK 3 Guide
    • Documentation
    • Tutorials
    • API
  • ORK 2 Hub
    • Tutorials
    • Plugins
    • API
  • Support
  • Forum
  • Get ORK
  • Contact
  • Blog
  • Makinom
  • gamingislove.com
Categories
  • News (75)
  • ORK 2 (137)
    • Tutorial (137)
      • Game tutorial (50)
      • Gameplay (32)
      • How-to (55)
  • Release (158)
Search

© 2015 Gaming is Love e.U.

Disclosure: This site may contain affiliate links, which means I may receive a commission if you click a link and purchase something that I have recommended. While clicking these links won’t cost you any money, they will help me fund my development projects while recommending great assets!