Class State

Namespace

Exiled.API.Features.Core.StateMachine

Assembly

Exiled.API.dll

The base class which handles in-context states.

public abstract class State : EActor, IEntity, IWorldSpace, IPosition, IRotation, IState

Inheritance

object

TypeCastObject<EObject>

EObject

EActor

State

Implements

IEntity

IWorldSpace

IPosition

IRotation

IState

Inherited Members

EActor.DefaultFixedTickRate

EActor.ComponentsInChildren

EActor.Transform

EActor.Position

EActor.Rotation

EActor.Scale

EActor.CanEverTick

EActor.FixedTickRate

EActor.ComponentsInParent

EActor.AttachTo(EActor, GameObject)

EActor.AttachTo(EActor, EActor)

EActor.AddComponent<T>(string)

EActor.AddComponent(Type, string)

EActor.AddComponent<T>(Type, string)

EActor.GetComponent(Type)

EActor.GetComponent<T>()

EActor.GetComponent<T>(Type)

EActor.TryGetComponent<T>(Type, out T)

EActor.TryGetComponent<T>(out T)

EActor.TryGetComponent(Type, out EActor)

EActor.HasComponent<T>(bool)

EActor.HasComponent(Type, bool)

EActor.PostInitialize()

EActor.OnBeginPlay()

EActor.OnEndPlay()

EActor.SubscribeEvents()

EActor.UnsubscribeEvents()

EActor.OnBeginDestroy()

EObject.RegisteredTypes

EObject.Base

EObject.Tag

EObject.IsEditable

EObject.GetObjectTypeByName(string)

EObject.RegisterObjectType<T>(string)

EObject.RegisterObjectType(Type, string)

EObject.UnregisterObjectType(Type)

EObject.UnregisterObjectType(string)

EObject.FindObjectDefinedTypeByName(string, bool)

EObject.GetObjectTypeFromRegisteredTypes<T>()

EObject.GetObjectTypeFromRegisteredTypes<T>(string)

EObject.GetObjectTypeFromRegisteredTypes(Type)

EObject.GetObjectTypeFromRegisteredTypes(Type, string)

EObject.GetObjectTypeFromRegisteredTypesByName(string)

EObject.CreateDefaultSubobject(Type, params object[])

EObject.CreateDefaultSubobject<T>(Type)

EObject.CreateDefaultSubobject<T>()

EObject.CreateDefaultSubobject<T>(params object[])

EObject.CreateDefaultSubobject<T>(GameObject, string)

EObject.CreateDefaultSubobject<T>(GameObject, string, params object[])

EObject.CreateDefaultSubobject<T>(Type, GameObject, string)

EObject.CreateDefaultSubobject<T>(Type, GameObject, string, params object[])

EObject.CreateDefaultSubobject(Type, GameObject, string)

EObject.CreateDefaultSubobject(Type, GameObject, string, params object[])

EObject.DestroyAllObjects()

EObject.DestroyAllObjectsOfType<T>()

EObject.FindActiveObjectOfType<T>(Func<EObject, bool>)

EObject.FindActiveObjectsOfType<T>(Func<EObject, bool>)

EObject.FindActiveObjectsOfType<T>()

EObject.FindActiveObjectsOfType<T>(string)

EObject.FindActiveObjectsOfType<T>(Type)

EObject.FindActiveObjectsOfType<T>(Type, Func<EObject, bool>)

EObject.FindActiveObjectsWithTagOfType<T>(string)

EObject.FindActiveObjectsOfType<T>(Func<object, bool>)

EObject.FindActiveObjectsOfType<T>(Func<T, bool>)

EObject.DestroyActiveObjectsOfType<T>()

EObject.DestroyActiveObject<T>(GameObject)

EObject.DestroyActiveObject(Type, GameObject)

EObject.FindMostAppropriateEntry<T>(string, IEnumerable<T>)

EObject.Destroy()

EObject.GetHashCode()

EObject.Equals(object)

EObject.Destroy(bool)

EObject.OnDestroyed()

TypeCastObject<EObject>.Cast<TObject>()

TypeCastObject<EObject>.Cast<TObject>(out TObject)

