StateMachineMenuAttribute

Description

Marks a static method as a contributor to the state machine view's right-click contextual menu. Every time the menu opens, the decorated method is invoked with a StateMachineMenuContext that exposes the element under the cursor and lets the method append entries via MenuContext.AppendAction.

The decorated method must be static, return void, and take a single StateMachineMenuContext parameter. The user is responsible for filtering on the clicked element and deciding what to append. The handler is invoked when the active state machine's type matches the listed type or derives from it. Apply the attribute multiple times on the same method to register it for several state machine types. MenuContext.ClickedObject is the element under the cursor: an IState, an ITransition or an IPort. A subgraph state is an ISubgraphState, which derives from IState. The value is null when the click landed on empty space or on an element that is not exposed through the public API. To contribute entries to the graph view, use GraphMenuAttribute. For the blackboard, use BlackboardMenuAttribute. For the condition list of a transition inspector, use ConditionMenuAttribute.

 [StateMachineMenu(typeof(MyStateMachine))]
 static void AppendStateMachineItems(StateMachineMenuContext context)
 {
     context.AppendAction("Custom/State Machine", () => Debug.Log(context.StateMachine));

     if (context.ClickedObject is IState state)
         context.AppendAction("Custom/State", () => Debug.Log(state));

     if (context.ClickedObject is ITransition transition)
         context.AppendAction("Custom/Transition", () => Debug.Log(transition));
 }

Properties

Constructors