org.bukkit.entity

Interface Villager

All Superinterfaces:

AbstractVillager, Ageable, Attributable, net.kyori.adventure.audience.Audience, Breedable, CommandSender, Creature, Damageable, Entity, net.kyori.adventure.text.event.HoverEventSource<net.kyori.adventure.text.event.HoverEvent.ShowEntity>, InventoryHolder, LivingEntity, Lootable, Merchant, Metadatable, Mob, Nameable, NPC, Permissible, PersistentDataHolder, ProjectileSource, ServerOperator

public interface Villager
extends AbstractVillager

Represents a villager NPC

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Villager.Profession Represents the various different Villager professions there may be.
static class	Villager.Type Represents Villager type, usually corresponding to what biome they spawn in.

Nested classes/interfaces inherited from interface org.bukkit.entity.Entity

Entity.Spigot

Method Summary

Modifier and Type	Method and Description
void	clearReputations() Clear all reputations from this villager.
@NotNull Villager.Profession	getProfession() Gets the current profession of this villager.
Reputation	getReputation(@NotNull UUID uniqueId) Get the reputation for a specific player by UUID.
@NotNull Map<UUID,Reputation>	getReputations() Get all reputations for all players mapped by their unique IDs.
int	getRestocksToday() Gets the amount of times a villager has restocked their trades today
int	getVillagerExperience() Gets the trading experience of this villager.
int	getVillagerLevel() Gets the level of this villager.
@NotNull Villager.Type	getVillagerType() Gets the current type of this villager.
void	setProfession(@NotNull Villager.Profession profession) Sets the new profession of this villager.
void	setReputation(@NotNull UUID uniqueId, Reputation reputation) Set the reputation for a specific player by UUID.
void	setReputations(@NotNull Map<UUID,Reputation> reputations) Set all reputations for all players mapped by their unique IDs.
void	setRestocksToday(int restocksToday) Sets the amount of times a villager has restocked their trades today
void	setVillagerExperience(int experience) Sets the trading experience of this villager.
void	setVillagerLevel(int level) Sets the level of this villager.
void	setVillagerType(@NotNull Villager.Type type) Sets the new type of this villager.
boolean	sleep(@NotNull Location location) Attempts to make this villager sleep at the given location.
void	wakeup() Causes this villager to wake up if he's currently sleeping.

Methods inherited from interface org.bukkit.entity.AbstractVillager

getInventory, resetOffers

Methods inherited from interface org.bukkit.entity.Breedable

canBreed, getAgeLock, setAgeLock, setBreed

Methods inherited from interface org.bukkit.entity.Ageable

getAge, isAdult, setAdult, setAge, setBaby

Methods inherited from interface org.bukkit.entity.Mob

getPathfinder, getTarget, isAware, isInDaylight, setAware, setTarget

Methods inherited from interface org.bukkit.entity.LivingEntity

addPotionEffect, addPotionEffect, addPotionEffects, attack, clearActiveItem, getActiveItem, getActivePotionEffects, getArrowCooldown, getArrowsInBody, getArrowsStuck, getCanPickupItems, getCategory, getCollidableExemptions, getEquipment, getEyeHeight, getEyeHeight, getEyeLocation, getHandRaisedTime, getHurtDirection, getItemUseRemainingTime, getKiller, getLastDamage, getLastTwoTargetBlocks, getLeashHolder, getLineOfSight, getMaximumAir, getMaximumNoDamageTicks, getMemory, getNoDamageTicks, getPotionEffect, getRemainingAir, getRemoveWhenFarAway, getShieldBlockingDelay, getTargetBlock, getTargetBlock, getTargetBlock, getTargetBlockExact, getTargetBlockExact, getTargetBlockFace, getTargetBlockFace, getTargetBlockInfo, getTargetBlockInfo, getTargetEntity, getTargetEntity, getTargetEntityInfo, getTargetEntityInfo, hasAI, hasLineOfSight, hasPotionEffect, isCollidable, isGliding, isHandRaised, isInvisible, isJumping, isLeashed, isRiptiding, isSleeping, isSwimming, playAnimation, playPickupItemAnimation, playPickupItemAnimation, rayTraceBlocks, rayTraceBlocks, removePotionEffect, setAI, setArrowCooldown, setArrowsInBody, setArrowsStuck, setCanPickupItems, setCollidable, setGliding, setHurtDirection, setInvisible, setJumping, setKiller, setLastDamage, setLeashHolder, setMaximumAir, setMaximumNoDamageTicks, setMemory, setNoDamageTicks, setRemainingAir, setRemoveWhenFarAway, setShieldBlockingDelay, setSwimming, swingMainHand, swingOffHand

Methods inherited from interface org.bukkit.attribute.Attributable

getAttribute, registerAttribute

Methods inherited from interface org.bukkit.entity.Damageable

damage, damage, damage, damage, getAbsorptionAmount, getHealth, getMaxHealth, resetMaxHealth, setAbsorptionAmount, setHealth, setMaxHealth

Methods inherited from interface org.bukkit.entity.Entity

