Action is a special function for change something in a level – in most cases it influence on Actor moved between Control Points.

Every Action has its own specific configuration when you add it to the list.

Default Actions can be divided into three categories:

• Character – whose name starts with “[Character]…” and should only be used for children of the class “Character” because they use character specific functions and variables.
• Pure Actor – whose name start with “[Pure Actor]…” can be used on any kind of Actors also on Characters, Pawn, Emitters, Static Meshes, etc. These Actions don’t use specific functions or variables. In most cases you don’t want to use them for characters because they are designes specially for pure Actors.
• General – whose name don’t have any prefix. These Actions can be used on any Actor. Some of them have special function which don’t affect on Actor who run this Action e.g. “Back to Action”.

There are 42 default Actions

[Character] Go Next – Go to the next Control Point.
  Action uses the Character Movement Component to move to the next Control Point selected by the Move Order function.

[Character] Go Next and Jump – Go to the next Control Point and jump somewere halfway.
  Action uses the Character Movement Component to move to the next Control Point selected by the Move Order function. After selected time, Character Movement Component is used to jump.

[Character] Go Next by Spline – Go to the next Control Point through Spline.
  Action has 3 different moving methods which can be used:
  • Simple – uses Set Actor Location node for moving and manually setup Character animation. Lowest impact on performance but without using NavMesh and without avoiding obstacles.
  • Advance faced natural – movement is handled partially by Movement Component. Rotation, moving target and every tick correction for moving on spline is done with special code. Set temporary destination target in front of the character (counted depends on spline position). Temporary destination point can be outside of the spline. High impact on performance but using Movement Component for most advance movement quality. This method create movement a little more natural but a little less safer (can fall out of spline on very on shap curves).
  • Advance faced to Spline ahead – movement is handled partially by Movement Component. Rotation, moving target and every tick correction for moving on spline is done with special code. Set temporary destination target in front of the character on spline (counted depends on spline position). Temporary destination point is always on the spline. High impact on performance but using Movement Component for most advance movement quality. This method create movement a little more safer (less possibility to fall out of spline) but a little less natural.
  • Advance with Pathfinding – movement is handled partially by Movement Component and NavMesh. Rotation, moving target and every tick correction for moving on spline is done with special code. Especially when any obstacle is on the spline – original code is used to bypass obstacle and return to spline behind obstacle. Not taking into account obstacle avoidance, this version work as Advance faced natural. Highest impact on performance but best movement quality and possibility to avoidance obstacles on spline.

[Character] Align to Current Control Point – Align position precisely to current Control Point.
  Actions Go Next… especially when using Character Movement Component for moving – in most cases finish their movement in some sort margin distance. But if is important to stand exactly where destination Control Point is – this Action should be used in destination Control Point as first Action.

[Character] Jump – Jump in place.
  Action start jump using Character Movement Component.
  It is worth to note that Action can finish immediately after jump is starting or can wait until Character finish jump.

[Character] Rotate – Rotate Character to destination Angle.
  Action rotate Character by selected speed (every axis separately) to destination Angle.

[Character] Rotate to Object – Rotate Character in the direction of the Object.
  Action rotate Character by selected speed (every axis separately) towards selected Object on the scene.

[Character] Randomize Speed – Set new Max Walking Speed.
  Action set random in range or fixed Max Walking Speed (parameter of Character Movement Component).

[Character] Play Anim Sequence – Play Animation Sequence on Character Mesh.
  Action play selected Animation Sequence on Mesh inherited from Character class.
  Special parameter Is Reset Animation Blueprint when Stop gives possibility to reset Animation Blueprint after Animation Sequence finish.
  It is worth to note that Action can finish immediately (then Animation continue playing during next Actions) or can wait until Animation finish.

[Character] Stop Anim Sequence – Stop any Animation Sequence on Character Mesh.
  Action stop any existing Animation Sequence playing currently on Mesh inherited from Character class.
  Special parameter Is Reset Animation Blueprint gives possibility to reset Animation Blueprint.

[Character] Play Anim Montage – Play Animation Montage on Character Mesh.
  Action play selected Animation Montage on Mesh inherited from Character class.
  It is worth to note that Action can finish immediately (then Montage continue playing during next Actions) or can wait until Montage finish.

[Character] Stop Anim Montage – Stop selected Animation Montage on Character Mesh.
  Action stop selected Animation Montage playing currently on Mesh inherited from Character class.

