🎞️Frame Controller

Our SDK allows comprehensive control over user-generated emotes with features such as trimming animations, pausing/resuming, setting elapsed time, modifying play rates, and looping animations. Note that these features are not automatically networked; you must send the relevant information over your network layer and call the appropriate methods using our "Remote implementation."

Feature list	Quick description
Trimming animation	Remove a part of the start of the animation. Remove a part of the end of the animation. Or both simultaneously.
Resume / Pause	Pause the playing of the animation, freezing the avatar in place
Go to Time (Set Elapsed time)	Go to a specific point of the animation (in seconds)
Variable playrate / Play backward	Speed at which animation is played. Can be set to negative in order to play the animation backward
Loop animation	Enable or Disable the loop mode of the Kinetix-Animator

Please note that these features aren't automatically networked. You have to send the information over your network layer, and call the relevant methods via our "Remote implemenation"

Trimming animation

Trimming animation allows you to choose a part of the emote to be played, instead of playing the whole one. Remove a part of the start of the animation, at the end of the animation or both simultaneously.

The middle part ('Played part') of the animation will be played

Player implementation

void KinetixCore.Animation.PlayAnimationOnLocalPlayer(
    string _EmoteID,
    AnimationTimeRange _AnimationTimeRange
)

Example:

Let's say the emote is 10 seconds long and you want to play the animation from '3:00' to '5:00'

using Kinetix;

//Register local player (only use it if player wasn't registered)
KinetixCore.Animation.RegisterLocalPlayerAnimator( /* Arguments */ )

//Play emote from time '3:00' to time '5:00'
AnimationTimeRange timeRange = new AnimationTimeRange(3, 5);
KinetixCore.Animation.PlayAnimationOnLocalPlayer("my-Emote-ID", timeRange);

---

Example 2:

Let's say the emote is 10 seconds long and you want to play the animation from 3:00 to the end of the animation.

using Kinetix;

//Register local player (only use it if player wasn't registered)
KinetixCore.Animation.RegisterLocalPlayerAnimator( /* Arguments */ );

//Play animation from time '3:00' to the end of the animation
AnimationTimeRange timeRange = new AnimationTimeRange(3);
KinetixCore.Animation.PlayAnimationOnLocalPlayer("my-Emote-ID", timeRange);

NPC implementation

Remote implementation

Resume / Pause

Resume and pause the playing of an emote, freezing the player avatar. The SDK will keep its state. (elapsed time, loop mode, play rate, animation timeline, etc...)

Player implementation

void KinetixCore.Animation.SetPauseOnLocalPlayer(bool _Paused)

If _Paused is true, the SDK will pause the emote. If _Paused is false, the SDK will resume the playing of the emote.

NPC implementation

Remote implementation

Go to Time (Set Elapsed time)

Enables you to go to a certain time of the sampler. The elapsed time is expressed in seconds.

Player implementation

void KinetixCore.Animation.SetElapsedTimeOnLocalPlayer(float _ElapsedTime)

NPC implementation

Remote implementation

Variable playrate / Play backward

Modify the speed at which frames are read by the SDK. A negative number will make the SDK play the emote backward.

The SDK depends on the UnityEngine.Time.timeScale

If the playrate is negative before playing an animation. The animation will start from the end.

Player implementation

void KinetixCore.Animation.SetPlayRateOnLocalPlayer(
    float _PlayRate
)

Example:

using Kinetix;

//Register local player (only use it if player wasn't registered)
KinetixCore.Animation.RegisterLocalPlayerAnimator( /* Arguments */ );

//Play the animation two times faster
KinetixCore.Animation.SetPlayRateOnLocalPlayer(2);

//Play backward
KinetixCore.Animation.SetPlayRateOnLocalPlayer(-1);

NPC implementation

Remote implementation

Loop animation

Enable or disable loop mode for a player. When loop mode is enabled, the SDK will loop back to the start / end of the animation (depending on the playrate's sign)

Player implementation

void KinetixCore.Animation.SetLoopAnimationOnLocalPlayer(
    bool _Looping
)

NPC implementation

Remote implementation