Package me.gamercoder215.mobchip.ai.behavior

Interface EntityBehavior

All Known Subinterfaces:

AllayBehavior, AxolotlBehavior, BreezeBehavior, CamelBehavior, CreatureBehavior, DragonBehavior, FrogBehavior, PiglinBehavior, VillagerBehavior, WardenBehavior

public interface EntityBehavior

Represents Entity Behavior.

Typically, behaviors require certain Memory objects to be present, not present, or registered in the native Minecraft Registry, and they will default to nothing if they are not present.

Some behaviors will set these memories for you. Those methods will be indicated when necessary.

See Also:

• MemoryStatus

Method Summary

Modifier and Type	Method	Description
default @NotNull BehaviorResult	backupIfClose(int minDistance)	Makes this Mob back up if it is too close, with no speed modifier.
@NotNull BehaviorResult	backupIfClose(int minDistance, float speedModifier)	Makes this Mob back up if it is too close.
@NotNull BehaviorResult	eraseIf(@NotNull Predicate<Mob> function, @NotNull Memory<?> memory)	Erases a memory if function returns true.
@NotNull BehaviorResult	interactWithDoor()	Makes this Mob interact with the nearest door.
default @NotNull BehaviorResult	jumpOnBed()	Makes this Mob jump on a Bed, with no speed Modifier.
@NotNull BehaviorResult	jumpOnBed(float speedMod)	Makes this Mob jump on a Bed.
default @NotNull BehaviorResult	meleeAttack()	Makes this Mob perform a Melee Attack, with a cooldown of 3 seconds (60 ticks).
@NotNull BehaviorResult	meleeAttack(int cooldown)	Makes this Mob perform a Melee Attack.
default @NotNull BehaviorResult	moveToWantedItem(int minDist)	Makes this Entity move to its wanted item, with no speed modifier.
default @NotNull BehaviorResult	moveToWantedItem(int minDist, float speedMod)	Makes this Entity move to its wanted item, with requireTarget set to true.
@NotNull BehaviorResult	moveToWantedItem(int minDist, float speedMod, boolean requireTarget)	Makes this Entity move to its wanted item.
@NotNull BehaviorResult	passiveIf(@NotNull Memory<?> memory, int durationTicks)	Makes this Entity become Passive is a Memory is present.
@NotNull BehaviorResult	reactToBell()	Makes this Mob react to a Bell ringing, symbolizing an incoming raid.
@NotNull BehaviorResult	ringBell()	Makes this Mob ring the nearest bell.
@NotNull BehaviorResult	sleep()	Makes this Mob sleep in a bed.
@NotNull BehaviorResult	socializeAtBell()	Makes this Mob socialize at the Village's Bell.
@NotNull BehaviorResult	wakeUp()	Wakes up this Mob if it is sleeping.

Method Details

backupIfClose

@NotNull
@NotNull BehaviorResult backupIfClose(int minDistance,
 float speedModifier)

Makes this Mob back up if it is too close.

This behavior requires EntityMemory.WALKING_TARGET to be absent, EntityMemory.LOOKING_TARGET to be registered, and EntityMemory.ATTACK_TARGET with EntityMemory.NEAREST_VISIBLE_LIVING_ENTITIES to be present.

Parameters:

minDistance - Minimum Distance to back up

speedModifier - Speed Modifier while backing up

Returns:

Result of Behavior

backupIfClose

@NotNull
default @NotNull BehaviorResult backupIfClose(int minDistance)

Makes this Mob back up if it is too close, with no speed modifier.

This behavior requires EntityMemory.WALKING_TARGET to be absent, EntityMemory.LOOKING_TARGET to be registered, and EntityMemory.ATTACK_TARGET with EntityMemory.NEAREST_VISIBLE_LIVING_ENTITIES to be present.

Parameters:

minDistance - Minimum Distance to back up

Returns:

Result of Behavior

passiveIf

@NotNull
@NotNull BehaviorResult passiveIf(@NotNull
 @NotNull Memory<?> memory,
 int durationTicks)
                           throws IllegalArgumentException

Makes this Entity become Passive is a Memory is present.

This behavior does not require any other memories to run.

Parameters:

memory - Memory to use

durationTicks - How long to be passive, in ticks

Returns:

Result of Behavior

Throws:

IllegalArgumentException - if memory is null

eraseIf

@NotNull
@NotNull BehaviorResult eraseIf(@NotNull
 @NotNull Predicate<Mob> function,
 @NotNull
 @NotNull Memory<?> memory)
                         throws IllegalArgumentException

Erases a memory if function returns true.

This behavior does not require any other memories to run.

Parameters:

function - Function to test containing Mob

memory - Memory to remove if function returns true

Returns:

Result of Behavior

Throws:

IllegalArgumentException - if function or memory is null

moveToWantedItem

@NotNull
@NotNull BehaviorResult moveToWantedItem(int minDist,
 float speedMod,
 boolean requireTarget)

Makes this Entity move to its wanted item.

