Skip to content

Conditions

Conditions

Conditions are used to determine if a Script or other element can run, sometimes paired with an Interaction. They are leveraged in Commands as well as in Entity Scripts. You may recognize them from other programs or programming languages as the elements that get tested in an 'if statement.'

Conditions are 'evaluated,' which means the engine checks for that condition before executing the script.

! Example: An example of a Conditional would be a door that's locked. A condition on the door can check for the key's presence in the player's inventory - and only then will the script run and the door open!

Conditions

Any

Any conditions evaluate to true when at least one of the contained conditions is true.

Properties

System

Name Explanation Type
Conditions The conditions to evaluate. Condition

Character in Party

Character in Party conditions validate that a character is present in the active or inactive party.

Properties

System

Name Explanation Type
Active Party Whether to check if the character is in the active party. Toggle
Character Reference The referenced character in the database. Character
Inactive Party Whether to check if the character is in the inactive party. Toggle

Entity Direction

Entity Direction conditions validate the direction an entity is or is not facing.

Properties

System

Name Explanation Type
Direction The direction. Direction
Is Not Direction Whether the condition should be inverted. Toggle

Global Reference Switch

Global Reference Switch conditions validate a Reference Switch is or is not set.

Note: The Index is pulled from the Global Variables as well as the actual value.

Properties

System

Name Explanation Type
Comparison Global Switch Index The index of the Global Switch to compare to, if valid. Number
Comparison Local Switch Index The index of the Local Switch to compare to, if valid. Number
Index The index of the switch. Number
Value The value to compare to. Toggle

Global Reference Variable

Global Reference Variable conditions validate the value in a Reference Variable.

Note: The Index is pulled from the Global Variables as well as the actual value.

Properties

System

Name Explanation Type
Comparison Global Variable Index The index of the Global Variable to compare to, if valid. Number
Comparison Local Variable Index The index of the Local Variable to compare to, if valid. Number
Index The index of the variable. Number
Operator The type of comparison to make. Operator
Value The value to compare against. Variable

Global Switch

Global Switch conditions validate the value in a global switch.

Properties

System

Name Explanation Type
Comparison Global Switch Index The index of the Global Switch to compare to, if valid. Number
Comparison Local Switch Index The index of the Local Switch to compare to, if valid. Number
Index The index of the switch. Number
Value The value to compare to. Toggle

Global Variable

Global Variable conditions validate the value in a global variable.

Properties

System

Name Explanation Type
Comparison Global Variable Index The index of the Global Variable to compare to, if valid. Number
Comparison Local Variable Index The index of the Local Variable to compare to, if valid. Number
Index The index of the variable. Number
Operator The type of comparison to make. Operator
Value The value to compare against. Variable

Hero Direction

Hero Direction conditions validate the direction the leader of the party is or is not facing.

Properties

System

Name Explanation Type
Direction The direction. Direction
Is Not Direction Whether the condition should be inverted. Toggle

Item Exists

Item Exists conditions validate that an item or equipment is contained in the inventory.

Note: This is an expensive condition and can only be used in Commands.

Properties

System

Name Explanation Type
Equipment Whether the condition is looking for a piece of equipment, rather than an item. Toggle
Equipment or Item Reference The reference item or equipment in the database. Item or Equipment
Item Whether the condition is looking for an item. Toggle
Quantity The quantity of item or equipment needed. Number

Local Reference Switch

Local Reference Switch conditions validate a Reference Switch is or is not set.

Note: The Index is pulled from the Local Variables, while the actual value is pulled from Global Switches.

Properties

System

Name Explanation Type
Comparison Global Switch Index The index of the Global Switch to compare to, if valid. Number
Comparison Local Switch Index The index of the Local Switch to compare to, if valid. Number
Index The index of the switch. Number
Value The value to compare to. Toggle

Local Reference Variable

Local Reference Variable conditions validate the value in a Reference Variable.

Note: The Index is pulled from the Local Variables, while the actual value is pulled from Global Variables.

Properties

System

Name Explanation Type
Comparison Global Variable Index The index of the Global Variable to compare to, if valid. Number
Comparison Local Variable Index The index of the Local Variable to compare to, if valid. Number
Index The index of the variable. Number
Operator The type of comparison to make. Operator
Value The value to compare against. Variable

Local Switch

Local Switch conditions validate the value in a local switch.

Properties

System

Name Explanation Type
Comparison Global Switch Index The index of the Global Switch to compare to, if valid. Number
Comparison Local Switch Index The index of the Local Switch to compare to, if valid. Number
Index The index of the switch. Number
Value The value to compare to. Toggle

Local Variable

Local Variable conditions validate the value in a local variable.

Properties

System

Name Explanation Type
Comparison Global Variable Index The index of the Global Variable to compare to, if valid. Number
Comparison Local Variable Index The index of the Local Variable to compare to, if valid. Number
Index The index of the variable. Number
Operator The type of comparison to make. Operator
Value The value to compare against. Variable

Money

Money conditions validate the currently held money against a value.

Properties

System

Name Explanation Type
Comparison Global Variable Index The index of the Global Variable to compare to, if valid. Number
Comparison Local Variable Index The index of the Local Variable to compare to, if valid. Number
Operand The type of comparison to make. Operator
Value The value to compare against. Number

Random Value

Random Value conditions validate a randomly generated number, specified by a minimum and maximum value, against another variable or value.

Properties

System

Name Explanation Type
Comparison Global Variable Index The index of the Global Variable to compare to, if valid. Number
Comparison Local Variable Index The index of the Local Variable to compare to, if valid. Number
Index The index of the variable. Number
Maximum Value The maximum value to generate. Number
Minimum Value The minimum value to generate. Number
Operator The type of comparison to make. Operator
Value The value to compare against. Variable

Scene

Scene conditions validate whether the current scene matches a particular scene type.

Properties

System

Name Explanation Type
Not Current Scene Whether to check if the scene is not the current scene. Toggle
Scene The scene. Scene

Tile Tag Collision

Tile Tag Collision conditions validate that the container of the script is interacting with a particular Tile Tag.

Properties

System

Name Explanation Type
Tile Tag The referenced tile tag in the database. Tile Tag