BGC Tools
Public Member Functions | Protected Member Functions
BGC.StateMachine.EmptyState Class Reference

Simplest state possible - effectively featureless More...

Inheritance diagram for BGC.StateMachine.EmptyState:
Inheritance graph
[legend]
Collaboration diagram for BGC.StateMachine.EmptyState:
Collaboration graph
[legend]

Public Member Functions

 EmptyState ()
 
 EmptyState (string name)
 
- Public Member Functions inherited from BGC.StateMachine.State
 State ()
 Create a state with the default name More...
 
 State (string name)
 Create a state with a custom name rather than the default More...
 
void OnEnter ()
 Called when the state is entered More...
 
void OnExit ()
 Called when the state is exited, before the next state is entered More...
 
virtual void Update ()
 This can be called every frame or whenever for complex states that have behavior on a frame by X basis. More...
 
void SetVerbose (bool isVerbose)
 Set whether the state machine is verbose or not More...
 

Protected Member Functions

override void OnStateEnter ()
 Called when the state is entered More...
 
- Protected Member Functions inherited from BGC.StateMachine.State
virtual void OnStateExit ()
 Called when the state is exited before the next state is entered More...
 

Additional Inherited Members

- Protected Attributes inherited from BGC.StateMachine.State
virtual string DefaultName => "State"
 
- Properties inherited from BGC.StateMachine.State
string Name [get, private set]
 Name of the state. This will either be user defined or the default state name depending on the constructor used More...
 

Detailed Description

Simplest state possible - effectively featureless

Definition at line 6 of file EmptyState.cs.

Constructor & Destructor Documentation

◆ EmptyState() [1/2]

BGC.StateMachine.EmptyState.EmptyState ( )
inline

Definition at line 8 of file EmptyState.cs.

8  : base()
9  {
10  }

◆ EmptyState() [2/2]

BGC.StateMachine.EmptyState.EmptyState ( string  name)
inline

Definition at line 12 of file EmptyState.cs.

12 : base(name) { }

Member Function Documentation

◆ OnStateEnter()

override void BGC.StateMachine.EmptyState.OnStateEnter ( )
inlineprotectedvirtual

Called when the state is entered

Implements BGC.StateMachine.State.

Definition at line 13 of file EmptyState.cs.

13 { }

The documentation for this class was generated from the following file: