Learn / Documentation / UIAction

Description

The UIAction is a versatile event-like component to that allows for the execution of several 'actions' at once.

With a single method call it can invoke an Action, invoke a list of AnimatorEvent, play or stop an UIEffect (ParticleSystem), invoke an UnityEvent, send a list of game events and play a sound.

Sound

Responsible for playing a sound when the UIAction is executed.

By selecting a Sound Source, different options are displayed in the Unity Editor.

  • Soundy will get a sound from the database and play it with a Soundy Controller
  • Audio Clip will use a Soundy Controller to play the referenced AudioClip
  • Master Audio will trigger the MasterAudio plugin to play the set sound name (it it was defined there)

Soundy

Gesture Listener
  • Sound Source – Selects the sound source that will provide the sound that will get played

  • Database NameSoundDatabase database name that contains the sound name

  • Sound Name – Sound name of a SoundGroupData that holds settings and references to one or more audio clips

  • Soundy – Opens the Control Panel at the Soundy tab

  • Output AudioMixerGroup  – Name of the AudioMixerGroup, referenced in the SoundDatabase, that will have the selected sound routed through when played

  • Soundy Player – Simple audio player that works inside the Unity Editor

Audio Clip

Gesture Listener
  • Sound Source – Selects the sound source that will provide the sound that will get played

  • Audio Clip – Direct reference to an Audio Clip that will get played

  • Output AudioMixerGroup  – Direct reference to an AudioMixerGroup  that the referenced AudioClip will get routed through when played

  • Soundy Player – Simple audio player that works inside the Unity Editor

Master Audio

Gesture Listener
  • Sound Source – Selects the sound source that will provide the sound that will get played

  • Sound Name – Sound name, set up in MasterAudio, that will get played

Effect

Manages a target ParticleSystem by dynamically changing its sorting layer and sorting order, in relation to any Canvas component, and also plays or stops the effect when invoked

The referenced ParticleSystem will get played or stopped (depending on the settings) whenever the UIAction is executed.

Gesture Listener
Gesture Listener
  • Particle System – Target ParticleSystem that this UIEffect manages

  • Action – Determines if, when invoked, this UIEffect will Play or Stop its target ParticleSystem

  • Auto Sort – Determines if the effect should get automatically sorted or not (this refers the sorting order)

  • Sorting Steps – Number of sorting steps that will get added (if AutoSort is set to DynamicSorting.InFront) or subtracted (if AutoSort is set to DynamicSorting.Behind)

  • Update Effect – Updates the target ParticleSystem sorting layer and sorting order to the current settings

Gesture Listener
  • Particle System – Target ParticleSystem that this UIEffect manages

  • Action – Determines if, when invoked, this UIEffect will Play or Stop its target ParticleSystem

  • Stop Behavior – The behavior to apply when calling Stop on the target ParticleSystem

Animators

A list of AnimatorEvents. They are event-like components that allows interacting with an Animator’s parameters in a dynamic way.

An AnimatorEvent can change any parameter type found in an Animator:

  • BoolValue – Value assigned to the target parameter if the TargetParameterType is set to ParameterType.Bool
  • FloatValue – Value assigned to the target parameter if the TargetParameterType is set to ParameterType.Float
  • IntValue – Value assigned to the target parameter if the TargetParameterType is set to ParameterType.Int
  • ParameterName – Name of the parameter (trigger) used to assign the value, if the TargetParameterType is set to ParameterType.Trigger
Gesture Listener
Gesture Listener
  • Target Animator – Reference to an Animator component

  • Parameter Type – Bool, Float, Int, Trigger

  • Value – Value to set for the target parameter

Game Events

A list of Game Events that get sent when this UIAction is executed.

A Game Event is a string value that is passed around the system.

Gesture Listener
Gesture Listener

Unity Events

An UnityEvent that gets executed when this UIAction is executed.

Gesture Listener
Gesture Listener