[Character] Set Mesh Material – Set Material on Character Skeletal Mesh.
  Action set selected Material on Skeletal Mesh inherited from Character class.

[Character] Set Movement Component Parameters  – Set some parameters on Movement Component.
  Action can change some of Character Movement Component parameters.

[Character] Setup Rotation Smoothly – Setup smoothly rotation when Character change direction.
  Action change Character Movement Component settings in the way Character start rotating smoothly after change direction.
  Rotation speed is setup separately for every axis.

[Pure Actor] Go Next  – Go to the next Control Point.
  Action move Actor to the next Control Point selected by the Move Order function. Action do not use NavMesh.
  During movement Actor can be rotated with selected speed separately for every axis.
  Speed of Actor can be parametrized or left as it was.

[Pure Actor] Go Next by Spline – Go to the next Control Point through Spline.
  Action move Actor on the Spline with selected speed which can be parametrized of left as it was.

[Pure Actor] Rotate – Rotate Actor to destination Angle.
  Action rotate Actor by selected speed (every axis separately) to destination Angle.

[Pure Actor] Rotate Infinitely – Rotate Actor selected amount of time.
  Action Rotate Actor with selected speed (every axis separately) randomized or fixed amount of time.

[Pure Actor] Rotate to Object – Rotate Actor in the direction of the Object.
  Action rotate Actor by selected speed (every axis separately) towards selected Object on the scene.

Back to Action  – Change index of next Action to selected one.
  Action change internal index of Array Action to selected one, is such a way that the next Action launched will be the one selected.

Destroy Actors  – Destroy array of Actors being on the scene.
  Action instantly destroy all Actors referenced as an Action parameters.

Destroy Instantly – Destroy current Actor instantly.
  Action instantly destroy Actor who launched this Action.

Destroy Related Objects – Destroy all related objects spawned by this Actor through Actions.
  Action destroy instantly all Actors being on the scene, which previously spawned by other Actions (eg. Particles, Actors, Sounds).

Destroy when NOT Visible – Destroy current Actor only when not rendering.
  Action destroy Actor who launched this Action only when is not rendering (not visible), or wait until become not rendering (not visible).
  This Action is very usefull when you don’t want objects/characters disappear in the front of player.

Modify Trigger – Change settings of selected Trigger.
  Action modify selected Trigger settings which is instanced on the scene.

Particle Cascade Spawn – Spawn Cascade Particle System.
  Action spawn selected Cascade Particle with custom settings on the scene.
  Spawning method can align concerned Actor, current Control Point, selected Actor on the scene or the world itself, also with custom offset to source align.
  It is also possible to setup lifespan – which is currently not supported by normal unreal Particle Cascade spawning.

Particle Cascade Set Parameters – Change settings of selected Particle Cascade.
  Action modify settings of selected Particle Cascade. Also internal Cascade Parameters and Beam Parameters can be changed.

Particle Niagara Spawn – Spawn Niagara Particle System.
  Action spawn selected Niagara Particle with custom settings on the scene.
  Spawning method can align concerned Actor, current Control Point, selected Actor on the scene or the world itself, also with custom offset to source align.
  It is also possible to setup lifespan – which is currently not supported by normal unreal Particle Niagara spawning.

Particle Niagara Set Parameters – Change settings of selected Particle Niagara.
  Action modify settins of selected Particle Niagara. Also internal Niagara Parametes can be changed.

Player Change Camera – Change Player Camera to new target.
  Action smootly or instantly change player camera to selected target or back to oryginal Player Camera.
  Player can be chosen by Player Index or by Controller ID (useful in multiplayer).

Player Enable Input – Enable or Disable Player input.
  Action Enable or Disable Player input. Can be useful eg. when cutscene start/stop.
  Player can be chosen by Player Index or by Controller ID (useful in multiplayer).

Print String – Print debug string.
  Action Print debug string to Screen or/and to Log.

 Play Sound 2D – Play selected sound 2D.
  Action play selected sound 2D with custom parameters and concurrency settings.

 Spawn Sound 3D – Spawn Sound 3D on the scene.
  Action spawn selected sound 3D with custom parameters and concurrency settings.
  Spawning method can align concerned Actor, current Control Point, selected Actor on the scene or the world itself, also with custom offset to source align.
  It is also possible to setup lifespan – which is currently not supported by normal unreal Sound spawning.

