This device is affected by Contextual Filtering; This feature hides or displays options depending on the values selected for certain related options.
All default values have been Bolded.
General
Option
Value
Description
UI Type
Circular, Pulsing, Bar
Determines the type of user interface to display.
Widget Orientation
Vertical, Horizontal
Whether the meter draws horizontally or vertically.
Starts Enabled
Yes, No
Whether or not the device is enabled automatically.
UI
Option
Value
Description
Header Text
{ Custom Text }
Main text for interaction.
Description Text
{ Custom Text }
Secondary text for interaction.
Text Position
Top, Bottom, Left, Right
Position of text relative to the meter.
Custom Widget
None, Select a HUD Widget
Select a custom widget to use for the interaction.
Screen Anchor
Top Left, Top Center, Top Right, Center Left, Center, Center Right, Bottom Left, Bottom Center, Bottom Right, Center Full, Left Tall, Center Tall, Right Tall, Top Wide, Center Wide, Bottom Wide
Determines where on the screen the UI will align and anchors to.
Placement Horizontal
0.0, -5000.0 - 5000.0
Determines how far away from anchor the widget will be. Negative numbers move to the left.
Placement Vertical
0.0, -5000.0 - 5000.0
Determines how far away from anchor the widget will be. Negative numbers move upwards.
Background Color
#000000FF, Select a Color
Determines the color of the background.
Background Opacity
80.0, 0.0 - 100.0
Determines the opacity of the background as a percentage. If 0%, no background will be shown.
Background Corners Type
Round, Square
Determines the type of background corners to apply.
Hide HUD
Yes, No
If On, the HUD is when the interaction is active.
Interaction Label
Interact, { Custom Text }
Text label shown on the input panel.
Device
Option
Value
Description
Interaction Type
Normal, Charge and Release
the type of interaction for the device. Normal is automatic animation, and triggers upon button press. Charge and Release animates while holding down the button and triggers upon release.
Position Zone Randomly
Yes, No
Whether the good zone positions itself randomly.
Perfect Input Behavior
Instant Success, Count for Two, No Special Behavior
What should happen when a perfect input occurs.
Speed Up on Subsequent Interacts
0.0, 0.1 - 100.0
How much to speed up on subsequent interacts. Resets when the device is retriggered.
Shrink Zones on Subsequent Interacts
0.0, 0.1 - 100.0
How much to shrink the zone on subsequent interacts. Resets when the device is retriggered.
Success Target
1, 0 - 5
How many successful inputs are required for the minigame to complete.
Show Successes
Yes, No
Whether to draw the success counter on screen.
Success Counter Icon
Checkmark, Select an Icon
Determines the icon to use for the Success Target indicator.
Success Counter Color
#FFFFFFFF, Select a Color
Determines the color of the Success Target indicator.
Failure Limit
1, 0 - 5
How many times a bad input can be provided before failing the minigame.
Show Failures
Yes, No
Whether to draw the fail counter on screen.
Fail Counter Icon
X, Select an Icon
Determines the icon to use for the Fail Limit indicator
Fail Counter Color
#FFFFFFFF, Select a Color
Determines the color of the Fail Limit indicator
Clear Successes on Fail
Yes, No
If On, the interaction Success Count resets on a bad input.
Lock Out on Fail Time
1.0, 0.0 - 5.0
If a bad input is provided, the interact will lock for this long. Set to 0 to disable.
Meter
Option
Value
Description
Meter Thickness
40.0, 20.0 - 60.0
The thickness in pixels for the circular type.
Set Custom Size
Yes, No
If On, the meter will use the custom width and height as a main.
Meter Custom Size
300.0, 200.0 - 500.0
The height and width in pixels for the custom meter size.
Movement Type
Linear, PingPong, Wiggle
Different movement patterns for the meter.
Wiggle Time Min
0.5, 0.0 - 10.0
Minimum wiggle time before movement.
Wiggle Time Max
1.0, 0.0 - 10.0
Maximum wiggle time before movement.
Movement Speed
50.0, 1.0 - 400.0
How fast the meter moves across the interaction if percent per second.
Meter Color
#000F98FF, Select a Color
Determines the color of the meter.
Scrubber Color
#FFFFFFFF, Select a Color
Determines the color of the meter scrubber.
Zones
Option
Value
Description
Good Zone Size
50.0, 0.0 - 100.0
The size of the good zone as a perfect of the total meter.
Good Zone Position
50.0, 0.0 - 100.0
Position of the good zone.
Perfect Zone Size
25.0, 0.0 - 100.0
The size of the perfect zone as a perfect of the good zone.
Perfect Zone Position
50.0, 0.0 - 100.0
Position of the perfect zone.
Good Zone Color
#1B67FFFF, Select a Color
Determines the color of the good zone.
Perfect Zone Color
#08D8FDFF, Select a Color
Determines the color of the perfect zone.
Timer
Option
Value
Description
Interact Time Limit
0.0, 0.1 - 120.0
How long the player has to complete the interaction. Taking too long results in failure.
Show Timer
Yes, No
If On, the timer will display on screen.
Timer Position
Top, Bottom
Position of the timer.
Timer Color
#FFFFFFFF, Select a Color
Determines the color of the timer.
Timer Size
Normal, Large
What size the timer draws as.
Timer Background Type
None, Transparent, Opaque
Determines the transparency level of the timer background.
Requirements
Option
Value
Description
Allowed Team
Any, Team 1 - Team 100
Determines which Team can activate the device.
Allowed Class
Any, No Class, Class 1 - Class 254
Determines which Class can activate the device.
Invert Team Selection
Yes, No
If False, only the selected Team can activate the device. If True, all Teams except the selected Team can activate the device.
Invert Class Selection
Yes, No
If False, only the selected Class can activate the device. If True, all Classes except the selected Class can activate the device.
Sound
Option
Value
Description
Interact Complete Sound
SkilledInteract_Success_Cue, Select a Sound
Sound that plays when the minigame is completed successfully.
Interact Failure Sound
SkilledInteract_Fail_Cue, Select a Sound
Sound that plays when the minigame is completed unsuccessfully.
Interact Interrupted Sound
SkilledInteract_Fail_Cue, Select a Sound
Sound that plays when the minigame is interrupted
Good Input Sound
SkilledInteract_Good_Cue, Select a Sound
Sound that plays when a player hits within the successful zone.
Perfect Input Sound
SkilledInteract_Perfect_Cue, Select a Sound
Sound that plays when a player hits within the perfect zone.
Bad Input Sound
SkilledInteract_Fail_Cue, Select a Sound
Sound that plays when a player hits outside the successful zone.
Minigame Start Sound
SkilledInteract_Open_Cue, Select a Sound
Sound that plays when the minigame starts.
Minigame Looping Sound
SkilledInteract_Loop_Cue, Select a Sound
A looping sound that plays during the interaction.
Looping Audio Pitch Multiplier
1.0 - 5.0
Pitch multiplier for the looping sound. It will increase by the selected amount each time a player gets a successful or perfect interaction. It will reset when the minigame is restarted.
Functions and Events
Functions and Events[]
Functions
Option
Description
Begin Interaction for Instigator When Receiving From
Activate the interaction for the instigating player.
End Interaction for Instigator When Receiving From
Deactivate the interaction for the instigating player.
Enable When Receiving From
Enables the device.
Disable When Receiving From
Disables the device.
Events
Option
Description
On Success Send Event To
Event when the interact is successful.
On Fail Send Event To
Event when the interact is failed, either to bad inputs or timeout.
On Bad Input Send Event To
Event when the player provides a bad input.
On Good Input Send Event To
Event when the player provides a good input.
On Perfect Input Send Event To
Event when the player provides a perfect input.
On Interrupted Send Event To
Event when the interact is interrupted, either due to player elimination, or manual deactivate / disable.
