UI Actuators

14 UI-specific actuator bricks detected in the addon.

◷ 13 min read Phase 5 enhanced

Source of truth This page lists only bricks registered by the uploaded addon. Legacy aliases and compatibility script shims are not presented as separate menu entries.

Chapter guide

Building UI actions

UI actuators work with Control-based interfaces and are listed in the same flat menu structure used by the addon.

Select the relevant UI node.
Choose the action that changes or controls the interface.
Trigger it from input, variables, signals, or other sensors.

UI WORKFLOW

UI Setup and Actuators

Use this section for Control-based interfaces. Unlike the longer 3D and 2D lists, the addon intentionally displays compatible UI actuators as one flat menu.

Select a Control node

Select a Control, Button, Label, Slider, ProgressBar, TabContainer, Window, or another supported UI node.

Open Logic Bricks

The addon keeps sensors and controllers available, but filters actuators to the UI-compatible set.

Target interface nodes

Many UI actuators can act on the selected node or locate another interface node by name, depending on the brick.

Build interaction chains

Connect input or UI sensors to controllers and then to focus, text, visibility, popup, slider, tab, window, or other UI actions.

How this relates to the menu

The UI actuator menu is flat by design, so this page uses one linked actuator reference rather than artificial submenus.

FLAT RIGHT-CLICK MENU

UI Actuator Reference

These entries appear directly under Actuators when a supported UI node is selected.

actuator • ui

2D Audio

Plays UI or 2D audio.

Menu Add Logic Brick → Actuators

Source


         actuators/ui/audio_2d_actuator.gd

Options

Property	Details
`mode`	Mode Choices: Play,Stop,Pause,Fade In,Fade Out Default: `play`
`sound_file`	Sound File Choices: .wav,.ogg,*.mp3
`player_type`	Player Type Choices: AudioStreamPlayer,AudioStreamPlayer2D Default: `stream_player`
`play_mode`	Play Mode Choices: Restart,Overlap,Ignore If Playing Default: `restart`
`volume`	Volume Choices: -80,24,0.1 Default: `0.0`
`pitch`	Pitch Choices: 0.01,4.0,0.01 Default: `1.0`
`pitch_random`	Pitch Random Choices: 0.0,1.0,0.01 Default: `0.0`
`loop`	Loop Default: `false`
`audio_bus`	Audio Bus
`fade_duration`	Fade Duration Choices: 0.1,10.0,0.1 Default: `1.0`

Using this brick

Typical uses

Perform the ui action described above after a sensor / controller chain succeeds.
Reuse the brick in multiple states or chains with different option values.
Pair it with an appropriate sensor to control when the action occurs.

Example chain

Choose a sensor Controller 2D Audio

Tip Test the actuator with the simplest possible sensor first, then add variables, timing, or additional conditions.

Common mistake A continuously active sensor may run this actuator every frame. Use a one-shot condition when the action should happen only once.

2D Audio screenshot placeholder — **2D Audio screenshot**

actuator • ui

Button

Triggers, toggles, presses, or releases a Button node.

Menu Add Logic Brick → Actuators

Source


         actuators/ui/button_actuator.gd

Options

Property	Details
`target_node_name`	Target Node Name Default: `self` self or Button node name
`action`	Action Choices: Emit Pressed,Press,Release,Toggle Default: `emit_pressed`

Using this brick

Typical uses

Perform the ui action described above after a sensor/controller chain succeeds.
Reuse the brick in multiple states or chains with different option values.
Target a specific node by configuring the node field before testing the chain.

Example chain

Choose a sensor Controller Button

Tip Confirm the target node name and node type before troubleshooting the rest of the chain.

Common mistake A continuously active sensor may run this actuator every frame. Use a one-shot condition when the action should happen only once.

Button screenshot placeholder — **Button screenshot**

actuator • ui

Focus

Grabs or releases keyboard/gamepad focus on a Control node.

Menu Add Logic Brick → Actuators

Source


         actuators/ui/focus_actuator.gd

Options

Property	Details
`target_node_name`	Target Node Name Default: `self` self or Control node name
`action`	Action Choices: Grab Focus,Release Focus Default: `grab_focus`

