System actions
All system actions can be accessed via the icon on the bottom of the widgets toolbar. Just drag and drop an action onto the canvas.
|
Name |
Action |
|---|---|
|
GetFilename |
Returns the filename of the control panel |
|
GetCurrentRegion |
Returns the current region |
|
GetReadFromMachine |
Returns the machine this control panel is served from |
|
GetReadFromLevelPath |
Returns the level path of the level running on the read from machine |
|
GetReadEngine |
Returns the name of the read from machine |
|
GetSendToGroup |
Returns the name of the send to group |
|
GetSendToGroupEnginesList |
Returns the names of the machines in the send to group |
|
SetRegion |
Switches to a specified region |
|
SetKeyerPreset |
Applies a video keyer preset
|
|
SetAdjustmentPreset |
Applies an adjustment panel preset
|
|
ResetAdjustmentPreset |
Resets an adjustment panel preset |
|
SetReadEngine |
Changes the read from machine The send to group might change as well, as they always have to include the read from machine. |
|
SetSendToGroup |
Changes the send to group The read from machine might change as well, as it always has to be included in the send to machines. |
|
SetReadSendToGroup |
Change read from machine and send to group at the same time |
|
ViewportShot |
Requests a snapshot from the Engine viewport and displays it on an image widget |
|
GetVideoIOImage |
Requests a snapshot form the videoIO service. Requires pipeline and nodeIDs. |
|
OpenTab |
Opens a URL in a new tab |
|
InvokeURL |
Calls a URL without opening a tab |
|
CopyToClipboard |
Copies a value to the clipboard |
|
FocusOn |
Sets the focus on a specified widget |
|
ShowToast |
Shows a message in a toast notification |
|
Debug |
Sends a message to the console |
|
Alert |
Triggers a browser alert |
|
DynamicData |
Allows to subscribe to various data queries. Learn more about how to Use dynamic data in control panel |
|
StartupActions |
Triggers all actions inside System > STARTUP ACTIONS |
Supported target property types
All values are auto-parsed into the most suitable JavaScript type!
To force a value to stay String wrap them in quotes:
-
1234 >
Number -
'1234' >
String-
Not supported within API Calls (Code Editor)
-
-
'00123' >
String(leading zeros prevent conversion) -
'true' >
Boolean(case-insensitive) -
'[1, 2, 3]' >
List/Array -
'{"a": true}' OR '{"a": {"b": "true"}}' >
Object -
NaN →
0 -
undefined →
null
|
Property type |
Source |
Related UE5 type names |
|---|---|---|
|
|
|
bool |
|
|
any float or integer number |
byte, integer, integer64, float |
|
|
any text string |
FName, FString, FText |
|
|
any |
Enums (any type starting with U and ending with *) |
|
|
|
FColor FLinearColor |
|
|
|
Transform |
|
|
|
FVector |
|
|
Custom properties with their respective property types Every argument can be controlled separately |
|
|
|
|
- |