Handling Variables

v1.0

There are multiple ways to interact with Playmaker Variables that are set on the graph.

Copy Playmaker Variables To Global Blackboard

Add a CopyPlaymakerVariablesToGlobalBlackboard component to any object, and you can populate multiple Playmaker Fsm objects. Each of those will have it's Variables copied to the global ActionBlackboard, where any object can reference them.

Variables are stored as a structure that also includes the fsm and GameObject that holds the Variable.

Blackboard keys are stored as "GameObjectName/FsmName/VariableName" so that multiple Fsm graphs can have Variables copied.

public readonly struct PlaymakerVariableEntry
{
    public GameObject Source { get; }
    public PlayMakerFSM Fsm { get; }
    public object Value { get; }

    public bool TryGet<T>(out T value)
    {
        if (Value is T t) { value = t; return true; }
        value = default!;
        return false;
    }
}

Getting Values

To get the value back, you have multiple options.

Cache the Key

// Cache the key once
private readonly string _speedKey 
    = BlackboardPlaymakerExtensions.PlaymakerKey("Player", "FSM", "Speed");

// Use it anywhere
public float Speed => blackboard.GetPlaymakerValue<float>(_speedKey);

// Try-pattern
if (blackboard.TryGetPlaymakerEntry<float>(_speedKey, out var speed)) { }

// Full entry (source + value)
if (blackboard.TryGetPlaymakerEntry(_speedKey, out var entry))
{
    entry.TryGet<float>(out var speed);
    var source = entry.Source;
}

// Key builder also has all three shapes// Static — no blackboard instance needed, useful for caching at field initialisation
private readonly string _speedKey = BlackboardPlaymakerExtensions.PlaymakerKey("Player", "FSM", "Speed");

// Extension — when you already have a blackboard in scope
var key = blackboard.PlaymakerKey("Player", "FSM", "Speed");
var key = blackboard.PlaymakerKey(gameObject, "FSM", "Speed");
var key = blackboard.PlaymakerKey(gameObject, fsm, "Speed");

Directly from Blackboard

// Get the value as an PlaymakerVariableEntry object
blackboard.TryGetPlaymakerEntry("Player", "FSM", "Speed", out var entry)

// Get the value as a float
blackboard.TryGetPlaymakerEntry<float>("Player", "FSM", "Speed", out var speed)

// Get the value as a float, default to 0f if it doesn't exist
blackboard.GetPlaymakerValue<float>("Player", "FSM", "Speed", defaultValue: 0f)

// GameObject + FSM name string
blackboard.TryGetPlaymakerEntry(gameObject, "FSM", "Speed", out var entry)
blackboard.GetPlaymakerValue<float>(gameObject, "FSM", "Speed")

// GameObject + PlayMakerFSM
blackboard.TryGetPlaymakerEntry(gameObject, fsm, "Speed", out var entry)
blackboard.TryGetPlaymakerEntry<float>(gameObject, fsm, "Speed", out var speed)
blackboard.GetPlaymakerValue<float>(gameObject, fsm, "Speed")

From a GameObject

GameObject go;

// From Global ActionBlackboard
go.GetPlaymakerValue<float>("FSM", "Speed") 
go.GetPlaymakerValue<float>(fsm, "Speed") 

// Or pass in an explicit (non-global) Blackboard, often from an ActionExecutor attached
// to the GameObject go
go.TryGetPlaymakerEntry(blackboard, fsm, "Speed", out var entry)
go.TryGetPlaymakerEntry(blackboard, "FSM", "Speed", out var entry)
go.GetPlaymakerValue<float>(blackboard, fsm, "Speed")

From a Fsm

// From Global ActionBlackboard
fsm.GetPlaymakerValue<float>("Speed")  
fsm.GetPlaymakerValue<float>("Speed", defaultValue: -1f)

// Or pass in an explicit (non-global) Blackboard, often from an ActionExecutor attached
// to the GameObject Fsm
fsm.TryGetPlaymakerEntry(blackboard, "Speed", out var entry)
fsm.TryGetPlaymakerEntry<float>(blackboard, "Speed", out var speed)
fsm.GetPlaymakerValue<float>("Speed", defaultValue: -1f)

Setting Variables

You can also set variables on the Playmaker fsm.

// Standard code for setting variables.
var fsm = GetComponent<PlayMakerFSM>();

// Find and set a float
var speedVar = fsm.FsmVariables.FindFsmFloat("Speed");
if (speedVar != null) speedVar.Value = 10f;

// Find and set a bool
var activeVar = fsm.FsmVariables.FindFsmBool("IsActive");
if (activeVar != null) activeVar.Value = true;

// Find and set a GameObject
var targetVar = fsm.FsmVariables.FindFsmGameObject("Target");
if (targetVar != null) targetVar.Value = someGameObject;

Setting with Actions

The SetPlaymakerVariableAction and SetPlaymakerVariableFromBlackboardAction will let you set a specific value. There are also Actions for incrementing float and int values, or toggling a bool value.

Set Playmaker Variable Action

In this Action, you can populate the Target FSM. If you do not provide a Target FSM, one will be found on the component and cached for future use. You also set the Variable Name.

You must also set the Variable Type, and then provide the value you'd like to set of the correct type.

Set Playmaker Variable From Blackboard Action

In this Action, you choose to use the Executor Blackboard (local) or the Global Blackboard as source. You also choose whether the source is a Playmaker Variable that you've already cached.

If so, you provide the Source FSM, and the Key (variable name). If you do not provide a Source FSM, one will be found on the component and cached for future use.

You must also set the Target FSM and the Target Variable Name. If you do not provide a Target FSM, one will be found on the component and cached for future use.

Increment Playmaker Float / Int Action

Use IncrementPlaymakerFloatAction or IncrementPlaymakerIntAction to add or subtract value to an int or float Playmaker variable. If you do not provide a Target FSM, one will be found on the component and cached for future use.

Toggle Playmaker Bool Value

This action will toggle the value of a bool in the Playmaker variable list. If you do not provide a Target FSM, one will be found on the component and cached for future use.