TypeCastObject<EObject>.As<TObject>()

TypeCastObject<EObject>.Is<TObject>(out TObject)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

object.MemberwiseClone()

Extension Methods

ReflectionExtensions.CopyProperties(object, object)

Properties

ActiveControllers

Gets all the StateControllers running on this State.

public IEnumerable<StateController> ActiveControllers { get; }

Property Value

IEnumerable<StateController>

Controllers

Gets all the StateControllers listening to this State.

public IEnumerable<StateController> Controllers { get; }

Property Value

IEnumerable<StateController>

Description

Gets the state's description.

public virtual string Description { get; }

Property Value

string

Id

Gets the state's id.

public abstract byte Id { get; }

Property Value

byte

InactiveControllers

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

public IEnumerable<StateController> InactiveControllers { get; }

Property Value

IEnumerable<StateController>

List

Gets all registered states.

public static IEnumerable<State> List { get; }

Property Value

IEnumerable<State>

Name

Gets the state's name.

public virtual string Name { get; }

Property Value

string

Methods

Get(byte)

Gets the State belonging to the specified id.

public static State Get(byte id)

Parameters

id byte

The state's id.

Returns

State

The corresponding State, or null if not found.

Get(byte, byte)

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

public static IEnumerable<State> Get(byte minRange, byte maxRange)

Parameters

minRange byte

The minimum inclusive range.

maxRange byte

The maximum exclusive range.

Returns

IEnumerable<State>

All States belonging to the specified id between the specified range.

Get(params byte[])

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

public static IEnumerable<State> Get(params byte[] ids)

Parameters

ids byte[]

The ids to look for.

Returns

IEnumerable<State>

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

Get(string)

Gets the State belonging to the specified name.

public static State Get(string name)

Parameters

name string

The state's name.

Returns

State

The corresponding State, or null if not found.

Get(params string[])

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

public static IEnumerable<State> Get(params string[] names)

Parameters

names string[]

The names to look for.

Returns

IEnumerable<State>

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

Get(Type)

Gets the State belonging to the specified Type.

public static State Get(Type type)

Parameters

type Type

The state's Type.

Returns

State

The corresponding State, or null if not found.

Get(params Type[])

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

public static IEnumerable<State> Get(params Type[] types)

Parameters

types Type[]

The types to look for.

Returns

IEnumerable<State>

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

Get<T>()

Gets the State belonging to the specified type T.

public static T Get<T>() where T : State

Returns

T

The corresponding State, or null if not found.

Type Parameters

T

The type to look for.

InitializeStates(bool)

Initializes all states defined in the executing Assembly.

public static void InitializeStates(bool useAttribute = true)

Parameters

useAttribute bool

A value indicating whether attribute should be used.

OnEnter(StateController)

Fired when entering the state.

public virtual void OnEnter(StateController stateController)

Parameters

stateController StateController

The state controller.

OnExit(StateController)

Fired when exiting the state.

public virtual void OnExit(StateController stateController)

Parameters

stateController StateController

The state controller.

Tick()

Fired every tick.

protected override void Tick()

ToString()

Converts the State to a human readable string representation.

public override string ToString()

Returns

string

A human readable string representation of the State object.

TryGet(byte, out State)

Tries to get a State given the specified id.

public static bool TryGet(byte id, out State state)

Parameters

id byte

The state's id.

state State

The corresponding State, or null if not found.

Returns

bool

true if a State was found; otherwise, false.

TryGet(string, out State)

Tries to get a State given the specified name.

public static bool TryGet(string name, out State state)

Parameters

name string

The state's name.

state State

The corresponding State, or null if not found.

Returns

bool

true if a State was found; otherwise, false.

TryGet(Type, out State)

Tries to get a State given the specified Type.

public static bool TryGet(Type type, out State state)

Parameters

type Type

The state's Type.

state State

The corresponding State, or null if not found.

Returns

bool

true if a State was found; otherwise, false.

TryGet<T>(out T)

Tries to get a State given the specified Type.

public bool TryGet<T>(out T state) where T : State

Parameters

state T

The corresponding State, or null if not found.

Returns

bool

true if a State was found; otherwise, false.

Type Parameters

T

The type to look for.