org.spongepowered.api.entity.living

Interface Agent

All Superinterfaces:

CompositeValueStore<DataHolder,DataManipulator<?,?>>, DataHolder, DataSerializable, Entity, Identifiable, Living, Locatable, ProjectileSource, PropertyHolder, TeamMember, Translatable, ValueContainer<DataHolder>

All Known Subinterfaces:

Aerial, Ageable, Ambient, Animal, Aquatic, Bat, Blaze, CaveSpider, Chicken, Cow, Creature, Creeper, Donkey, EnderDragon, Enderman, Endermite, Evoker, Ghast, Giant, Golem, Guardian, Horse, Human, Husk, Illusioner, IronGolem, Llama, MagmaCube, Monster, Mooshroom, Mule, Ocelot, Parrot, Pig, PolarBear, Rabbit, Ranger, RideableHorse, Sheep, Shulker, Silverfish, Skeleton, SkeletonHorse, Slime, SnowGolem, Spider, Squid, Stray, Vex, Villager, Vindicator, WhiteSkeleton, Witch, Wither, WitherSkeleton, Wolf, Zombie, ZombieHorse, ZombiePigman, ZombieVillager

public interface Agent
extends Living

An Agent represents a Living that has AI. In the future Sponge will allow for custom AIs, but for now vanilla behavior can only be disabled.

Field Summary

Fields inherited from interface org.spongepowered.api.entity.projectile.source.ProjectileSource

UNKNOWN

Method Summary

Modifier and Type	Method and Description
default Value<Boolean>	aiEnabled() Gets the Value for whether AI tasks are enabled or not.
default AgentData	getAgentData() Gets a copy of the AgentData associated with this Agent.
<T extends Agent> Optional<Goal<T>>	getGoal(GoalType type) Gets a Goal based on the GoalType.
Optional<Entity>	getTarget() Gets the current target, usually according to the various AITasks that are acting on this agent.
void	setTarget(Entity target) Sets the current target, usually to bypass what the AITasks are deciding to be the target.

Methods inherited from interface org.spongepowered.api.entity.living.Living

getDamageableData, getHeadRotation, getHealthData, health, lastAttacker, lastDamage, lookAt, maxHealth, setHeadRotation

Methods inherited from interface org.spongepowered.api.entity.Entity

addPassenger, addTag, canSee, clearPassengers, createArchetype, createSnapshot, damage, getBaseVehicle, getBoundingBox, getCreator, getNearbyEntities, getNearbyEntities, getNotifier, getPassengers, getRandom, getRotation, getScale, getTags, getTransform, getType, getVehicle, getVelocity, gravity, hasPassenger, hasTag, isLoaded, isOnGround, isRemoved, remove, removePassenger, removeTag, setCreator, setLocation, setLocationAndRotation, setLocationAndRotation, setLocationAndRotationSafely, setLocationAndRotationSafely, setLocationSafely, setNotifier, setRotation, setScale, setTransform, setTransformSafely, setVehicle, setVelocity, transferToWorld, transferToWorld, transferToWorld, transferToWorld

Methods inherited from interface org.spongepowered.api.util.Identifiable

getUniqueId

Methods inherited from interface org.spongepowered.api.world.Locatable

getLocation, getWorld

Methods inherited from interface org.spongepowered.api.data.DataHolder

setRawData, validateRawData

Methods inherited from interface org.spongepowered.api.data.DataSerializable

getContentVersion, toContainer

Methods inherited from interface org.spongepowered.api.data.property.PropertyHolder

getApplicableProperties, getProperty

Methods inherited from interface org.spongepowered.api.data.value.mutable.CompositeValueStore

copyFrom, copyFrom, get, getContainers, getOrCreate, offer, offer, offer, offer, offer, offer, remove, remove, remove, require, supports, transform, tryOffer, tryOffer, tryOffer, tryOffer, undo

Methods inherited from interface org.spongepowered.api.data.value.ValueContainer

copy, get, getKeys, getOrElse, getOrNull, getValue, getValues, require, supports, supports

Methods inherited from interface org.spongepowered.api.text.translation.Translatable

getTranslation

Methods inherited from interface org.spongepowered.api.entity.projectile.source.ProjectileSource

launchProjectile, launchProjectile

Methods inherited from interface org.spongepowered.api.scoreboard.TeamMember

getTeamRepresentation

Method Detail

getTarget

Optional<Entity> getTarget()

Gets the current target, usually according to the various AITasks that are acting on this agent.

Returns:

The target entity, if available

setTarget

void setTarget(@Nullable
               Entity target)

Sets the current target, usually to bypass what the AITasks are deciding to be the target.

Parameters:

target - The target entity, or null

getAgentData

default AgentData getAgentData()

Gets a copy of the AgentData associated with this Agent.

Returns:

A copy of the agent data

aiEnabled

default Value<Boolean> aiEnabled()

Gets the Value for whether AI tasks are enabled or not.

Returns:

The value for the current "enabled" state of ai tasks

getGoal

<T extends Agent> Optional<Goal<T>> getGoal(GoalType type)

Gets a Goal based on the GoalType.

Type Parameters:

T - Inferred agent type

Parameters:

type - GoalType to lookup

Returns:

The goal or Optional.empty() if not found.