TimeSynchronisationGroup Class

Summary

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

Syntax

public class TimeSynchronisationGroup : HashSet<Object>

Examples

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

Constructors

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

Properties

Name Value Summary
Animancer AnimancerComponent
The Animancer.AnimancerComponent this group is synchronising.
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.TimeSynchronisationGroup.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.TimeSynchronisationGroup.NormalizedTime to the Animancer.TimeSynchronisationGroup.Animancer's current state if the `key` is in this group.
SyncTime(Object, AnimancerState) bool
Applies the Animancer.TimeSynchronisationGroup.NormalizedTime to the `state` if the `key` is in this group.
SyncTime(Object, AnimancerState, float) bool
Applies the Animancer.TimeSynchronisationGroup.NormalizedTime to the `state` if the `key` is in this group.
SyncTime(Object, float) bool
Applies the Animancer.TimeSynchronisationGroup.NormalizedTime to the Animancer.TimeSynchronisationGroup.Animancer's current state if the `key` is in this group.