Using this brick

Typical uses

Perform the ui action described above after a sensor/controller chain succeeds.
Reuse the brick in multiple states or chains with different option values.
Target a specific node by configuring the node field before testing the chain.

Example chain

Choose a sensor Controller Focus

Tip Confirm the target node name and node type before troubleshooting the rest of the chain.

Common mistake A continuously active sensor may run this actuator every frame. Use a one-shot condition when the action should happen only once.

Focus screenshot placeholder — **Focus screenshot**

actuator • ui

Modulate

Sets or transitions color/alpha on a Control or CanvasItem node.

Menu Add Logic Brick → Actuators

Source


         actuators/ui/modulate_actuator.gd

Options

Property	Details
`target_node_name`	Target Node Name
`node_name_source`	Node Name Source Choices: Literal Node Name,String Variable Default: `literal`
`export_node_name`	Export Node Name Default: `false`
`target_modulate`	Target Modulate Choices: Self Modulate,Modulate Default: `self_modulate`
`color`	Color Default: `Color(1`
`transition`	Transition Default: `false`
`transition_speed`	Transition Speed Default: `5.0`

Using this brick

Typical uses

Perform the ui action described above after a sensor/controller chain succeeds.
Reuse the brick in multiple states or chains with different option values.
Target a specific node by configuring the node field before testing the chain.

Example chain

Choose a sensor Controller Modulate

Tip Confirm the target node name and node type before troubleshooting the rest of the chain.

Common mistake Timing options change how long the action takes; avoid retriggering the same transition every frame unless that behavior is intentional.

Modulate screenshot placeholder — **Modulate screenshot**

actuator • ui

Popup

Shows, hides, toggles, or centers a Popup/Window-like UI node.

Menu Add Logic Brick → Actuators

Source


         actuators/ui/popup_actuator.gd

Options

Property	Details
`target_node_name`	Target Node Name Default: `self` Popup node name
`action`	Action Choices: Show,Hide,Toggle,Popup Centered Default: `show`

Using this brick

Typical uses

Perform the ui action described above after a sensor/controller chain succeeds.
Reuse the brick in multiple states or chains with different option values.
Target a specific node by configuring the node field before testing the chain.

Example chain

Choose a sensor Controller Popup

Tip Confirm the target node name and node type before troubleshooting the rest of the chain.

Common mistake A continuously active sensor may run this actuator every frame. Use a one-shot condition when the action should happen only once.

actuator • ui

Progress Bar

Sets the value, min, or max of a ProgressBar, Slider, or Range UI node.

Menu Add Logic Brick → Actuators

Source


         actuators/ui/progress_bar_actuator.gd

Options

Property	Details
`target_node_name`	Target Node Name Default: `ProgressBar`
`node_name_source`	Node Name Source Choices: Literal Node Name,String Variable Default: `literal`
`export_node_name`	Export Node Name Default: `false`
`set_value`	Set Value Default: `true`
`value`	Value Default: `100.0`
`set_min`	Set Min Default: `false`
`min_value`	Min Value Default: `0.0`
`set_max`	Set Max Default: `false`
`max_value`	Max Value Default: `100.0`
`transition`	Transition Default: `false`
`transition_speed`	Transition Speed Default: `5.0`

Using this brick

Typical uses

Perform the ui action described above after a sensor/controller chain succeeds.
Reuse the brick in multiple states or chains with different option values.
Target a specific node by configuring the node field before testing the chain.

Example chain

Choose a sensor Controller Progress Bar

Tip Confirm the target node name and node type before troubleshooting the rest of the chain.

Common mistake Timing options change how long the action takes; avoid retriggering the same transition every frame unless that behavior is intentional.

Progress Bar screenshot placeholder — **Progress Bar screenshot**

actuator • ui

Screen Flash

Flashes a full-screen ColorRect overlay.

Menu Add Logic Brick → Actuators

Source


         actuators/ui/screen_flash_actuator.gd

Options

Property	Details
`color`	Color Default: `Color(1`
`duration`	Duration Default: `0.3`
`fade_in`	Fade In Default: `0.05`

Using this brick

Typical uses

