Sequine - Scripting API
Calcatz.Sequine.SequineAnimationCommand Class Reference

Base class for commands that targets a Sequine Player component and uses animation configuration without implementing how to play the animation yet. More...

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

Public Member Functions

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

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
 

Static Public Attributes

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
 

Protected Member Functions

AnimationConfig GetAnimationConfig ()
 
virtual float GetTotalAnimationDuration (CommandExecutionFlow _flow)
 
virtual void Editor_OnDrawAnimationContent (Vector2 _absPosition)
 
- 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)
 

Additional Inherited Members

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

Detailed Description

Base class for commands that targets a Sequine Player component and uses animation configuration without implementing how to play the animation yet.

Member Function Documentation

◆ Editor_InitOutPoints()

override void Calcatz.Sequine.SequineAnimationCommand.Editor_InitOutPoints ( )
virtual

Called when a Command Node is initialized, specifically the out-points. Use this method to ensure nextIds as well.

Reimplemented from Calcatz.CookieCutter.Command< float >.

◆ Editor_OnDrawAnimationContent()

virtual void Calcatz.Sequine.SequineAnimationCommand.Editor_OnDrawAnimationContent ( Vector2  _absPosition)
protectedvirtual

◆ Editor_OnDrawContents()

override void Calcatz.Sequine.SequineAnimationCommand.Editor_OnDrawContents ( Vector2  _absPosition)
virtual

Called when a Command Node is drawn.

Parameters
_absPosition

Reimplemented from Calcatz.CookieCutter.Command< float >.

◆ GetAnimationConfig()

AnimationConfig Calcatz.Sequine.SequineAnimationCommand.GetAnimationConfig ( )
protected

◆ GetOutput()

override float Calcatz.Sequine.SequineAnimationCommand.GetOutput ( CommandExecutionFlow  _flow,
int  _pointIndex 
)
virtual

◆ GetTotalAnimationDuration()

virtual float Calcatz.Sequine.SequineAnimationCommand.GetTotalAnimationDuration ( CommandExecutionFlow  _flow)
protectedvirtual

Member Data Documentation

◆ editor_showConfig

bool Calcatz.Sequine.SequineAnimationCommand.editor_showConfig = false

◆ layer

int Calcatz.Sequine.SequineAnimationCommand.layer = 0

◆ lengthToPlay

float Calcatz.Sequine.SequineAnimationCommand.lengthToPlay = 1.0f

◆ normalizedTransition

bool Calcatz.Sequine.SequineAnimationCommand.normalizedTransition = false

◆ OUT_PORT_ONCOMPLETE

const int Calcatz.Sequine.SequineAnimationCommand.OUT_PORT_ONCOMPLETE = 1
static

◆ OUT_PORT_TOTALDURATION

const int Calcatz.Sequine.SequineAnimationCommand.OUT_PORT_TOTALDURATION = 2
static

◆ restart

bool Calcatz.Sequine.SequineAnimationCommand.restart = true

◆ speed

float Calcatz.Sequine.SequineAnimationCommand.speed = 1f

◆ transitionDuration

float Calcatz.Sequine.SequineAnimationCommand.transitionDuration = 0.25f