Interface IState
Defines the contract for basic state features.
Namespace: Exiled.API.Features.Core.StateMachine
Assembly: Exiled.API.dll
Syntax
public interface IStateProperties
| Improve this Doc View SourceDescription
Gets the state's description.
Declaration
string Description { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Id
Gets the state's id.
Declaration
byte Id { get; }Property Value
| Type | Description |
|---|---|
| System.Byte |
Name
Gets the state's name.
Declaration
string Name { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Methods
| Improve this Doc View SourceOnEnter(StateController)
Fired when entering the state.
Declaration
void OnEnter(StateController stateController)Parameters
| Type | Name | Description |
|---|---|---|
| StateController | stateController | The state controller. |
OnExit(StateController)
Fired when exiting the state.
Declaration
void OnExit(StateController stateController)Parameters
| Type | Name | Description |
|---|---|---|
| StateController | stateController | The state controller. |