org.imanity.imanityspigot.ai

Interface MobGoals

public interface MobGoals

Represents a part of the "brain" of a mob. It tracks all tasks (running or not), allows adding and removing goals

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MobGoals.EntityMobGoals<T extends Mob>

Method Summary

Modifier and Type	Method and Description
<T extends Mob> void	addGoal(T mob, int priority, @NotNull Goal<T> goal) Add a goal to the target mob
<T extends Mob> @NotNull Collection<Goal<T>>	getAllGoals(T mob) Get every goal instances from target mob
<T extends Mob> @NotNull Collection<Goal<T>>	getAllGoals(T mob, GoalType type) Get every goal instances based on goal type from target mob
<T extends Mob> @NotNull Collection<Goal<T>>	getAllGoalsWithout(T mob, GoalType type) Get every goal instances that aren't the specific type from target mob
<T extends Mob> @NotNull MobGoals.EntityMobGoals<T>	getEntityGoals(T mob) Wrap a instance of MobGoals for target mob
<T extends Mob> @Nullable Goal<T>	getGoal(T mob, @NotNull GoalKey<T> key) Get the goal instance based on key from target mob
<T extends Mob> @NotNull Collection<Goal<T>>	getGoals(T mob, @NotNull GoalKey<T> key) Get the goal instances based on key from target mob
<T extends Mob> @NotNull Collection<Goal<T>>	getRunningGoals(T mob) Get every running goals from target mob
<T extends Mob> @NotNull Collection<Goal<T>>	getRunningGoals(T mob, GoalType type) Get every running goals based on goal type from target mob
<T extends Mob> @NotNull Collection<Goal<T>>	getRunningGoalsWithout(T mob, GoalType type) Get every running goal instances that aren't the specific type from target mob
<T extends Mob> boolean	hasGoal(T mob, @NotNull GoalKey<T> key) Check if the mob has a goal with the key
<T extends Mob> void	removeAllGoals(T mob) Remove every goals from target mob
<T extends Mob> void	removeAllGoals(T mob, GoalType type) Remove every goals based on goal type from target mob
<T extends Mob> void	removeGoal(T mob, @NotNull Goal<T> goal) Remove a goal from the target mob
<T extends Mob> void	removeGoal(T mob, @NotNull GoalKey<T> key) Remove a goal based on key from target mob

Method Detail

addGoal

<T extends Mob> void addGoal(@NotNull
                             T mob,
                             int priority,
                             @NotNull
                             @NotNull Goal<T> goal)

Add a goal to the target mob

Type Parameters:

T - the type of Mob

Parameters:

mob - the Mob

priority - the Priority

goal - the Goal

removeGoal

<T extends Mob> void removeGoal(@NotNull
                                T mob,
                                @NotNull
                                @NotNull Goal<T> goal)

Remove a goal from the target mob

Type Parameters:

T - the type of Mob

Parameters:

mob - the Mob

goal - the Goal

removeAllGoals

<T extends Mob> void removeAllGoals(@NotNull
                                    T mob)

Remove every goals from target mob

Type Parameters:

T - the type of Mob

Parameters:

mob - the Mob

removeAllGoals

<T extends Mob> void removeAllGoals(@NotNull
                                    T mob,
                                    GoalType type)

Remove every goals based on goal type from target mob

Type Parameters:

T - the type of Mob

Parameters:

mob - the Mob

type - the type of Goal

removeGoal

<T extends Mob> void removeGoal(@NotNull
                                T mob,
                                @NotNull
                                @NotNull GoalKey<T> key)

Remove a goal based on key from target mob

Type Parameters:

T - the type of Mob

Parameters:

mob - the Mob

key - the Key of the Goal, If you are trying to remove a vanilla goal, See VanillaGoal

hasGoal

<T extends Mob> boolean hasGoal(@NotNull
                                T mob,
                                @NotNull
                                @NotNull GoalKey<T> key)

Check if the mob has a goal with the key

Type Parameters:

T - the type of Mob

Parameters:

mob - the Mob

key - the Key of the Goal, If you are trying to check a vanilla goal, See VanillaGoal

Returns:

true if mob has the goal

getGoal

@Nullable
<T extends Mob> @Nullable Goal<T> getGoal(@NotNull
                                                    T mob,
                                                    @NotNull
                                                    @NotNull GoalKey<T> key)

Get the goal instance based on key from target mob

Type Parameters:

T - the type of Mob

Parameters:

mob - the Mob

key - the Key of the Goal, If you are trying to find a vanilla goal, See VanillaGoal

Returns:

the Goal instance, null if no key matched

getGoals

@NotNull
<T extends Mob> @NotNull Collection<Goal<T>> getGoals(@NotNull
                                                               T mob,
                                                               @NotNull
                                                               @NotNull GoalKey<T> key)

Get the goal instances based on key from target mob

Type Parameters:

T - the type of Mob

Parameters:

mob - the Mob

key - the Key of the Goal, If you are trying to find vanilla goals, See VanillaGoal

Returns:

the Goal instances, empty if no key matched

getAllGoals

@NotNull
<T extends Mob> @NotNull Collection<Goal<T>> getAllGoals(@NotNull
                                                                  T mob)

Get every goal instances from target mob

Type Parameters:

T - the type of Mob

Parameters:

mob - the Mob

Returns:

the Goal instances

getAllGoals

@NotNull
<T extends Mob> @NotNull Collection<Goal<T>> getAllGoals(@NotNull
                                                                  T mob,
                                                                  GoalType type)

Get every goal instances based on goal type from target mob

Type Parameters:

T - the type of Mob

Parameters:

mob - the Mob

type - the type of Goal

Returns:

the Goal instances, empty if no type matched

getAllGoalsWithout

@NotNull
<T extends Mob> @NotNull Collection<Goal<T>> getAllGoalsWithout(@NotNull
                                                                         T mob,
                                                                         GoalType type)

Get every goal instances that aren't the specific type from target mob

Type Parameters:

T - the type of Mob

Parameters:

mob - the Mob

type - the type of Goal to filtered

Returns:

the Goal instances

getRunningGoals

@NotNull
<T extends Mob> @NotNull Collection<Goal<T>> getRunningGoals(@NotNull
                                                                      T mob)

Get every running goals from target mob

Type Parameters:

T - the type of Mob

Parameters:

mob - the Mob

Returns:

the Goal instances

getRunningGoals

@NotNull
<T extends Mob> @NotNull Collection<Goal<T>> getRunningGoals(@NotNull
                                                                      T mob,
                                                                      GoalType type)

Get every running goals based on goal type from target mob

Type Parameters:

T - the type of Mob

Parameters:

mob - the Mob

type - the type of Goal

Returns:

the Goal instances

getRunningGoalsWithout

@NotNull
<T extends Mob> @NotNull Collection<Goal<T>> getRunningGoalsWithout(@NotNull
                                                                             T mob,
                                                                             GoalType type)

Get every running goal instances that aren't the specific type from target mob

Type Parameters:

T - the type of Mob

Parameters:

mob - the Mob

type - the type of Goal to filtered

Returns:

the Goal instances

getEntityGoals

@NotNull
<T extends Mob> @NotNull MobGoals.EntityMobGoals<T> getEntityGoals(@NotNull
                                                                            T mob)

Wrap a instance of MobGoals for target mob

Type Parameters:

T - the type of Mob

Parameters:

mob - the Mob

Returns:

the wrapped MobGoals