State

Category: Executor Tier: Basic

Purpose

Mutates the runtime’s 30-bit state mask so State Gates and state-filtered bricks activate on the correct channels.

Visual Reference

As added to your scene
State brick as it appears in the GDLink editor

Runtime Behavior

Inputs

  • Activate (Boolean): Applies the configured state operation once when triggered.

Properties

  • mode (Enum, Set State)

    • Set State: replace the entire active mask with the selected state bit

    • Add State: OR the selected state bit into the current mask

    • Remove State: clear the selected state bit from the current mask

    • Change State: legacy alias of Set State

  • state_index (Int, 0)

    • State slot to modify (0..29)

    • Editor UI shows this as a dropdown (state0 through state29) and includes saved custom state names when available, while persisting the same numeric index for runtime compatibility.

Generated UI Mockup — showing expanded properties
State
-
x
Name:
Label this brick...
Mode:
Set State
State:
0

Properties

This brick does not expose a generated property table yet. See the source specification for implementation notes.