---
generated_by: gdlink-build
generated_at: 2026-06-23T12:34:28Z
do_not_edit: true
title: State
brick_type: executor
tier: Basic
generated: true
---

# 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

```{raw} html
<div class="illustration-container"><div class="illustration-box"><div class="box-header">As added to your scene</div><img src="https://gdlink.solventech.ca/guide/assets/images/bricks/state_executor.png" alt="State brick as it appears in the GDLink editor" loading="lazy" style="max-width:100%;height:auto;display:block;margin:0 auto;border-radius:8px;" /></div></div>
```

## 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`)

```{raw} html
<div class="illustration-container">
        <div class="illustration-box">
            <div class="box-header">Generated UI Mockup — showing expanded properties</div>
            <div class="real-node brick-executor">
                <div class="real-header">
                    <div class="real-title"><span class="brick-icon-fallback"></span> <span>State</span></div>
                    <div class="real-controls"><div class="real-checkbox"></div><div class="real-btn">-</div><div class="real-btn">x</div></div>
                </div>
                <div class="real-inner-panel"><div class="real-row name-row" style="position:relative;"><span class="real-label">Name:</span><div class="real-input" style="color:#666; font-style:italic;">Label this brick...</div><div class="real-port" style="left:-15px;"></div></div><div class="real-row"><span class="real-label">Mode:</span><div class="real-input-dropdown">Set State</div></div><div class="real-row"><span class="real-label">State Index:</span><div class="real-inline-input" style="border-bottom: 1px solid #2f333b;"><span>0</span></div><div class="real-val-btn" style="margin-left:4px;">v</div></div></div>
            </div>
        </div>
    </div>
```

## Properties

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