This is the old Animancer v7.4 documentation. Click here for the latest version.

TimeSynchronizationGroup Class

Summary

A system for synchronizing the Animancer.AnimancerState.NormalizedTime of certain animations.
Assembly
Animancer.dll
Namespace
Animancer
Base Types
  • HashSet<Object>
graph BT Type-->Base0["HashSet<Object>"] Type["TimeSynchronizationGroup"] class Type type-node

Syntax

public class TimeSynchronizationGroup : HashSet<Object>

Examples

  1. Initialize a by adding any objects you want to synchronize.
  2. Call any of the methods before playing a new animation.
  3. Call any of the methods after playing that animation.
Example: Character Controller -> Synchronization

Constructors

Name Summary
TimeSynchronizationGroup(AnimancerComponent) Creates a new Animancer.TimeSynchronizationGroup and sets its Animancer.TimeSynchronizationGroup.Animancer.

Properties

Name Value Summary
Animancer AnimancerComponent
The Animancer.AnimancerComponent this group is synchronizing.
NormalizedTime Nullable<float>
The stored Animancer.AnimancerState.NormalizedTime or null if no value was stored.

Methods

Name Value Summary
StoreTime(Object) bool
Stores the Animancer.AnimancerState.NormalizedTime of the Animancer.TimeSynchronizationGroup.Animancer's current state if the `key` is in this group.
StoreTime(Object, AnimancerState) bool
Stores the Animancer.AnimancerState.NormalizedTime of the `state` if the `key` is in this group.
SyncTime(Object) bool
Applies the Animancer.TimeSynchronizationGroup.NormalizedTime to the Animancer.TimeSynchronizationGroup.Animancer's current state if the `key` is in this group.
SyncTime(Object, AnimancerState) bool
Applies the Animancer.TimeSynchronizationGroup.NormalizedTime to the `state` if the `key` is in this group.
SyncTime(Object, AnimancerState, float) bool
Applies the Animancer.TimeSynchronizationGroup.NormalizedTime to the `state` if the `key` is in this group.
SyncTime(Object, float) bool
Applies the Animancer.TimeSynchronizationGroup.NormalizedTime to the Animancer.TimeSynchronizationGroup.Animancer's current state if the `key` is in this group.