Sequine - Scripting API
Calcatz.Sequine.PlayAnimationClipAtRangeCommand Class Reference

Plays an animation by specifying the animation clip asset, and only play within the percentaged range. More...

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

Public Member Functions

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.PlayAnimationClipCommand
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...
 
override void Editor_InitInPoints ()
 Called when a Command Node is initialized, specifically the in-points. Use this method to ensure inputIds as well. 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

float minTimePercentage = 0.25f
 
float maxTimePercentage = 0.75f
 
bool useRandomVariation = false
 
float minRandomTimePercentage = 0.25f
 
float maxRandomTimePercentage = 0.75f
 
- Public Attributes inherited from Calcatz.Sequine.PlayAnimationClipCommand
AnimationClip clip
 
- 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 OnPlayClip (CommandExecutionFlow _flow, SequinePlayer _sequine, AnimationClip _clip)
 
override void Editor_OnDrawAnimationContent (Vector2 _absPosition)
 
- Protected Member Functions inherited from Calcatz.Sequine.PlayAnimationClipCommand
override float GetTotalAnimationDuration (CommandExecutionFlow _flow)
 
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...
 
void OnComplete ()
 
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)
 

Additional Inherited Members

- Static Public Attributes inherited from Calcatz.Sequine.PlayAnimationClipCommand
const int IN_PORT_CLIP = 1
 
- 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
 
- Protected Attributes inherited from Calcatz.Sequine.PlayAnimationClipCommand
float calculatedDuration
 
SubFlowInfo subFlowOnComplete
 
- Properties inherited from Calcatz.Sequine.PlayAnimationClipCommand
override float nodeWidth [get]
 
- Properties inherited from Calcatz.Sequine.SequineTargetCommand
override float nodeWidth [get]
 

Detailed Description

Plays an animation by specifying the animation clip asset, and only play within the percentaged range.

Note that in script, you can't get nor modify the SequineState of a ranged clip.

Member Function Documentation

◆ Editor_OnDrawAnimationContent()

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

◆ Editor_OnDrawTitle()

override void Calcatz.Sequine.PlayAnimationClipAtRangeCommand.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 >.

◆ OnPlayClip()

override void Calcatz.Sequine.PlayAnimationClipAtRangeCommand.OnPlayClip ( CommandExecutionFlow  _flow,
SequinePlayer  _sequine,
AnimationClip  _clip 
)
protectedvirtual

Member Data Documentation

◆ maxRandomTimePercentage

float Calcatz.Sequine.PlayAnimationClipAtRangeCommand.maxRandomTimePercentage = 0.75f

◆ maxTimePercentage

float Calcatz.Sequine.PlayAnimationClipAtRangeCommand.maxTimePercentage = 0.75f

◆ minRandomTimePercentage

float Calcatz.Sequine.PlayAnimationClipAtRangeCommand.minRandomTimePercentage = 0.25f

◆ minTimePercentage

float Calcatz.Sequine.PlayAnimationClipAtRangeCommand.minTimePercentage = 0.25f

◆ useRandomVariation

bool Calcatz.Sequine.PlayAnimationClipAtRangeCommand.useRandomVariation = false