Package com.minecolonies.api.entity.ai.statemachine.basestatemachine

Class BasicStateMachine<T extends IStateMachineTransition<S>,S extends IState>

java.lang.Object

com.minecolonies.api.entity.ai.statemachine.basestatemachine.BasicStateMachine<T,S>

All Implemented Interfaces:

IStateMachine<T,S>

Direct Known Subclasses:

TickRateStateMachine

public class BasicStateMachine<T extends IStateMachineTransition<S>,S extends IState>
extends Object
implements IStateMachine<T,S>

Basic statemachine class, can be used for any Transition typed which extends the transition interface. It contains the current state and a hashmap for events and transitions, which are the minimal requirements to have a working statemachine.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<T>	currentStateTransitions	The current states list of transitions
protected final @NotNull Map<IStateEventType,List<T>>	eventTransitionMap
protected final @NotNull Map<S,List<T>>	transitionMap	The lists of transitions and events

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BasicStateMachine(S initialState, @NotNull Consumer<RuntimeException> exceptionHandler)	Construct a new StateMachine

Method Summary

Modifier and Type	Method	Description
void	addTransition(T transition)	Add one transition
void	addTransitionGroup(List<S> stateGroup, T transition)	Add a transition to a group of states has higher priority than normal transitions
boolean	checkTransition(T transition)	Check the condition for a transition
net.minecraft.network.chat.Component	getHistory()	Get the state transition history for display
final S	getState()	Get the current state of the statemachine
protected void	onException(RuntimeException e)	Handle an exception higher up.
void	removeTransition(T transition)	Unregisters a transition
void	reset()	Resets the statemachine
void	setHistoryEnabled(boolean enabled, int memorySize)	Set whether the state history is tracked
void	tick()	Updates the statemachine.
boolean	transitionToNext(T transition)	Change the state to the next

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

transitionMap

@NotNull
protected final @NotNull Map<S extends IState,List<T extends IStateMachineTransition<S>>> transitionMap

The lists of transitions and events

eventTransitionMap

@NotNull
protected final @NotNull Map<IStateEventType,List<T extends IStateMachineTransition<S>>> eventTransitionMap

currentStateTransitions

protected List<T extends IStateMachineTransition<S>> currentStateTransitions

The current states list of transitions

Constructor Details

BasicStateMachine

protected BasicStateMachine(@NotNull
 S initialState,
 @NotNull
 @NotNull Consumer<RuntimeException> exceptionHandler)

Construct a new StateMachine

Parameters:

initialState - the initial state.

exceptionHandler - the exception handler.

Method Details

addTransition

public void addTransition(T transition)

Add one transition

Specified by:

addTransition in interface IStateMachine<T extends IStateMachineTransition<S>,S extends IState>

Parameters:

transition - the transition to add

addTransitionGroup

public void addTransitionGroup(List<S> stateGroup,
 T transition)

Description copied from interface: IStateMachine

Add a transition to a group of states has higher priority than normal transitions

Specified by:

addTransitionGroup in interface IStateMachine<T extends IStateMachineTransition<S>,S extends IState>

transition - the transition to add

removeTransition

public void removeTransition(T transition)

Unregisters a transition

Specified by:

removeTransition in interface IStateMachine<T extends IStateMachineTransition<S>,S extends IState>

Parameters:

transition - the transition to remove.

tick

public void tick()

Updates the statemachine.

Specified by:

tick in interface IStateMachine<T extends IStateMachineTransition<S>,S extends IState>

checkTransition

public boolean checkTransition(@NotNull
 T transition)

Check the condition for a transition

Specified by:

checkTransition in interface IStateMachine<T extends IStateMachineTransition<S>,S extends IState>

Parameters:

transition - the target to check

Returns:

true if this target worked and we should stop executing this tick

transitionToNext

public boolean transitionToNext(@NotNull
 T transition)

Description copied from interface: IStateMachine

Change the state to the next

Specified by:

transitionToNext in interface IStateMachine<T extends IStateMachineTransition<S>,S extends IState>

Parameters:

transition - the transition providing the state change

Returns:

true if the transition provided a state to change to, false on null

onException

protected void onException(RuntimeException e)

Handle an exception higher up.

Parameters:

e - The exception to be handled.

getState

public final S getState()

Get the current state of the statemachine

Specified by:

getState in interface IStateMachine<T extends IStateMachineTransition<S>,S extends IState>

Returns:

The current IAIState.

reset

public void reset()

Resets the statemachine

Specified by:

reset in interface IStateMachine<T extends IStateMachineTransition<S>,S extends IState>

setHistoryEnabled

public void setHistoryEnabled(boolean enabled,
 int memorySize)

Description copied from interface: IStateMachine

Set whether the state history is tracked

Specified by:

setHistoryEnabled in interface IStateMachine<T extends IStateMachineTransition<S>,S extends IState>

memorySize - amount of entries kept

getHistory

public net.minecraft.network.chat.Component getHistory()

Description copied from interface: IStateMachine

Get the state transition history for display

Specified by:

getHistory in interface IStateMachine<T extends IStateMachineTransition<S>,S extends IState>

Returns: