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

Class TickRateStateMachine<S extends IState>

java.lang.Object

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

com.minecolonies.api.entity.ai.statemachine.tickratestatemachine.TickRateStateMachine<S>

All Implemented Interfaces:

IStateMachine<ITickingTransition<S>,S>, ITickRateStateMachine<S>

public class TickRateStateMachine<S extends IState>
extends BasicStateMachine<ITickingTransition<S>,S>
implements ITickRateStateMachine<S>

Statemachine with an added tickrate limiting of transitions, allowing transitions to be checked at a lower rate. Default tickrate is 20 tps (Minecraft default).

Field Summary

Fields

Modifier and Type	Field	Description
static double	slownessFactor	TPS factor of the server

Fields inherited from class com.minecolonies.api.entity.ai.statemachine.basestatemachine.BasicStateMachine

currentStateTransitions, eventTransitionMap, transitionMap

Constructor Summary

Constructors

Constructor	Description
TickRateStateMachine(S initialState, @NotNull Consumer<RuntimeException> exceptionHandler)	Construct a new StateMachine
TickRateStateMachine(S initialState, @NotNull Consumer<RuntimeException> exceptionHandler, int tickRate)	Construct a new StateMachine

Method Summary

Modifier and Type	Method	Description
boolean	checkTransition(@NotNull ITickingTransition<S> transition)	Check the condition for a transition
int	getTickRate()	Returns the current rate the statemachine is beeing ticked at.
void	setCurrentDelay(int ticksToNext)	Sets the delay to next execution for the currently executed transition
void	setTickRate(int tickRate)	Returns the current rate the statemachine is beeing ticked at.
void	tick()	Tick the statemachine.

Methods inherited from class com.minecolonies.api.entity.ai.statemachine.basestatemachine.BasicStateMachine

addTransition, addTransitionGroup, getHistory, getState, onException, removeTransition, reset, setHistoryEnabled, transitionToNext

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.minecolonies.api.entity.ai.statemachine.basestatemachine.IStateMachine

addTransition, addTransitionGroup, getHistory, getState, removeTransition, reset, setHistoryEnabled, transitionToNext

Field Details

slownessFactor

public static double slownessFactor

TPS factor of the server

Constructor Details

TickRateStateMachine

public TickRateStateMachine(@NotNull
 S initialState,
 @NotNull
 @NotNull Consumer<RuntimeException> exceptionHandler)

Construct a new StateMachine

Parameters:

initialState - the initial state.

exceptionHandler - the exception handler.

TickRateStateMachine

public TickRateStateMachine(@NotNull
 S initialState,
 @NotNull
 @NotNull Consumer<RuntimeException> exceptionHandler,
 int tickRate)

Construct a new StateMachine

Parameters:

initialState - the initial state.

exceptionHandler - the exception handler.

Method Details

tick

public void tick()

Tick the statemachine.

Specified by:

tick in interface IStateMachine<ITickingTransition<S extends IState>,S extends IState>

Specified by:

tick in interface ITickRateStateMachine<S extends IState>

Overrides:

tick in class BasicStateMachine<ITickingTransition<S extends IState>,S extends IState>

checkTransition

public boolean checkTransition(@NotNull
 @NotNull ITickingTransition<S> transition)

Check the condition for a transition

Specified by:

checkTransition in interface IStateMachine<ITickingTransition<S extends IState>,S extends IState>

Specified by:

checkTransition in interface ITickRateStateMachine<S extends IState>

Overrides:

checkTransition in class BasicStateMachine<ITickingTransition<S extends IState>,S extends IState>

Parameters:

transition - the target to check

Returns:

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

getTickRate

public int getTickRate()

Description copied from interface: ITickRateStateMachine

Returns the current rate the statemachine is beeing ticked at.

Specified by:

getTickRate in interface ITickRateStateMachine<S extends IState>

Returns:

the tickrate

setTickRate

public void setTickRate(int tickRate)

Description copied from interface: ITickRateStateMachine

Returns the current rate the statemachine is beeing ticked at.

Specified by:

setTickRate in interface ITickRateStateMachine<S extends IState>

Parameters:

tickRate - the tick rate to set.

setCurrentDelay

public void setCurrentDelay(int ticksToNext)

Description copied from interface: ITickRateStateMachine

Sets the delay to next execution for the currently executed transition

Specified by:

setCurrentDelay in interface ITickRateStateMachine<S extends IState>

Parameters:

ticksToNext -