API 参考 / NatsumeAnimator
Class: NatsumeAnimator
Defined in: packages/natsume/src/runtime/animator-handle.ts:8
Instance-owned flat Animator controller. Names and parameter types are checked.
Constructors
Constructor
new NatsumeAnimator(
controller,assertAlive):NatsumeAnimator
Defined in: packages/natsume/src/runtime/animator-handle.ts:9
Parameters
controller
AnimatorController
assertAlive
() => void
Returns
NatsumeAnimator
Accessors
layerCount
Get Signature
get layerCount():
number
Defined in: packages/natsume/src/runtime/animator-handle.ts:14
Number of source layers, including empty layers.
Returns
number
Methods
getBool()
getBool(
name):boolean
Defined in: packages/natsume/src/runtime/animator-handle.ts:39
Reads a Bool parameter.
Parameters
name
string
Returns
boolean
getCurrentState()
getCurrentState(
layer?):AnimatorStateInfo|undefined
Defined in: packages/natsume/src/runtime/animator-handle.ts:69
Empty layers return undefined. Snapshots do not change after evaluation.
Parameters
layer?
number = 0
Returns
AnimatorStateInfo | undefined
getFloat()
getFloat(
name):number
Defined in: packages/natsume/src/runtime/animator-handle.ts:19
Reads a Float parameter; throws if the name or type does not match.
Parameters
name
string
Returns
number
getInt()
getInt(
name):number
Defined in: packages/natsume/src/runtime/animator-handle.ts:29
Reads an Int parameter.
Parameters
name
string
Returns
number
getLayerWeight()
getLayerWeight(
layer):number
Defined in: packages/natsume/src/runtime/animator-handle.ts:59
Base layer is always effective at weight 1.
Parameters
layer
number
Returns
number
getNextState()
getNextState(
layer?):AnimatorStateInfo|undefined
Defined in: packages/natsume/src/runtime/animator-handle.ts:74
State a running transition leads to, or undefined when no transition is active.
Parameters
layer?
number = 0
Returns
AnimatorStateInfo | undefined
getTransition()
getTransition(
layer?):AnimatorTransitionInfo|undefined
Defined in: packages/natsume/src/runtime/animator-handle.ts:79
Active transition on the layer, or undefined when none is running.
Parameters
layer?
number = 0
Returns
AnimatorTransitionInfo | undefined
resetTrigger()
resetTrigger(
name):void
Defined in: packages/natsume/src/runtime/animator-handle.ts:54
Clears a Trigger parameter that has not been consumed.
Parameters
name
string
Returns
void
setBool()
setBool(
name,value):void
Defined in: packages/natsume/src/runtime/animator-handle.ts:44
Sets a Bool parameter.
Parameters
name
string
value
boolean
Returns
void
setFloat()
setFloat(
name,value):void
Defined in: packages/natsume/src/runtime/animator-handle.ts:24
Sets a Float parameter.
Parameters
name
string
value
number
Returns
void
setInt()
setInt(
name,value):void
Defined in: packages/natsume/src/runtime/animator-handle.ts:34
Sets an Int parameter.
Parameters
name
string
value
number
Returns
void
setLayerWeight()
setLayerWeight(
layer,weight):void
Defined in: packages/natsume/src/runtime/animator-handle.ts:64
Sets an upper layer's blend weight in [0, 1], applied on the next evaluation.
Parameters
layer
number
weight
number
Returns
void
setTrigger()
setTrigger(
name):void
Defined in: packages/natsume/src/runtime/animator-handle.ts:49
Remains set until a selected transition consumes it or resetTrigger is called.
Parameters
name
string
Returns
void
setVisible()
setVisible(
visible):void
Defined in: packages/natsume/src/runtime/animator-handle.ts:84
Supplies renderer visibility for source culling modes; defaults to true.
Parameters
visible
boolean
Returns
void