|
|
| (32 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| − | | + | This page has moved to: https://docs.sine.space/v/scripting/client-scripting/components/sanimator |
| − | ==Members==
| + | |
| − | {{ScriptFunction|void|CrossFade|(string stateName, float transitionDuration);|Creates a dynamic transition between the current state and the destination state.
| + | |
| − | stateName: The name of the destination state.
| + | |
| − | transitionDuration: The duration of the transition. Value is in source state normalized time.|5=<pre>Space.Host.ExecutingObject.Animator.CrossFade("State Name", 3.0)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|void|CrossFade|(string stateName, float transitionDuration, int layer);|Creates a dynamic transition between the current state and the destination state.
| + | |
| − | stateName: The name of the destination state.
| + | |
| − | transitionDuration: The duration of the transition. Value is in source state normalized time.
| + | |
| − | layer: Layer index containing the destination state. If no layer is specified or layer is -1, the first state that is found with the given name or hash will be played.|5=<pre>Space.Host.ExecutingObject.Animator.CrossFade("State Name", 3.0, 0)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|void|CrossFade|(string stateName, float transitionDuration, int layer, float normalizedTime);|Creates a dynamic transition between the current state and the destination state.
| + | |
| − | stateName: The name of the destination state.
| + | |
| − | transitionDuration: The duration of the transition. Value is in source state normalized time.
| + | |
| − | layer: Layer index containing the destination state. If no layer is specified or layer is -1, the first state that is found with the given name or hash will be played.
| + | |
| − | normalizedTime: Start time of the current destination state. Value is in source state normalized time, should be between 0 and 1. If no explicit normalizedTime is specified or normalizedTime value is float.NegativeInfinity, the state will either be played from the start if it's not already playing, or will continue playing from its current time and no transition will happen.
| + | |
| − | |5=<pre>Space.Host.ExecutingObject.Animator.CrossFade("State Name", 3.0, 0 , 0.0)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|void|CrossFadeInFixedTime|(string stateName, float transitionDuration);|Creates a dynamic transition between the current state and the destination state. The duration and offset in the target state are in fixed time.
| + | |
| − | stateName: The name of the destination state.
| + | |
| − | transitionDuration: The duration of the transition. Value is in seconds.|5=<pre><pre>Space.Host.ExecutingObject.Animator.CrossFadeInFixedTime("State Name", 15.0)</pre></pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|void|CrossFadeInFixedTime|(string stateName, float transitionDuration, int layer);|Creates a dynamic transition between the current state and the destination state. The duration and offset in the target state are in fixed time.
| + | |
| − | stateName: The name of the destination state.
| + | |
| − | transitionDuration: The duration of the transition. Value is in seconds.
| + | |
| − | layer: Layer index containing the destination state. If no layer is specified or layer is -1, the first state that is found with the given name or hash will be played.|5=<pre><pre>Space.Host.ExecutingObject.Animator.CrossFadeInFixedTime("State Name", 15.0, 0)</pre></pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|void|CrossFadeInFixedTime|(string stateName, float transitionDuration, int layer, float fixedTime);|Creates a dynamic transition between the current state and the destination state. The duration and offset in the target state are in fixed time.
| + | |
| − | stateName: The name of the destination state.
| + | |
| − | transitionDuration: The duration of the transition. Value is in seconds.
| + | |
| − | layer: Layer index containing the destination state. If no layer is specified or layer is -1, the first state that is found with the given name or hash will be played.
| + | |
| − | fixedTime: Start time of the current destination state. Value is in seconds. If no explicit fixedTime is specified or fixedTime value is float.NegativeInfinity, the state will either be played from the start if it's not already playing, or will continue playing from its current time and no transition will happen.
| + | |
| − | |5=<pre>Space.Host.ExecutingObject.Animator.CrossFadeInFixedTime("State Name", 15.0, 0 , 0.0)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|bool|GetBool|(string name);|Returns the value of the given boolean parameter.
| + | |
| − | name: The name of the parameter.|5=<pre>isFlying = Space.Host.ExecutingObject.Animator.GetBool("IsFlying")
| + | |
| − | Space.Log(isFlying)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|bool|GetBool|(int id);|Returns the value of the given boolean parameter.
| + | |
| − | id: The id of the parameter.|5=<pre></pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|float|GetFloat|(string name);|Returns the value of the given float parameter.
| + | |
| − | name: The name of the parameter.|5=<pre>getParam = Space.Host.ExecutingObject.Animator.GetFloat("paramName")
| + | |
| − | Space.Log(getParam)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|float|GetFloat|(int id);|Returns the value of the given float parameter.
| + | |
| − | id: The id of the parameter.|5=<pre></pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|int|GetInteger|(string name);|Returns the value of the given integer parameter.
| + | |
| − | name: The name of the parameter.|5=<pre>getParam = Space.Host.ExecutingObject.Animator.GetInteger("paramName")
| + | |
| − | Space.Log(getParam)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|int|GetInteger|(int id);|Returns the value of the given integer parameter.
| + | |
| − | id: The id of the parameter.|5=<pre></pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|int|GetLayerIndex|(string layerName);|Gets the index of the layer with specified name.|5=<pre>layerIndex = Space.Host.ExecutingObject.Animator.GetLayerIndex("Layer Name")
| + | |
| − | Space.Log(layerIndex)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|string|GetLayerName|(int layerIndex);|Gets name of the layer.|5=<pre>layerName = Space.Host.ExecutingObject.Animator.GetLayerName(1)
| + | |
| − | Space.Log(layerName)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|float|GetLayerWeight|(int layerIndex);|Gets the layer's current weight.|5=<pre>layerWeight = Space.Host.ExecutingObject.Animator.GetLayerWeight(1)
| + | |
| − | Space.Log(layerWeight)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|double|GetLength|(int layer);|Current duration of the state.|5=<pre>layerStateLength = Space.Host.ExecutingObject.Animator.GetLength(1)
| + | |
| − | Space.Log(layerStateLength)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|bool|GetLoop|(int layer);|Is the state looping.|5=<pre>layerStateLoop = Space.Host.ExecutingObject.Animator.GetLoop(0)
| + | |
| − | Space.Log(layerStateLoop)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|double|GetNormalizedTime|(int layer);|Normalized time of the State.
| + | |
| − | The integer part is the number of time a state has been looped. The fractional part is the % (0-1) of progress in the current loop.|5=<pre>layerStateNormalizedTime = Space.Host.ExecutingObject.Animator.GetNormalizedTime(0)
| + | |
| − | Space.Log(layerStateNormalizedTime)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|double|GetTime|();|Fixed time of the State.|5=<pre>layerStateTime = Space.Host.ExecutingObject.Animator.GetTime(0)
| + | |
| − | Space.Log(layerStateTime)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|bool|IsInTransition|(int layer);|Is the specified layer in a transition.|5=<pre>layerTransition = Space.Host.ExecutingObject.Animator.IsInTransition(0)
| + | |
| − | Space.Log(layerTransition)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|bool|IsParameterControlledByCurve|(int id);|Returns true if a parameter is controlled by an additional curve on an animation.|5=<pre></pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|bool|IsParameterControlledByCurve|(string name);|Returns true if a parameter is controlled by an additional curve on an animation.|5=<pre>paramCurve = Space.Host.ExecutingObject.Animator.IsParameterControlledByCurve("parameterName")
| + | |
| − | Space.Log(paramCurve)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|void|Play|(string stateName);|Plays a state.
| + | |
| − | stateName: The name of the state to play.|5=<pre>Space.Host.ExecutingObject.Animator.Play("State Name");</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|void|Play|(string stateName, int layer);|Plays a state.
| + | |
| − | stateName: The name of the state to play.
| + | |
| − | Layer index containing the destination state. If no layer is specified or layer is -1, the first state that is found with the given name or hash will be played.|5=<pre>Space.Host.ExecutingObject.Animator.Play("State Name", 0);</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|void|Play|(string stateName, int layer, float normalizedTime);|Plays a state.
| + | |
| − | stateName: The name of the state to play.
| + | |
| − | Layer index containing the destination state. If no layer is specified or layer is -1, the first state that is found with the given name or hash will be played.
| + | |
| − | normalizedTime: Start time of the current destination state. Value is in normalized time. If no explicit normalizedTime is specified or value is float.NegativeInfinity, the state will either be played from the start if it's not already playing, or will continue playing from its current time.|5=<pre>Space.Host.ExecutingObject.Animator.Play("State Name", 0, 0.0);</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|void|PlayInFixedTime|(string stateName);|Plays a state. The offset in the target state is in fixed time.
| + | |
| − | stateName: The name of the state to play.|5=<pre>Space.Host.ExecutingObject.Animator.PlayInFixedTime("State Name")</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|void|PlayInFixedTime|(string stateName, int layer);|Plays a state. The offset in the target state is in fixed time.
| + | |
| − | stateName: The name of the state to play.
| + | |
| − | Layer index containing the destination state. If no layer is specified or layer is -1, the first state that is found with the given name or hash will be played.|5=<pre>Space.Host.ExecutingObject.Animator.PlayInFixedTime("State Name", 0)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|void|PlayInFixedTime|(string stateName, int layer, float fixedTime);|Plays a state. The offset in the target state is in fixed time.
| + | |
| − | stateName: The name of the state to play.
| + | |
| − | Layer index containing the destination state. If no layer is specified or layer is -1, the first state that is found with the given name or hash will be played.
| + | |
| − | fixedTime: Start time of the current destination state. Value is in seconds. If no explicit fixedTime is specified or fixedTime value is float.NegativeInfinity, the state will either be played from the start if it's not already playing, or will continue playing from its current time.|5=<pre>Space.Host.ExecutingObject.Animator.PlayInFixedTime("State Name", 0, 0.0)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|void|Rebind|();|Rebind all the animated properties and mesh data with the Animator.|5=<pre>Space.Host.ExecutingObject.Animator.Rebind()</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|void|ResetTrigger|(int id);|Resets the trigger parameter to false.|5=<pre></pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|void|ResetTrigger|(string name);|Resets the trigger parameter to false.|5=<pre> Space.Host.ExecutingObject.Animator.ResetTrigger("parameterName")</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|void|SetBool|(int id, bool value);|Sets the value of a boolean parameter.|5=<pre></pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|void|SetBool|(string name, bool value);|Sets the value of a boolean parameter.|5=<pre>Space.Host.ExecutingObject.Animator.SetBool("IsFlying", true)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|void|SetFloat|(int id, float value);|Sets the value of a float parameter.|5=<pre></pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|void|SetFloat|(int id, float value, float dampTime, float deltaTime);|Send float values to the Animator to affect transitions.
| + | |
| − | dampTime: The damper total time.
| + | |
| − | deltaTime: The delta time to give to the damper.|5=<pre></pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|void|SetFloat|(string name, float value);|Sets the value of a float parameter.|5=<pre><pre>Space.Host.ExecutingObject.Animator.SetFloat("parameterName", 2.2)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|void|SetFloat|(string name, float value, float dampTime, float deltaTime);|Send float values to the Animator to affect transitions.
| + | |
| − | dampTime: The damper total time.
| + | |
| − | deltaTime: The delta time to give to the damper.|5=<pre>Space.Host.ExecutingObject.Animator.SetFloat("parameterName", 2.2,2.0,Space.DeltaTime)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|void|SetInteger|(int id, int value);|Sets the value of the given integer parameter.|5=<pre></pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|void|SetInteger|(string name, int value);|Sets the value of the given integer parameter.|5=<pre>Space.Host.ExecutingObject.Animator.SetInteger("iParam", 2)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|void|SetLayerWeight|(int layerIndex, float weight);|Sets the weight of the layer at the given index.|5=<pre>Space.Host.ExecutingObject.Animator.SetLayerWeight(0,2.0)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|void|SetTime|(double time);|Sets the Player's local time.|5=<pre>Space.Host.ExecutingObject.Animator.SetTime(1.0)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|void|SetTrigger|(int id);|Sets a trigger parameter to active. A trigger parameter is a bool parameter that gets reset to false when it has been used in a transition. For state machines with multiple layers, the trigger will only get reset once all layers have been evaluated, so that the layers can synchronize their transitions on the same parameter.|5=<pre></pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|void|SetTrigger|(string trigger);|Sets a trigger parameter to active. A trigger parameter is a bool parameter that gets reset to false when it has been used in a transition. For state machines with multiple layers, the trigger will only get reset once all layers have been evaluated, so that the layers can synchronize their transitions on the same parameter.|5=<pre>Space.Host.ExecutingObject.Animator.SetTrigger("parameterName")</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|void|StartPlayback|();|Sets the animator in playback mode.|5=<pre>Space.Host.ExecutingObject.Animator.StartPlayback()</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|void|Stop|();|Stop the Animator.|5=<pre>Space.Host.ExecutingObject.Animator.Stop()</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|void|StopPlayback|();|Stops the animator playback mode. When playback stops, the avatar resumes getting control from game logic.|5=<pre>Space.Host.ExecutingObject.Animator.StopPlayback()</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|void|Update|(float deltaTime);|Evaluates the animator based on deltaTime.|5=<pre>Space.Host.ExecutingObject.Animator.Update(Space.DeltaTime)</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | | + | |
| − | | + | |
| − | ==Properties==
| + | |
| − | {{ScriptFunction|bool|ApplyRootMotion|{ get;set; }|Should root motion be applied?
| + | |
| − | Root motion is the effect where an object's entire mesh moves away from its starting point but that motion is created by the animation itself rather than by changing the Transform position.|5=<pre>Space.Host.ExecutingObject.Animator.ApplyRootMotion = true</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|SResource|Controller|{ get;set; }|The Animator Controller resource of this Animator|5=<pre>Space.Host.ExecutingObject.Animator.Controller = Space.GetResource("newController")</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|bool|Enabled|{ get;set; }|Whether this is visually visible or not.|5=<pre>Space.Host.ExecutingObject.Animator.Enabled = true</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | {{ScriptFunction|string[]|Parameters|{ get;set; }|The AnimatorControllerParameter list used by the animator.|5=<pre>parameters = Space.Host.ExecutingObject.Animator.Parameters
| + | |
| − | for i=1,#parameters do Space.Log(parameters[i]) end --prints all parameters</pre>}}
| + | |
| − | | + | |
| − | {{Scripting Navbox}}
| + | |