Perform the ui action described above after a sensor/controller chain succeeds.
Reuse the brick in multiple states or chains with different option values.
Pair it with an appropriate sensor to control when the action occurs.

Example chain

Choose a sensor Controller Screen Flash

Tip Test the actuator with the simplest possible sensor first, then add variables, timing, or additional conditions.

Common mistake Timing options change how long the action takes; avoid retriggering the same transition every frame unless that behavior is intentional.

Screen Flash screenshot placeholder — **Screen Flash screenshot**

actuator • ui

Scroll

Sets or adds to a ScrollContainer scroll position.

Menu Add Logic Brick → Actuators

Source


         actuators/ui/scroll_actuator.gd

Options

Property	Details
`target_node_name`	Target Node Name Default: `self` ScrollContainer node name
`mode`	Mode Choices: Set,Add Default: `set`
`axis`	Axis Choices: Vertical,Horizontal,Both Default: `vertical`
`x`	X Default: `0`
`y`	Y Default: `0`

Using this brick

Typical uses

Perform the ui action described above after a sensor/controller chain succeeds.
Reuse the brick in multiple states or chains with different option values.
Target a specific node by configuring the node field before testing the chain.

Example chain

Choose a sensor Controller Scroll

Tip Confirm the target node name and node type before troubleshooting the rest of the chain.

Common mistake A continuously active sensor may run this actuator every frame. Use a one-shot condition when the action should happen only once.

Scroll screenshot placeholder — **Scroll screenshot**

actuator • ui

Slider

Sets or adds to a Slider or Range value.

Menu Add Logic Brick → Actuators

Source


         actuators/ui/slider_actuator.gd

Options

Property	Details
`target_node_name`	Target Node Name Default: `self` Slider node name
`mode`	Mode Choices: Set,Add Default: `set`
`value`	Value Default: `0.0`

Using this brick

Typical uses

Perform the ui action described above after a sensor/controller chain succeeds.
Reuse the brick in multiple states or chains with different option values.
Target a specific node by configuring the node field before testing the chain.

Example chain

Choose a sensor Controller Slider

Tip Confirm the target node name and node type before troubleshooting the rest of the chain.

Common mistake A continuously active sensor may run this actuator every frame. Use a one-shot condition when the action should happen only once.

Slider screenshot placeholder — **Slider screenshot**

actuator • ui

Tab

Changes the active tab on a TabContainer.

Menu Add Logic Brick → Actuators

Source


         actuators/ui/tab_actuator.gd

Options

Property	Details
`target_node_name`	Target Node Name Default: `self` TabContainer node name
`action`	Action Choices: Set,Next,Previous Default: `set`
`tab_index`	Tab Index Default: `0`

Using this brick

Typical uses

Perform the ui action described above after a sensor/controller chain succeeds.
Reuse the brick in multiple states or chains with different option values.
Target a specific node by configuring the node field before testing the chain.

Example chain

Choose a sensor Controller Tab

Tip Confirm the target node name and node type before troubleshooting the rest of the chain.

Common mistake A continuously active sensor may run this actuator every frame. Use a one-shot condition when the action should happen only once.

Tab screenshot placeholder — **Tab screenshot**

actuator • ui

Text

Updates a Label, RichTextLabel, or other text UI node.

Menu Add Logic Brick → Actuators

Source


         actuators/ui/text_actuator.gd

Options

Property	Details
`target_node_name`	Target Node Name Default: `Label`
`node_name_source`	Node Name Source Choices: Literal Node Name,String Variable Default: `literal`
`export_node_name`	Export Node Name Default: `false`
`mode`	Mode Choices: Variable,Static Default: `variable`
`variable_name`	Variable Name
`prefix`	Prefix
`suffix`	Suffix
`static_text`	Static Text

Using this brick

Typical uses

Perform the ui action described above after a sensor/controller chain succeeds.
Reuse the brick in multiple states or chains with different option values.
Target a specific node by configuring the node field before testing the chain.

Example chain

Choose a sensor Controller Text

Tip Confirm the target node name and node type before troubleshooting the rest of the chain.

Common mistake A continuously active sensor may run this actuator every frame. Use a one-shot condition when the action should happen only once.

