Sequine - Scripting API
Calcatz.Sequine.SequineRangedState Class Reference

A specific type of SequineState where it plays an animation clip within a certain time range. More...

Inheritance diagram for Calcatz.Sequine.SequineRangedState:
Calcatz.Sequine.SequineState

Public Member Functions

 SequineRangedState (AnimationMixerPlayable _animationMixer, int _inputPort)
 
 SequineRangedState (AnimationMixerPlayable _animationMixer, int _inputPort, float _minTimePercentage, float _maxTimePercentage)
 
void ClampTime ()
 
override void Finish ()
 
- Public Member Functions inherited from Calcatz.Sequine.SequineState
 SequineState (AnimationMixerPlayable _animationMixer, int _inputPort)
 
void Reset ()
 
void Restart ()
 
void Play ()
 
void Stop ()
 
void Pause ()
 
void Resume ()
 
void Exit ()
 
void Tick (float _deltaTime)
 

Protected Member Functions

override void OnTimeIncremented ()
 

Events

System.Action onStateFinished
 

Additional Inherited Members

- Public Attributes inherited from Calcatz.Sequine.SequineState
Action onComplete
 
OnStateUpdateCallback onUpdate
 
- Protected Attributes inherited from Calcatz.Sequine.SequineState
AnimationClipPlayable m_clipPlayable
 
bool m_completed
 
- Properties inherited from Calcatz.Sequine.SequineState
float lengthToPlay [getset]
 
float speed [getset]
 
float time [getset]
 
float duration [get]
 
float weight [get]
 
bool isExiting [get]
 
bool exited [get]
 Whether the state has been fully transitioned to the next state or not. More...
 
bool completed [get]
 Whether the clip has been fully played according to the length to play or not. More...
 
float fadeInDuration [getset]
 
float fadeOutDuration [getset]
 
float fadeInDurationNormalized [getset]
 
float fadeOutDurationNormalized [getset]
 
float normalizedTime [getset]
 
float normalizedLength [get]
 Current played length according to lengthToPlay More...
 
AnimationClip clip [get]
 

Detailed Description

A specific type of SequineState where it plays an animation clip within a certain time range.

Note that in script, you can't get nor modify the SequineRangedState as they're not bound to clip. One clip might have multiple states to enable blending between the same clip at different time.

Constructor & Destructor Documentation

◆ SequineRangedState() [1/2]

Calcatz.Sequine.SequineRangedState.SequineRangedState ( AnimationMixerPlayable  _animationMixer,
int  _inputPort 
)

◆ SequineRangedState() [2/2]

Calcatz.Sequine.SequineRangedState.SequineRangedState ( AnimationMixerPlayable  _animationMixer,
int  _inputPort,
float  _minTimePercentage,
float  _maxTimePercentage 
)

Member Function Documentation

◆ ClampTime()

void Calcatz.Sequine.SequineRangedState.ClampTime ( )

◆ Finish()

override void Calcatz.Sequine.SequineRangedState.Finish ( )
virtual

Reimplemented from Calcatz.Sequine.SequineState.

◆ OnTimeIncremented()

override void Calcatz.Sequine.SequineRangedState.OnTimeIncremented ( )
protectedvirtual

Reimplemented from Calcatz.Sequine.SequineState.

Event Documentation

◆ onStateFinished

System.Action Calcatz.Sequine.SequineRangedState.onStateFinished