AnimancerEvent Struct

Summary

A Animancer.AnimancerEvent.callback delegate paired with a Animancer.AnimancerEvent.normalizedTime to determine when to invoke it.
Assembly
Animancer.dll
Namespace
Animancer
Interfaces
Base Types
  • ValueType
graph BT Type-->Base0["ValueType"] Type-.->Interface0["IEquatable<AnimancerEvent>"] Type["AnimancerEvent"] class Type type-node

Syntax

public struct AnimancerEvent : ValueType, IEquatable<AnimancerEvent>

Remarks

Documentation: Animancer Events

Constructors

Name Summary
AnimancerEvent(float, Action) Creates a new Animancer.AnimancerEvent.

Fields

Name Constant Value Summary
AlmostOne 0.9999999
The largest possible float value less than 1.
static
callback
The delegate to invoke when the Animancer.AnimancerEvent.normalizedTime passes.
DummyCallback
Does nothing.
static
normalizedTime
The Animancer.AnimancerState.NormalizedTime at which to invoke the Animancer.AnimancerEvent.callback.

Properties

Name Value Summary
CurrentEvent AnimancerEvent
The Animancer.AnimancerEvent currently being triggered via Animancer.AnimancerEvent.Invoke(Animancer.AnimancerState).
static
CurrentState AnimancerState
The Animancer.AnimancerState currently triggering an event via Animancer.AnimancerEvent.Invoke(Animancer.AnimancerState).
static

Methods

Name Value Summary
AppendDetails(StringBuilder) void
Appends the details of this event to the `text`.
Equals(AnimancerEvent) bool
[System.IEquatable`1] Are the Animancer.AnimancerEvent.normalizedTime and Animancer.AnimancerEvent.callback of this event equal to `other`?
Equals(Object) bool
GetFadeOutDuration() float
Returns either the Animancer.AnimancerPlayable.DefaultFadeDuration or the Animancer.AnimancerState.RemainingDuration of the Animancer.AnimancerEvent.CurrentState (whichever is higher).
static
GetFadeOutDuration(AnimancerState, float) float
Returns either the `minDuration` or the Animancer.AnimancerState.RemainingDuration of the `state` (whichever is higher).
static
GetFadeOutDuration(float) float
Returns either the `minDuration` or the Animancer.AnimancerState.RemainingDuration of the Animancer.AnimancerEvent.CurrentState (whichever is higher).
static
GetHashCode() int
Invoke(AnimancerState) void
Sets the Animancer.AnimancerEvent.CurrentState and Animancer.AnimancerEvent.CurrentEvent then invokes the Animancer.AnimancerEvent.callback.
IsNullOrDummy(Action) bool
Is the `callback` null or the Animancer.AnimancerEvent.DummyCallback?
static
ToString() string
Returns a string describing the details of this event.

Operators

Name Value Summary
operator !=(AnimancerEvent, AnimancerEvent) bool
operator ==(AnimancerEvent, AnimancerEvent) bool