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!
Any allows for multiple conditions to be present, and will be considered true if any of the contained conditions are true.
| Name | Explanation | Type |
|---|---|---|
| Conditions | The conditions to evaluate. | Condition |
Character in Party validates that a character is present in the active or inactive party.
| Name | Explanation | Type |
|---|---|---|
| Active Party | Whether or not to check if the character is in the active party. | Toggle |
| Inactive Party | Whether or not to check if the character is in the inactive party. | Toggle |
| Character Reference | The referenced character in the database. | Character |
Entity Direction validates the direction an entity is or is not facing.
| Name | Explanation | Type |
|---|---|---|
| Direction | The direction. | Direction |
| Is Not Direction | Whether or not the condition should be inverted. | Toggle |
Global Reference Switch validates a Reference Switch is or is not set.
Note: The Index is pulled from the Global Variables as well as the actual value.
| 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 validates the value in a Reference Variable.
Note: The Index is pulled from the Global Variables as well as the actual value.
| 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 validates the value in a global switch.
| 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 validates the value in a global variable.
| 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 validates the direction the leader of the party is or is not facing.
| Name | Explanation | Type |
|---|---|---|
| Direction | The direction. | Direction |
| Is Not Direction | Whether or not the condition should be inverted. | Toggle |
Item Exists validates that an item or equipment is contained in the inventory.
Note: This is an expensive condition and can only be used in Commands.
| Name | Explanation | Type |
|---|---|---|
| Equipment | Whether or not the condition is looking for a piece of equipment, rather than an item. | Toggle |
| Item | Whether or not the condition is looking for an item. | Toggle |
| Quantity | The quantity of item or equipment needed. | Number |
| Equipment or Item Reference | The reference item or equipment in the database. | Item or Equipment |
Local Reference Switch validates 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.
| 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 validates the value in a Reference Variable.
Note: The Index is pulled from the Local Variables, while the actual value is pulled from Global Variables.
| 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 validates the value in a local switch.
| 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 validates the value in a local variable.
| 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 validates the currently held money against a value.
| 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 validates a randomly generated number, specified by a minimum and maximum value, against another variable or value.
| Name | Explanation | Type |
|---|---|---|
| Maximum Value | The maximum value to generate. | Number |
| Minimum Value | The minimum value to generate. | Number |
| 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 |
Scene validates if the current scene is or is not of a particular scene type.
| Name | Explanation | Type |
|---|---|---|
| Not Current Scene | Whether or not to check if the scene is not the current scene. | Toggle |
| Scene | The scene. | Scene |
Tile Tag validates that the container of the script is interacting with a particular Tile Tag.
| Name | Explanation | Type |
|---|---|---|
| Tile Tag | The referenced tile tag in the database. | Tile Tag |