KeyChange<TKey> Struct

Summary

A static access point for the details of a key change in a Animancer.FSM.StateMachine`2.
Assembly
Animancer.dll
Namespace
Animancer.FSM
Interfaces
  • IDisposable
Base Types
  • ValueType
graph BT Type-->Base0["ValueType"] Type-.->Interface0["IDisposable"] Type["KeyChange<TKey>"] class Type type-node

Syntax

public struct KeyChange<TKey> : ValueType, IDisposable

Remarks

This system is thread-safe.

Documentation: Changing States

Type Parameters

Name Description
TKey

Properties

Name Value Summary
IsActive bool
Is a Animancer.FSM.KeyChange`1 of this type currently occurring?
static
NextKey TKey
The key being changed into.
static
PreviousKey TKey
The key being changed from.
static
StateMachine IKeyedStateMachine<TKey>
The Animancer.FSM.KeyChange`1 in which the current change is occurring.
static

Methods

Name Value Summary
CurrentToString() string
Returns a string describing the contents of the current Animancer.FSM.KeyChange`1.
static
Dispose() void
[System.IDisposable] Re-assigns the values of this change (which were the previous values from when it was created) to be the currently active change. See the constructor for recommended usage.
ToString() string
Returns a string describing the contents of this Animancer.FSM.KeyChange`1.