com.almasb.fxgl.ai.fsm

Interface State<E>

Type Parameters:

E - is the type of the entity handled by this state machine

public interface State<E>

The state of a state machine defines the logic of the entities that enter, exit and last this state. Additionally, a state may be delegated by an entity to handle its messages.

Author:

davebaol

Method Summary

Modifier and Type	Method and Description
void	enter(E entity) This method will execute when the state is entered.
void	exit(E entity) This method will execute when the state is exited.
boolean	onMessage(E entity, Telegram telegram) This method executes if the entity receives a telegram from the message dispatcher while it is in this state.
void	update(E entity) This is the state's normal update function.

Method Detail

enter

void enter(E entity)

This method will execute when the state is entered.

Parameters:

entity - the entity entering the state

update

void update(E entity)

This is the state's normal update function.

Parameters:

entity - the entity lasting the state

exit

void exit(E entity)

This method will execute when the state is exited.

Parameters:

entity - the entity exiting the state

onMessage

boolean onMessage(E entity,
                  Telegram telegram)

This method executes if the entity receives a telegram from the message dispatcher while it is in this state.

Parameters:

entity - the entity that received the message

telegram - the message sent to the entity

Returns:

true if the message has been successfully handled; false otherwise.