This behavior requires EntityMemory.LOOKING_TARGET and EntityMemory.TICKS_ITEM_PICKUP_COOLDOWN to be registered, and EntityMemory.NEAREST_VISIBLE_WANTED_ITEM to be present.

Depending on requireTarget, EntityMemory.WALKING_TARGET needs to be present if true, or absent if false.

Parameters:

minDist - Minimum Distance from Item

speedMod - Speed Modifier while moving

requireTarget - Whether a walking target is required (if false, EntityMemory.WALKING_TARGET needs to be absent, defaults to true)

Returns:

Result of Behavior

moveToWantedItem

@NotNull
default @NotNull BehaviorResult moveToWantedItem(int minDist,
 float speedMod)

Makes this Entity move to its wanted item, with requireTarget set to true.

This behavior requires EntityMemory.LOOKING_TARGET and EntityMemory.TICKS_ITEM_PICKUP_COOLDOWN to be registered, and EntityMemory.NEAREST_VISIBLE_WANTED_ITEM with EntityMemory.WALKING_TARGET to be present.

Parameters:

minDist - Minimum Distance from Item

speedMod - Speed Modifier while moving

Returns:

Result of Behavior

moveToWantedItem

@NotNull
default @NotNull BehaviorResult moveToWantedItem(int minDist)

Makes this Entity move to its wanted item, with no speed modifier.

This behavior requires EntityMemory.LOOKING_TARGET and EntityMemory.TICKS_ITEM_PICKUP_COOLDOWN to be registered, and EntityMemory.NEAREST_VISIBLE_WANTED_ITEM with EntityMemory.WALKING_TARGET to be present.

Parameters:

minDist - Minimum Distance from Item

Returns:

Result of Behavior

jumpOnBed

@NotNull
@NotNull BehaviorResult jumpOnBed(float speedMod)

Makes this Mob jump on a Bed.

This behavior requires EntityMemory.NEAREST_BED to be present, and EntityMemory.WALKING_TARGET to be absent.

Parameters:

speedMod - Speed Modifier while locating a bed

Returns:

Result of Behavior

jumpOnBed

@NotNull
default @NotNull BehaviorResult jumpOnBed()

Makes this Mob jump on a Bed, with no speed Modifier.

This behavior requires EntityMemory.NEAREST_BED to be present, and EntityMemory.WALKING_TARGET to be absent.

Returns:

Result of Behavior

meleeAttack

@NotNull
@NotNull BehaviorResult meleeAttack(int cooldown)

Makes this Mob perform a Melee Attack.

This behavior requires EntityMemory.LOOKING_TARGET to be registered, EntityMemory.ATTACK_COOLING_DOWN to be absent, and EntityMemory.ATTACK_TARGET with EntityMemory.NEAREST_VISIBLE_LIVING_ENTITIES to be present.

Parameters:

cooldown - Cooldown, in ticks, before the next attack

Returns:

Result of Behavior

meleeAttack

@NotNull
default @NotNull BehaviorResult meleeAttack()

Makes this Mob perform a Melee Attack, with a cooldown of 3 seconds (60 ticks).

This behavior requires EntityMemory.LOOKING_TARGET to be registered, EntityMemory.ATTACK_COOLING_DOWN to be absent, and EntityMemory.ATTACK_TARGET with EntityMemory.NEAREST_VISIBLE_LIVING_ENTITIES to be present.

Returns:

Result of Behavior

wakeUp

@NotNull
@NotNull BehaviorResult wakeUp()

Wakes up this Mob if it is sleeping.

This behavior does not require any memories to run.

Returns:

Result of Behavior

ringBell

@NotNull
@NotNull BehaviorResult ringBell()

Makes this Mob ring the nearest bell.

This behavior requires EntityMemory.MEETING_POINT to be present.

Returns:

Result of Behavior

reactToBell

@NotNull
@NotNull BehaviorResult reactToBell()

Makes this Mob react to a Bell ringing, symbolizing an incoming raid.

This behavior requires EntityMemory.HEARD_BELL_DURATION to be present.

Returns:

Result of Behavior

interactWithDoor

@NotNull
@NotNull BehaviorResult interactWithDoor()

Makes this Mob interact with the nearest door.

This behavior requires EntityMemory.PATH to be present, and EntityMemory.DOORS_TO_CLOSE with EntityMemory.NEAREST_LIVING_ENTITIES to be registered.

Returns:

Result of Behavior

sleep

@NotNull
@NotNull BehaviorResult sleep()

Makes this Mob sleep in a bed.

This behavior requires EntityMemory.HOME to be present, and EntityMemory.LAST_WOKEN to be registered.

Returns:

Result of Behavior

socializeAtBell

@NotNull
@NotNull BehaviorResult socializeAtBell()

Makes this Mob socialize at the Village's Bell.

This behavior requires EntityMemory.NEAREST_VISIBLE_LIVING_ENTITIES to be present, EntityMemory.INTERACTION_TARGET to be absent, and EntityMemory.WALKING_TARGET with EntityMemory.LOOKING_TARGET to be registered.

Returns:

Result of Behavior