Conditions¶

A condition is a requirement that gates an Action. When the Action would normally complete, its conditions are checked first: if they are all satisfied the Action performs as usual, otherwise the Action is held back (or failed).

Conditions never drive an Action. They only decide whether the Action is allowed to perform when its own interaction has already been fulfilled. For example, an Insert Action still needs the user to insert the object; a condition can additionally require that it happened within a time limit.

Adding a condition¶

Every Action node has a conditions button in its header. Pressing it opens the Conditions panel, which lists the conditions of that Action and offers an Add condition dropdown with every available condition type. Press X on a row to remove it.

Each row is a foldout, titled with the condition’s Description (or its type name when the description is empty).

Common parameters¶

All conditions share the following parameters, drawn at the top of the row:

The rest of the parameters depend on the condition type.

Possible outcomes¶

When an Action has several conditions, all of them are checked and the worst outcome wins - so multiple conditions behave like a logical AND. The condition that produced that worst outcome is the one whose description is shown to the user.

Below is a table that describes each possible outcome when combining results from conditions to illustrate this:

Lifecycle¶

Built-in conditions¶

Writing your own condition¶

Derive from ConditionData, mark it [System.Serializable], and override the stages you need. Your public serialized fields appear in the Conditions panel automatically, and the type shows up in the Add condition dropdown with a human readable name (ConditionData is stripped and the remaining words are split, so MyToolIsCleanConditionData becomes My Tool Is Clean).

using MAGES;
using UnityEngine;

[System.Serializable]
public class UserIsCrouchingConditionData : ConditionData
{
    [Tooltip("The height, in meters, below which the user counts as crouching.")]
    [SerializeField]
    public float maxHeight = 1.2f;

    // Data gives you the Action this condition is attached to.
    public override bool Check()
    {
        return Camera.main.transform.position.y < maxHeight;
    }
}