Spawn Actor – Spawn Actor of selected class.
  Action spawn Actor on the scene. Action can decide whether Construction Script of newly spawned Actor will be executed or not.
  Spawning method can align concerned Actor, current Control Point, selected Actor on the scene or the world itself, also with custom offset to source align.

Set Actor Parametes – Change settings of selected Actor. 
  Action modify some parameters of selected and instanced Actor.

Teleport Next – Teleport to the next Control Point.
  Action instantly teleport Actor to the next Control Point selected by the Move Order function. Action do not use NavMesh.
  Actor rotation remains unchanged.

Teleport Next when NOT Visible – Teleport to the next Control Point only when Actor is not rendering.
  Action teleport Actor to the next Control Point selected by the Move Order function, only when is not rendering (not visible), or wait until become not rendering (not visible). Action do not use NavMesh.
  Actor rotation remains unchanged.
  This Action is very usefull when you don’t want objects/characters disappear in the front of player.

Trigger – Trigger to Start/Stop Advanced Control Points System.
  Action Start or Stop Advanced Control Points System on selected group of Actors (with Advanced Control Points Component) and/or Actors spawned by selected group of Spawn Points .
  Action can also Destroy selected group of Actors (with Advanced Control Points Component) and/or Actors spawned by selected group of Spawn Points.

Wait – Actor wait random amount of time.
  Action do nothing for randomized or fixed amount of time.

 Execute Console Command – Execute a Console Command.
  Action execute Console Command, optionally for specific Player Controller.

Actions order and executions

Actions executing one by one, sequentially waiting for each other.
Exception is when Action code is constructed in the way to continue somewhere else and finish its main code. Eg. Action [Character] Jump can finish its code instantly, lets next Action to run, but Jumping code inside Character Movement Component will continue.
Also sequential order of Actions array can be changed by Action Back to Action. After this Action – internal index of Actions within a given array – will change, and next Action can be one of selected.

When last Action of current Actions array will finish – nothing more happen. So in most cases, as last Action any of …Go Next… or Teleport Next… Actions is preferred. Sometimes also actions Destroy instantly or Destroy when NOT Visible is useful. 

It is important to remember that some Actions can finish chain of executions of Actions. Eg. any …Go Next… Action after finish, start new chain of executions of Actions in new Control Point.
Another example is Action [Pure Actor] Rotate Infinitely with parameter Time set to -1 (forever), so that any further Actions will never be launched.

Parameters

Every particular Action has its unique parameters. But there are some equal for every Actions:

• First Execution – Action start working after this number of tries. So this Action will be bypassed until this counter reduces to zero.
• Max Executions – Maximum number of executions of this Action. After every successful execution of this Action, this counter reduce by one. When Max Executions is 0 then this Action will be bypassed. 
         Setting up -1 mean, this Action can execute unlimited times.

Event Dispatchers

Every Action has by default 2 Event Dispatchers:

• Action Start – this dispatcher is called automatically, when Action start. Precisely in base class of Action inside event Do Action.
• Action Finish – this dispacher you should call manually when your Action is finished. Sometimes it is instantly after short code in the same frame. Sometimes after a long time.

Concurrent Actions

Besides the normal Actions or Begin Actions – there is possible to run Action in parallel mode. Action launched in parallel mode is called Concurrent Action.

Concurrent Action can be run from Trigger Task called Run Action or manually by running function Run Action Concurrent from selected Advanced Control Points Component.

After Concurrent Action, nothing more will happen. But after normal Action, the internal index of Actions will change and next Action will run.

Using Concurrent Actions is sometimes dangerous. Eg.
• Currently normal Action is “[Character] Go Next…” and new Concurrent Action is “Jump” – then everything will be fine
• Currently normal Action is “[Character] Rotate” and new Concurrent Action is “[Character] Go Next” – then animation glitch of rotation toward destination Control Point and Rotating from normal Action will be mutually problematic

Because of it, you should be very careful when choosing Concurrent Action.

In many cases is more wisely to use Settings Override on Actors to change their Actions.

Actions can be used in 6 places

Create custom Action

Actions are designed to be easly created for your needs. To create new kind of Action which cover your needs, simply create child from CP_Action_Base or duplicate one of existing Action object and modify. Its structure is fairly simple and intuitive.

4.

Create very simple code connected to this event.

Check Conditions to Run This Action – Very important function, which check whether it is possible to run this Action.
If there is necessity, Function can be override to add extra conditions. When function is overriden – also call Parent function should done.

