Class State

The base class which handles in-context states.

Inheritance
System.Object
TypeCastObject<EObject>
EObject
EActor
State
Implements
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Exiled.API.Features.Core.StateMachine
Assembly: Exiled.API.dll
Syntax
public abstract class State : EActor, IEntity, IWorldSpace, IPosition, IRotation, IState

Properties

| Improve this Doc View Source

ActiveControllers

Gets all the StateControllers running on this State.

Declaration
public IEnumerable<StateController> ActiveControllers { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<StateController>
| Improve this Doc View Source

Controllers

Gets all the StateControllers listening to this State.

Declaration
public IEnumerable<StateController> Controllers { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<StateController>
| Improve this Doc View Source

Description

Declaration
public virtual string Description { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Id

Declaration
public abstract byte Id { get; }
Property Value
Type Description
System.Byte
| Improve this Doc View Source

InactiveControllers

Gets all the StateControllers running on a State other than this.

Declaration
public IEnumerable<StateController> InactiveControllers { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<StateController>
| Improve this Doc View Source

List

Gets all registered states.

Declaration
public static IEnumerable<State> List { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<State>
| Improve this Doc View Source

Name

Declaration
public virtual string Name { get; }
Property Value
Type Description
System.String

Methods

| Improve this Doc View Source

Get(Byte)

Gets the State belonging to the specified id.

Declaration
public static State Get(byte id)
Parameters
Type Name Description
System.Byte id

The state's id.
Returns
Type Description
State

The corresponding State, or null if not found.
| Improve this Doc View Source

Get(Byte, Byte)

Gets the States belonging to the specified id between the defined range.

Declaration
public static IEnumerable<State> Get(byte minRange, byte maxRange)
Parameters
Type Name Description
System.Byte minRange

The minimum inclusive range.
System.Byte maxRange

The maximum exclusive range.
Returns
Type Description
System.Collections.Generic.IEnumerable<State>

All States belonging to the specified id between the specified range.
| Improve this Doc View Source

Get(Byte[])

Gets the States belonging to the specified id between the defined ids.

Declaration
public static IEnumerable<State> Get(params byte[] ids)
Parameters
Type Name Description
System.Byte[] ids

The ids to look for.
Returns
Type Description
System.Collections.Generic.IEnumerable<State>

All States belonging to the specified id between the defined ids.
| Improve this Doc View Source

Get(String)

Gets the State belonging to the specified name.

Declaration
public static State Get(string name)
Parameters
Type Name Description
System.String name

The state's name.
Returns
Type Description
State

The corresponding State, or null if not found.
| Improve this Doc View Source

Get(String[])

Gets the States belonging to the specified id between the defined names.

Declaration
public static IEnumerable<State> Get(params string[] names)
Parameters
Type Name Description
System.String[] names

The names to look for.
Returns
Type Description
System.Collections.Generic.IEnumerable<State>

All States belonging to the specified id between the defined names.
| Improve this Doc View Source

Get(Type)

Gets the State belonging to the specified System.Type.

Declaration
public static State Get(Type type)
Parameters
Type Name Description
System.Type type

The state's System.Type.
Returns
Type Description
State

The corresponding State, or null if not found.
| Improve this Doc View Source

Get(Type[])

Gets the States belonging to the specified id between the defined types.

Declaration
public static IEnumerable<State> Get(params Type[] types)
Parameters
Type Name Description
System.Type[] types

The types to look for.
Returns
Type Description
System.Collections.Generic.IEnumerable<State>

All States belonging to the specified id between the defined types.
| Improve this Doc View Source

Get<T>()

Gets the State belonging to the specified type T.

Declaration
public static T Get<T>()

    where T : State
Returns
Type Description
T

The corresponding State, or null if not found.
Type Parameters
Name Description
T

The type to look for.
| Improve this Doc View Source

InitializeStates(Boolean)

Initializes all states defined in the executing System.Reflection.Assembly.

Declaration
public static void InitializeStates(bool useAttribute = true)
Parameters
Type Name Description
System.Boolean useAttribute

A value indicating whether attribute should be used.
| Improve this Doc View Source

OnEnter(StateController)

Declaration
public virtual void OnEnter(StateController stateController)
Parameters
Type Name Description
StateController stateController
| Improve this Doc View Source

OnExit(StateController)

Declaration
public virtual void OnExit(StateController stateController)
Parameters
Type Name Description
StateController stateController
| Improve this Doc View Source

Tick()

Declaration
protected override void Tick()
Overrides
| Improve this Doc View Source

ToString()

Converts the State to a human readable System.String representation.

Declaration
public override string ToString()
Returns
Type Description
System.String

A human readable System.String representation of the State object.
Overrides
System.Object.ToString()
| Improve this Doc View Source

TryGet(Byte, out State)

Tries to get a State given the specified id.

Declaration
public static bool TryGet(byte id, out State state)
Parameters
Type Name Description
System.Byte id

The state's id.
State state

The corresponding State, or null if not found.
Returns
Type Description
System.Boolean

true if a State was found; otherwise, false.
| Improve this Doc View Source

TryGet(String, out State)

Tries to get a State given the specified name.

Declaration
public static bool TryGet(string name, out State state)
Parameters
Type Name Description
System.String name

The state's name.
State state

The corresponding State, or null if not found.
Returns
Type Description
System.Boolean

true if a State was found; otherwise, false.
| Improve this Doc View Source

TryGet(Type, out State)

Tries to get a State given the specified System.Type.

Declaration
public static bool TryGet(Type type, out State state)
Parameters
Type Name Description
System.Type type

The state's System.Type.
State state

The corresponding State, or null if not found.
Returns
Type Description
System.Boolean

true if a State was found; otherwise, false.
| Improve this Doc View Source

TryGet<T>(out T)

Tries to get a State given the specified System.Type.

Declaration
public bool TryGet<T>(out T state)

    where T : State
Parameters
Type Name Description
T state

The corresponding State, or null if not found.
Returns
Type Description
System.Boolean

true if a State was found; otherwise, false.
Type Parameters
Name Description
T

The type to look for.

Implements

Extension Methods