Interface IState

Namespace

Exiled.API.Features.Core.StateMachine

Assembly

Exiled.API.dll

Defines the contract for basic state features.

public interface IState

Extension Methods

ReflectionExtensions.CopyProperties(object, object)

Properties

Description

Gets the state's description.

string Description { get; }

Property Value

string

Id

Gets the state's id.

byte Id { get; }

Property Value

byte

Name

Gets the state's name.

string Name { get; }

Property Value

string

Methods

OnEnter(StateController)

Fired when entering the state.

void OnEnter(StateController stateController)

Parameters

stateController StateController

The state controller.

OnExit(StateController)

Fired when exiting the state.

void OnExit(StateController stateController)

Parameters

stateController StateController

The state controller.