Our Action when start need only enable Ticking by function Set Is Ticking Action.
Normally Actions have disabled Ticking for better performance. Some Actions have small, instant code and don’t need Tick. Sometimes Action code is event based, so don’t need Tick also.

When Conditions of Action don’t let to run it – we simply call Event Dispatcher Action Finish to give a signal for owner Advanced Control Points Component that Action finish with successful false.
After this Event Dispatcher is receive, instantly next Action from Actions array of Advanced Control Points Component will launch.

6.

Create simple code connected to this event.

This simple code move Actor on the circle. After movement Action will finish.

First execution of sequence is code for change degree of circle.

Second execution of sequence:
a. check whether we finish the chosen angle or not.
 – if not finish: simply change Actor position to previously updated degree
 – if finish:
  > first change our degree to destination degree: because in previously updated degree we increment angle depends on Delta Tick, which can be upredictable
  > second simply change Actor position do finish angle
  > third call Dispatcher Action Finish which disable Action and inform Advanced Control Points Component about end of this Action

Code of course is very simple, but showing an example of non-instant Action.

7.

The core of our Action functionality is working. Now is very important to validate our Action‘s code.

13.

The code below in this function first get validation results from parent function and then validate correctness of 3 Action’s parameters.

15.

Part of code validating Speed parameter. If value is zero or lower, value Loc is Validated is set to false and error message is added to Errors array.

16.

Part of code validating Degree Max parameter. If value is zero or lower, value Loc is Validated is set to false and error message is added to Errors array.

17.

Part of code validating Diameter parameter. If value is zero or lower, value Loc is Validated is set to false and error message is added to Errors array.

19.

You can click button in any Control Point with new Action in its Actions array. Results of validation is visible is Output Log window.

Available functions/events to override in Action Base Class

• Do Action – An event which run when Action start. You should remember to always call parent function when override this event.
  > Actor Component Control Points: IN reference to Adanced Control Points Component, owner of this Action.
  > Actor Concerned: IN reference to Actor which launch this Action.

• Do Tick – A Tick event is run externally from Advanced Control Points Component which is owner of the Action. This event will don’t work until you first use function Set is Ticking Action with true.
  > Delta Seconds: IN delta time from last frame. Works in the same way as in every Actor.

• Copy Constructor – Function run everytime this Action is duplicated. Action object copying happen many times during play time. In this function you must copy all variables which keeping references.
  > Source Object: IN reference to oryginal object of this Action from which all reference variables should be copied.

• Do Stop Action – An event used to stop Action immediately. This event can be called in any time during Action work. If the Action is not immediate, this event must be overriden. Long time working Action should release all timers, should back to original state all what should be left in oryginal state. Also asynchronic task should be finished. Sometimes, when after suddenly stoppping of this Action there is no need to release anything, you can simply don’t override this function. You should remember to always call parent function when override this function.

• Do Validate – Function used to validate this Action parameters. This function should be overriden when any of Action parameter can be set as non-valid, eg.: when float parameter should be only higher that 0,0, validation must to check this.
This function is run everytime when button is clicked on owner Advanced Control Points Component or on owner Spawn Point or on owner Control Point.
Also in Global Manager when any of buttons or or is clicked.
This Function is run also everytime when owner Advanced Control Points Component or Spawn Point starting.
You should remember to always call parent function when override this function. Also take care about output variable Is Validated from parent function. If from parent function or your overriden version of Do Validate any parameter is wrong – this output parameter should be false. So normally Is Validated is true, but when any Action parameter is not-valid, this variable should be output as false.
It is very important to inform what parameter is setup wrong and why. This message you should add to array Errors, which you should be got from parent function and output as Errors variable when function return.

• Finish Action – An event used to finishing Action. Currently only mandatory behavior is to call Action Finish event dispatcher. But this event is used when more things should be done on Action finish.

Available functions/events – which can be used in Action Base Class

There is a list of functions/events you can use in your Action but there is no need to override them.

• Get is Ticking – Function return whether Action Tick is currently enabled.
• Set is Ticking Action – Function turn on/off Action Tick.
• Set is Ticking Occupied Procedure – Function turn on/off Occupied Procedure Tick. Occupied Procedure Ticking is currently used only in “…Go Next…” Actions.
• Set is Ticking Rotation Procedure – Function turn on/of Rotation Procedure Tick. Rotation Procedure Ticking is currently used only during “…Go Next…” Actions.