Sequine - Scripting API
Calcatz.Sequine.SequineLayer Class Reference

Manages animation clips mixing in a certain layer. More...

Public Member Functions

 SequineLayer (PlayableGraph _playableGraph, AnimationLayerMixerPlayable _layerMixerPlayable, int _layerIndex, SequinePlayer.LayerRegistry _layerRegistry)
 
SequineState PlayAnimationClip (AnimationClip _clip, AnimationConfig _config, bool _restart=false, Action _onComplete=null)
 
SequineState PlayRangedAnimationClip (AnimationClip _clip, AnimationConfig _config, float _minTimePercentage, float _maxTimePercentage, bool _restart=false, Action _onComplete=null)
 
bool TryGetCurrentClip (out AnimationClip _clip)
 Try get the clip of the current state if not null. More...
 
bool TryGetState (AnimationClip _clip, out SequineState _state)
 
void RemoveState (AnimationClip _clip)
 
void Tick (float _deltaTime)
 
void ExitCurrentState ()
 
void Stop ()
 

Properties

string name [get]
 
SequineState currentState [get]
 
IEnumerable< SequineStatestates [get]
 
float weight [getset]
 

Detailed Description

Manages animation clips mixing in a certain layer.

Constructor & Destructor Documentation

◆ SequineLayer()

Calcatz.Sequine.SequineLayer.SequineLayer ( PlayableGraph  _playableGraph,
AnimationLayerMixerPlayable  _layerMixerPlayable,
int  _layerIndex,
SequinePlayer.LayerRegistry  _layerRegistry 
)

Member Function Documentation

◆ ExitCurrentState()

void Calcatz.Sequine.SequineLayer.ExitCurrentState ( )

◆ PlayAnimationClip()

SequineState Calcatz.Sequine.SequineLayer.PlayAnimationClip ( AnimationClip  _clip,
AnimationConfig  _config,
bool  _restart = false,
Action  _onComplete = null 
)

◆ PlayRangedAnimationClip()

SequineState Calcatz.Sequine.SequineLayer.PlayRangedAnimationClip ( AnimationClip  _clip,
AnimationConfig  _config,
float  _minTimePercentage,
float  _maxTimePercentage,
bool  _restart = false,
Action  _onComplete = null 
)

◆ RemoveState()

void Calcatz.Sequine.SequineLayer.RemoveState ( AnimationClip  _clip)

◆ Stop()

void Calcatz.Sequine.SequineLayer.Stop ( )

◆ Tick()

void Calcatz.Sequine.SequineLayer.Tick ( float  _deltaTime)

◆ TryGetCurrentClip()

bool Calcatz.Sequine.SequineLayer.TryGetCurrentClip ( out AnimationClip  _clip)

Try get the clip of the current state if not null.

Parameters
_clip
Returns

◆ TryGetState()

bool Calcatz.Sequine.SequineLayer.TryGetState ( AnimationClip  _clip,
out SequineState  _state 
)

Property Documentation

◆ currentState

SequineState Calcatz.Sequine.SequineLayer.currentState
get

◆ name

string Calcatz.Sequine.SequineLayer.name
get

◆ states

IEnumerable<SequineState> Calcatz.Sequine.SequineLayer.states
get

◆ weight

float Calcatz.Sequine.SequineLayer.weight
getset