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

IHasDescription

Base Types

Object

graph BT Type-->Base0["Object"] Type-.->Interface0["IHasDescription"] click Interface0 "/animancer/api/Animancer/IHasDescription" Type["AnimancerEvent.Dispatcher"] class Type type-node

Syntax

public class AnimancerEvent.Dispatcher : IHasDescription

Constructors

Name	Summary
Dispatcher(AnimancerState)	Creates a new `Animancer.AnimancerEvent.Dispatcher`.

Fields

Name	Constant Value	Summary
State		The target state.

Properties

Name	Value	Summary
Events	AnimancerEvent.Sequence	`Animancer.AnimancerState.OwnedEvents` and `Animancer.AnimancerState.SharedEvents`.
HasOwnEvents	bool	`Animancer.AnimancerState.HasOwnedEvents`
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

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.HasOwnEvents` to `false`.
FinishImmediately()	void	Sets the `Animancer.AnimancerState.NormalizedTime` to the `Animancer.AnimancerState.NormalizedEndTime` and invokes any remaining `Animancer.AnimancerEvent`s.
InitializeEvents(AnimancerEvent.Sequence)	bool	`Animancer.AnimancerState.Events(System.Object,Animancer.AnimancerEvent.Sequence@)`.
SetEvents(AnimancerEvent.Sequence, bool)	void	Setters for `Animancer.AnimancerState.OwnedEvents` and `Animancer.AnimancerState.SharedEvents`.
ToString()	string	Returns "`Animancer.AnimancerEvent.Dispatcher` (Target State)".
UpdateEvents(bool)	void