AnimancerState.

AnimancerState.Awaiter Class

Summary

A custom await or yield instruction to wait for a particular Animancer.AnimancerState.NormalizedTime to pass.
Assembly
Animancer.dll
Namespace
Animancer
Interfaces
  • IDisposable
  • IEnumerator
  • INotifyCompletion
  • IUpdatable
Base Types
  • Object
graph BT Type-->Base0["Object"] Type-.->Interface0["IDisposable"] Type-.->Interface1["IEnumerator"] Type-.->Interface2["INotifyCompletion"] Type-.->Interface3["IUpdatable"] click Interface3 "/animancer/api/Animancer/IUpdatable" Type["AnimancerState.Awaiter"] class Type type-node

Syntax

public class AnimancerState.Awaiter : IDisposable, IEnumerator, INotifyCompletion, IUpdatable

Fields

Name Constant Value Summary
Cancel
A token which can be used to cancel this awaitable.
NormalizedTime
The Animancer.AnimancerState.NormalizedTime being awaited.
ReleaseOnComplete
Should Animancer.AnimancerState.Awaiter.Pool.Release(Animancer.AnimancerState.Awaiter) be called when it finishes waiting?
State
The Animancer.AnimancerState this object is observing.

Properties

Name Value Summary
IsCompleted bool
Has this operation been completed?
WasSuccessful bool
Did the Animancer.AnimancerState.Awaiter.State successfully pass the Animancer.AnimancerState.Awaiter.NormalizedTime?

Methods

Name Value Summary
Acquire(AnimancerState, CancellationToken) AnimancerState.Awaiter
Acquires an instance from the Animancer.AnimancerState.Awaiter.Pool and initializes it.
static
CompleteAndReset(bool) void
Sets the result of this operation and triggers its async continuation.
End(AnimancerState, CancellationToken) AnimancerState.Awaiter
Returns an awaitable that will complete when the `state` passes its Animancer.AnimancerState.NormalizedEndTime or Animancer.AnimancerNode.IsInterrupted.
static
GetAwaiter() AnimancerState.Awaiter
Returns this.
GetResult() bool
Did the Animancer.AnimancerState.Awaiter.State successfully pass the Animancer.AnimancerState.Awaiter.NormalizedTime?
Initialize(AnimancerState) void
Prepares this object to await the specified `state`.
MoveNext() bool
Completes the awaitable and returns false if the Animancer.AnimancerState.Awaiter.State is no longer approaching the target Animancer.AnimancerState.Awaiter.NormalizedTime.
Name(AnimancerState, StringReference, CancellationToken) AnimancerState.Awaiter
[Pro-Only] Returns an awaitable that will complete when the named event is triggered or Animancer.AnimancerNode.IsInterrupted.
static
OnCompleted(Action) void
Sets the callback to invoke when the Animancer.AnimancerState.IsApproachingTime(System.Single) returns false.
Reset() void
Reverts this object to its default values so it can be reused.
Time(AnimancerState, float, CancellationToken) AnimancerState.Awaiter
Returns an awaitable that will complete when the specified time passed or Animancer.AnimancerNode.IsInterrupted.
static
Update() void
Completes the awaitable if the Animancer.AnimancerState.Awaiter.State is no longer approaching the target Animancer.AnimancerState.Awaiter.NormalizedTime.