addPassenger, addScoreboardTag, asHoverEvent, eject, fromMobSpawner, getBoundingBox, getChunk, getEntityId, getEntitySpawnReason, getFacing, getFallDistance, getFireTicks, getHeight, getLastDamageCause, getLocation, getLocation, getMaxFireTicks, getNearbyEntities, getOrigin, getPassenger, getPassengers, getPistonMoveReaction, getPortalCooldown, getPose, getScoreboardTags, getServer, getTicksLived, getType, getUniqueId, getVehicle, getVelocity, getWidth, getWorld, hasGravity, isCustomNameVisible, isDead, isEmpty, isGlowing, isInBubbleColumn, isInLava, isInRain, isInsideVehicle, isInvulnerable, isInWater, isInWaterOrBubbleColumn, isInWaterOrRain, isInWaterOrRainOrBubbleColumn, isOnGround, isPersistent, isSilent, isTicking, isValid, leaveVehicle, playEffect, remove, removePassenger, removeScoreboardTag, setCustomNameVisible, setFallDistance, setFireTicks, setGlowing, setGravity, setInvulnerable, setLastDamageCause, setPassenger, setPersistent, setPortalCooldown, setRotation, setSilent, setTicksLived, setVelocity, spigot, teleport, teleport, teleport, teleport, teleportAsync, teleportAsync

Methods inherited from interface org.bukkit.metadata.Metadatable

getMetadata, hasMetadata, removeMetadata, setMetadata

Methods inherited from interface org.bukkit.command.CommandSender

getName, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage

Methods inherited from interface net.kyori.adventure.audience.Audience

audience, audience, clearTitle, empty, hideBossBar, openBook, openBook, playSound, playSound, resetTitle, sendActionBar, sendActionBar, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeader, sendPlayerListHeaderAndFooter, sendPlayerListHeaderAndFooter, showBossBar, showTitle, stopSound, toAudience

Methods inherited from interface org.bukkit.permissions.Permissible

addAttachment, addAttachment, addAttachment, addAttachment, getEffectivePermissions, hasPermission, hasPermission, isPermissionSet, isPermissionSet, recalculatePermissions, removeAttachment

Methods inherited from interface org.bukkit.permissions.ServerOperator

isOp, setOp

Methods inherited from interface org.bukkit.Nameable

customName, customName, getCustomName, setCustomName

Methods inherited from interface org.bukkit.persistence.PersistentDataHolder

getPersistentDataContainer

Methods inherited from interface net.kyori.adventure.text.event.HoverEventSource

asHoverEvent, unbox

Methods inherited from interface org.bukkit.projectiles.ProjectileSource

launchProjectile, launchProjectile

Methods inherited from interface org.bukkit.loot.Lootable

clearLootTable, getLootTable, getSeed, hasLootTable, setLootTable, setLootTable, setSeed

Methods inherited from interface org.bukkit.inventory.Merchant

getRecipe, getRecipeCount, getRecipes, getTrader, isTrading, setRecipe, setRecipes

Method Detail

getProfession

@NotNull
@NotNull Villager.Profession getProfession()

Gets the current profession of this villager.

Returns:

Current profession.

setProfession

void setProfession(@NotNull
                   @NotNull Villager.Profession profession)

Sets the new profession of this villager.

Parameters:

profession - New profession.

getVillagerType

@NotNull
@NotNull Villager.Type getVillagerType()

Gets the current type of this villager.

Returns:

Current type.

setVillagerType

void setVillagerType(@NotNull
                     @NotNull Villager.Type type)

Sets the new type of this villager.

Parameters:

type - New type.

getVillagerLevel

int getVillagerLevel()

Gets the level of this villager. A villager with a level of 1 and no experience is liable to lose its profession.

Returns:

this villager's level

setVillagerLevel

void setVillagerLevel(int level)

Sets the level of this villager. A villager with a level of 1 and no experience is liable to lose its profession.

Parameters:

level - the new level

Throws:

IllegalArgumentException - if level not between [1, 5]

getVillagerExperience

int getVillagerExperience()

Gets the trading experience of this villager.

Returns:

trading experience

setVillagerExperience

void setVillagerExperience(int experience)

Sets the trading experience of this villager.

Parameters:

experience - new experience

Throws:

IllegalArgumentException - if experience < 0

getRestocksToday

int getRestocksToday()

Gets the amount of times a villager has restocked their trades today

Returns:

The amount of trade restocks.

setRestocksToday

void setRestocksToday(int restocksToday)

Sets the amount of times a villager has restocked their trades today

Parameters:

restocksToday - new restock count

sleep

boolean sleep(@NotNull
              @NotNull Location location)

Attempts to make this villager sleep at the given location.
The location must be in the current world and have a bed placed at the location. The villager will put its head on the specified block while sleeping.

Parameters:

location - the location of the bed

Returns:

whether the sleep was successful

wakeup

void wakeup()

Causes this villager to wake up if he's currently sleeping.

Throws:

IllegalStateException - if not sleeping

getReputation

@Nullable
Reputation getReputation(@NotNull
                                   @NotNull UUID uniqueId)

Get the reputation for a specific player by UUID.

Parameters:

uniqueId - The UUID of the player to get the reputation of.

Returns:

The player's copied reputation with this villager.

getReputations

@NotNull
@NotNull Map<UUID,Reputation> getReputations()

Get all reputations for all players mapped by their unique IDs.

Returns:

All reputations for all players in a copied map.

setReputation

void setReputation(@NotNull
                   @NotNull UUID uniqueId,
                   @NotNull
                   Reputation reputation)

Set the reputation for a specific player by UUID.

Parameters:

uniqueId - The UUID of the player to set the reputation of.

reputation - The reputation to set.

setReputations

void setReputations(@NotNull
                    @NotNull Map<UUID,Reputation> reputations)

Set all reputations for all players mapped by their unique IDs.

Parameters:

reputations - All reputations for all players mapped by their unique IDs.

clearReputations

void clearReputations()

Clear all reputations from this villager. This removes every single reputation regardless of its impact and the player associated.