Text screenshot placeholder — **Text screenshot**

actuator • ui

Tween

Tweens a UI node property.

Menu Add Logic Brick → Actuators

Source


         actuators/ui/tween_actuator.gd

Options

Property	Details
`target_mode`	Target Mode Choices: Self,Node Default: `self`
`target_node_name`	Target Node Name
`node_name_source`	Node Name Source Choices: Literal Node Name,String Variable Default: `literal`
`export_node_name`	Export Node Name Default: `false`
`property`	Property Default: `modulate:a`
`target_value`	Target Value Default: `0.0`
`duration`	Duration Default: `0.5`
`trans_type`	Trans Type Choices: Linear,Sine,Quint,Quart,Quad,Expo,Elastic,Bounce,Back,Spring,Circular,Cubic Default: `linear`
`ease_type`	Ease Type Choices: In,Out,In Out,Out In Default: `in_out`
`loop`	Loop Default: `false`

Using this brick

Typical uses

Perform the ui action described above after a sensor/controller chain succeeds.
Reuse the brick in multiple states or chains with different option values.
Target a specific node by configuring the node field before testing the chain.

Example chain

Choose a sensor Controller Tween

Tip Confirm the target node name and node type before troubleshooting the rest of the chain.

Common mistake Timing options change how long the action takes; avoid retriggering the same transition every frame unless that behavior is intentional.

Tween screenshot placeholder — **Tween screenshot**

actuator • ui

Visibility

Shows, hides, or toggles a UI node.

Menu Add Logic Brick → Actuators

Source


         actuators/ui/visibility_actuator.gd

Options

Property	Details
`target_node_name`	Target Node Name Default: `self` Node name
`action`	Action Choices: Show,Hide,Toggle Default: `show`

Using this brick

Typical uses

Perform the ui action described above after a sensor/controller chain succeeds.
Reuse the brick in multiple states or chains with different option values.
Target a specific node by configuring the node field before testing the chain.

Example chain

Choose a sensor Controller Visibility

Tip Confirm the target node name and node type before troubleshooting the rest of the chain.

Common mistake A continuously active sensor may run this actuator every frame. Use a one-shot condition when the action should happen only once.

Visibility screenshot placeholder — **Visibility screenshot**

actuator • ui

Window

Shows, hides, toggles, or centers a Window node.

Menu Add Logic Brick → Actuators

Source


         actuators/ui/window_actuator.gd

Options

Property	Details
`target_node_name`	Target Node Name Default: `self` Window node name
`action`	Action Choices: Show,Hide,Toggle,Popup Centered Default: `show`

Using this brick

Typical uses

Perform the ui action described above after a sensor/controller chain succeeds.
Reuse the brick in multiple states or chains with different option values.
Target a specific node by configuring the node field before testing the chain.

Example chain

Choose a sensor Controller Window

Tip Confirm the target node name and node type before troubleshooting the rest of the chain.

Common mistake A continuously active sensor may run this actuator every frame. Use a one-shot condition when the action should happen only once.

Window screenshot placeholder — **Window screenshot**

← Previous Previous 2D Actuators Next → Next Debugging

UI Actuators

Building UI actions

UI Setup and Actuators

Select a Control node

Open Logic Bricks

Target interface nodes

Build interaction chains

UI Actuator Reference

2D Audio

Options

Typical uses

Example chain

Related bricks

Button

Options

Typical uses

Example chain

Related bricks

Focus

Options

Typical uses

Example chain

Related bricks

Modulate

Options

Typical uses

Example chain

Related bricks

Popup

Options

Typical uses

Example chain

Related bricks

Progress Bar

Options

Typical uses

Example chain

Related bricks

Screen Flash

Options

Typical uses

Example chain

Related bricks

Scroll

Options

Typical uses

Example chain

Related bricks

Slider

Options

Typical uses

Example chain

Related bricks

Tab

Options

Typical uses

Example chain

Related bricks

Text

Options

Typical uses

Example chain

Related bricks

Tween

Options

Typical uses

Example chain

Related bricks

Visibility

Options

Typical uses

Example chain

Related bricks

Window

Options

Typical uses

Example chain

Related bricks