StateChange<TState> Struct

Summary

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

Syntax

public struct StateChange<TState> : ValueType, IDisposable where TState : class, IState

Remarks

This system is thread-safe.

Documentation: Changing States

Type Parameters

Name Description
TState

Properties

Name Value Summary
IsActive bool
Is a Animancer.FSM.StateChange`1 of this type currently occurring?
static
NextState TState
The state being changed into.
static
PreviousState TState
The state currently being changed from.
static
StateMachine StateMachine<TState>
The Animancer.FSM.StateMachine`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.StateChange`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.StateChange`1.