Sequine - Scripting API
Calcatz.Sequine.PlayActionAnimationWithTranslationCommand Class Reference

Plays an action (animation that is listed in a Sequine Animation Data asset) by specifying the Action ID, and apply a simple translation along the animation. More...

Inheritance diagram for Calcatz.Sequine.PlayActionAnimationWithTranslationCommand:
Calcatz.Sequine.SequineActionAnimationCommand Calcatz.Sequine.SequineAnimationCommand Calcatz.Sequine.SequineTargetCommand Calcatz.CookieCutter.Command< float >

Public Member Functions

override void Execute (CommandExecutionFlow _flow)
 The process to execute upon visiting the main in-point (white in-point). More...
 
override void Editor_OnDrawTitle (out string _tooltip)
 Called when a Command Node's title is drawn. Use this to change the tooltip of the command. Also use this to decide whether the Title should draw in-point and/or out-point. More...
 
- Public Member Functions inherited from Calcatz.Sequine.SequineAnimationCommand
override float GetOutput (CommandExecutionFlow _flow, int _pointIndex)
 
override void Editor_InitOutPoints ()
 Called when a Command Node is initialized, specifically the out-points. Use this method to ensure nextIds as well. More...
 
override void Editor_OnDrawContents (Vector2 _absPosition)
 Called when a Command Node is drawn. More...
 
- Public Member Functions inherited from Calcatz.Sequine.SequineTargetCommand
override bool Validate (CommandData _commandData)
 Validate() is called when opening the nodes editor (if in Edit Mode), or right before the command execution (if in Play Mode). The main purpose is to adapt or validate any data inside the Command, if its structure had been changed. More...
 
override void Editor_InitInPoints ()
 Called when a Command Node is initialized, specifically the in-points. Use this method to ensure inputIds as well. More...
 
override void Editor_OnDrawContents (Vector2 _absPosition)
 Called when a Command Node is drawn. More...
 

Public Attributes

Vector3 translation
 
EasingFunction.Ease easing = EasingFunction.Ease.Linear
 
- Public Attributes inherited from Calcatz.Sequine.SequineActionAnimationCommand
int actionId
 
- Public Attributes inherited from Calcatz.Sequine.SequineAnimationCommand
int layer = 0
 
float speed = 1f
 
float transitionDuration = 0.25f
 
bool normalizedTransition = false
 
float lengthToPlay = 1.0f
 
bool restart = true
 
bool editor_showConfig = false
 
- Public Attributes inherited from Calcatz.Sequine.SequineTargetCommand
UnityEngine.Object target
 
TargetObject< SequinePlayersequinePlayerRef
 

Protected Member Functions

override void HandleInterruption ()
 Called when the current flow is force killed, while the currently executed command is exactly this command, and has not exited. Note that "exited" here means that Exit() method has been called. More...
 
override void Editor_OnDrawAnimationContent (Vector2 _absPosition)
 
- Protected Member Functions inherited from Calcatz.Sequine.SequineActionAnimationCommand
override float GetTotalAnimationDuration (CommandExecutionFlow _flow)
 
override void Editor_OnDrawAnimationContent (Vector2 _absPosition)
 
- Protected Member Functions inherited from Calcatz.Sequine.SequineAnimationCommand
AnimationConfig GetAnimationConfig ()
 
- Protected Member Functions inherited from Calcatz.Sequine.SequineTargetCommand
SequinePlayer GetSequinePlayer (CommandExecutionFlow _flow)
 Get the suitable Sequine Player component. More...
 
void DrawActionsField (int _actionId, System.Action< int > _onActionIdChanged, ref SequineAnimationData _animationData)
 

Properties

override float nodeWidth [get]
 
- Properties inherited from Calcatz.Sequine.SequineTargetCommand
override float nodeWidth [get]
 

Additional Inherited Members

- Static Public Attributes inherited from Calcatz.Sequine.SequineAnimationCommand
const int OUT_PORT_ONCOMPLETE = 1
 
const int OUT_PORT_TOTALDURATION = 2
 
- Static Public Attributes inherited from Calcatz.Sequine.SequineTargetCommand
const int IN_PORT_TARGET = 0
 

Detailed Description

Plays an action (animation that is listed in a Sequine Animation Data asset) by specifying the Action ID, and apply a simple translation along the animation.

This is a simple merge between Play Action Animation command and Tween Position command, where the duration of the tween is automatically set using the animation's duration.

Member Function Documentation

◆ Editor_OnDrawAnimationContent()

override void Calcatz.Sequine.PlayActionAnimationWithTranslationCommand.Editor_OnDrawAnimationContent ( Vector2  _absPosition)
protectedvirtual

◆ Editor_OnDrawTitle()

override void Calcatz.Sequine.PlayActionAnimationWithTranslationCommand.Editor_OnDrawTitle ( out string  _tooltip)
virtual

Called when a Command Node's title is drawn. Use this to change the tooltip of the command. Also use this to decide whether the Title should draw in-point and/or out-point.

Parameters
_tooltip

Reimplemented from Calcatz.CookieCutter.Command< float >.

◆ Execute()

override void Calcatz.Sequine.PlayActionAnimationWithTranslationCommand.Execute ( CommandExecutionFlow  _flow)
virtual

The process to execute upon visiting the main in-point (white in-point).

Parameters
_flow

Reimplemented from Calcatz.CookieCutter.Command< float >.

◆ HandleInterruption()

override void Calcatz.Sequine.PlayActionAnimationWithTranslationCommand.HandleInterruption ( )
protectedvirtual

Called when the current flow is force killed, while the currently executed command is exactly this command, and has not exited. Note that "exited" here means that Exit() method has been called.

Reimplemented from Calcatz.CookieCutter.Command< float >.

Member Data Documentation

◆ easing

EasingFunction.Ease Calcatz.Sequine.PlayActionAnimationWithTranslationCommand.easing = EasingFunction.Ease.Linear

◆ translation

Vector3 Calcatz.Sequine.PlayActionAnimationWithTranslationCommand.translation

Property Documentation

◆ nodeWidth

override float Calcatz.Sequine.PlayActionAnimationWithTranslationCommand.nodeWidth
get