Control panel - Widget and property types

Button (Trigger)

Sends predefined variables and/or event triggers when clicked

• on Click

• Perform click

-

• Trigger Blueprint events

  • Virtual camera moves

  • Actions/States

• Allows simple presets

  • Actor transform

  • Actor parameters

Button (Toggle)

(Same as button, with "Toggle" enabled)

Sends predefined values and/or event triggers when clicked

Shows current state

• on Click

• on ON click

• on OFF click

• Perform click

• Perform ON click

• Perform OFF click

button.Value

• 2-state trigger

• Useful for on/off actions

  • Light switches

  • A to B transitions

  • Visibility toggles

  • Any boolean

Tabs

Sends predefined values and/or event triggers when clicked

Shows current state

List of options can be manually set up or imported from a List property of an engine object - See Populate Options for Tab and Select widget

• on Click

• on Tab 1 click

• on Tab 2 click

• …

• Perform click

• Perform Tab 1 click

• Perform Tab 2 click

• …

tabs.Selected

• Allows for switching between predefined values (Number, String)

  • Infographics

  • Name fields

  • Title bars

Drop-down

Switches between predefined values and/or event triggers when clicked

Shows active option

List of options can be manually set up or imported from a List property of an engine object - See Populate Options for Tab and Select widget

• on Change

• Perform change

dropdown.Selected

• Same as Tabs

Slider

Sends a Number (float or integer) between a min and a max value

• on Change

• Perform change

slider.Value

• Control virtual lights

• Control physical lights

  • via DMX

• Control X/Y/Z dimensions of transforms

• Control color channels

• Any states you want to fade between

• Any number value you want to have interactive control over

Number

Sends a Number (float or integer) when field is changed, either by

• number entry closing with Enter

• clicking the arrows

• scrolling

• on Change

• Perform change

• Trigger Focus

number.Value

• Allows real-time operator numeric value updates

  • Scoreboards

  • Statistics

  • Data

• Trigger Blueprint events that take a numeric parameter

Text

Sends a String when the Enter key is pressed

Text can be typed or pasted in

• on Confirm

• Perform change

• Trigger Focus

input.Text

• Allows real-time operator entry for text and number fields

  • News tickers

  • Infographics

  • Name fields

  • Title bars

  • Scoreboards

• Trigger Blueprint events that take a text OR numeric parameter

Text (multiline)

Sends a String (including line breaks) when

• "Confirm" button is clicked

• Ctrl+Enter is pressed

Text can be typed or pasted

• on Confirm

• Perform change

• Trigger Focus

text.Text

• Same as Text

Color picker

Opens a color picker and while making changes it sends updates

• if confirmed, the color is kept

• if cancelled, the original color is sent again

• on Confirm

• Perform change

colorPick.Color

• Control light colors

Playlist

Executes actions in a sequence triggered manually or based on time

-

• Reset

• Play next

• Pause/Continue

• Start from index

• Pause at index

• Wait

Get

• Current Action Index

• Current Action Name

• Current Action Duration

• Current Action Progress

• Current Action Timer

• Up Next Index

• Up Next Name

• Overall Time Elapsed

• Get Count

-

• Control actions in a sequence

Timer

Triggers the actions with a constant interval

• on Timer

• Perform Interval

-

• Set up triggers with a constant interval

Listener

Listens to changes of the Source property

• on Change

• Perform Listener

-

• Listen to the change of any property

Label

Passive: text can be controlled by an action on another widget

Active: can actively listen to changes

• If active: on Change

• Perform Listener

label.Text

• Display values

• Use as independent label text with optional background color

• Control panel organization

Image

Passive: image source can be controlled by an action on another widget

Active: can actively listen to changes

Double click the image to bring up the resources library. Upload or choose an existing image.

Learn more about how to send images to the engine

• If active: on Change

• Perform Listener

image.Src

• Display images

  • from url

  • from local file system

• Send image URLs to the URLImageActor

• Control panel organization

Frame

Embed another website into the control panel

-

• Perform Listener

-

• Load other control panels

• Load help center articles

• Load external graphics

Group

Visually group widgets together

Passive

Click the header to move all widgets within the group

Double click the header to select all widgets and scale the group

-

If modal

• Trigger Show Modal

• Trigger Close Modal

-

• Control panel organization

• Can also be used as modal dialog

System actions

Get

• Filename

• Current region

• Read engine

• Send to engines

Trigger

• Set region

• Set read engine

• Set send to engine

• Set read/send to engine

• Open tab

• Invoke URL

• Focus on widget

Boolean

false | true as text string

bool

Number

any float or integer number

byte, integer, integer64, float

String

any text string

FName, FString, FText

List (Enum, Array, …)

any String

Enums (any type starting with U and ending with *)

Color

Color OR individual Numbers for

• Red

• Green

• Blue

• Alpha

FColor

Transform

Transform OR individual Numbers for

• Position XYZ

• Rotation XYZ

• Scale XYZ

Transform

Vector

Vector OR individual Numbers for

• XYZ

FVector

Function (Blueprint)

Custom properties with their respective property types

Every argument can be controlled separately

API Call

-