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

AnimancerEvent.

AnimancerEvent.Dispatcher Class

Summary

A system which triggers events in an Animancer.AnimancerEvent.Sequence based on a target Animancer.AnimancerEvent.Dispatcher.State.
Assembly
Animancer.dll
Namespace
Animancer
Interfaces
Base Types
  • Object
graph BT Type-->Base0["Object"] Type-.->Interface0["IHasDescription"] click Interface0 "/animancer-v7-4/api/Animancer/IHasDescription" Type["AnimancerEvent.Dispatcher"] class Type type-node

Syntax

public class AnimancerEvent.Dispatcher : IHasDescription

Remarks

Dispatchers are intended to always be object pooled and never directly accessed by external code.

Properties

Name Value Summary
Events AnimancerEvent.Sequence
The events managed by this dispatcher.
GotEventsFromPool bool
Were the Animancer.AnimancerEvent.Dispatcher.Events retrieved from the Sequence.Pool?
MaximumFullLoopCount int
The maximum number of times a looping animation can trigger all of its events in a single frame. Default 3, Minimum 1.
static
SharedEvents AnimancerEvent.Sequence
The events managed by this dispatcher.
State AnimancerState
Events will be triggered based on the Animancer.AnimancerState.NormalizedTime.

Methods

Name Value Summary
AppendDescription(StringBuilder, string) void
Appends a detailed descrption of the current details of this object.
DismissEventOwnership() void
Sets Animancer.AnimancerEvent.Dispatcher.GotEventsFromPool to false which indicates that the events aren't owned by the target state.
SetEvents(AnimancerEvent.Sequence) void
Sets the Animancer.AnimancerEvent.Dispatcher.Events to be managed by this dispatcher.
ToString() string
Returns "Animancer.AnimancerEvent.Dispatcher (Target State)".
UpdateEvents(bool) void