Package org.bukkit.entity
Interface FishHook
- All Superinterfaces:
CommandSender
,Entity
,Metadatable
,Nameable
,Permissible
,PersistentDataHolder
,Projectile
,ServerOperator
public interface FishHook extends Projectile
Represents a fishing hook.
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
FishHook.HookState
Represents a state in which a fishing hook may be. -
Method Summary
Modifier and Type Method Description boolean
getApplyLure()
Get whether the lure enchantment should be applied to reduce the wait time.double
getBiteChance()
Deprecated.has no effect in newer Minecraft versionsEntity
getHookedEntity()
Get the entity hooked by this fish hook.int
getMaxWaitTime()
Get the maximum number of ticks one has to wait for a fish biting.int
getMinWaitTime()
Get the minimum number of ticks one has to wait for a fish biting.FishHook.HookState
getState()
Get the current state of this fish hook.boolean
isInOpenWater()
Check whether or not this fish hook is in open water.boolean
pullHookedEntity()
Pull the hooked entity to the caster of this fish hook.void
setApplyLure(boolean applyLure)
Set whether the lure enchantment should be applied to reduce the wait time.void
setBiteChance(double chance)
Deprecated.has no effect in newer Minecraft versionsvoid
setHookedEntity(Entity entity)
Set the entity hooked by this fish hook.void
setMaxWaitTime(int maxWaitTime)
Set the maximum number of ticks one has to wait for a fish biting.void
setMinWaitTime(int minWaitTime)
Set the minimum number of ticks one has to wait for a fish biting.Methods inherited from interface org.bukkit.command.CommandSender
getName, sendMessage, sendMessage, sendMessage, sendMessage
Methods inherited from interface org.bukkit.entity.Entity
addPassenger, addScoreboardTag, eject, getBoundingBox, getEntityId, getFacing, getFallDistance, getFireTicks, getHeight, getLastDamageCause, getLocation, getLocation, getMaxFireTicks, getNearbyEntities, getPassenger, getPassengers, getPistonMoveReaction, getPortalCooldown, getPose, getScoreboardTags, getServer, getTicksLived, getType, getUniqueId, getVehicle, getVelocity, getWidth, getWorld, hasGravity, isCustomNameVisible, isDead, isEmpty, isGlowing, isInsideVehicle, isInvulnerable, isInWater, isOnGround, isPersistent, isSilent, 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
Methods inherited from interface org.bukkit.metadata.Metadatable
getMetadata, hasMetadata, removeMetadata, setMetadata
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.persistence.PersistentDataHolder
getPersistentDataContainer
Methods inherited from interface org.bukkit.entity.Projectile
doesBounce, getShooter, setBounce, setShooter
-
Method Details
-
getMinWaitTime
int getMinWaitTime()Get the minimum number of ticks one has to wait for a fish biting.The default is 100 ticks (5 seconds).
Note that this is before applying lure.- Returns:
- Minimum number of ticks one has to wait for a fish biting
-
setMinWaitTime
void setMinWaitTime(int minWaitTime)Set the minimum number of ticks one has to wait for a fish biting.The default is 100 ticks (5 seconds).
Note that this is before applying lure.- Parameters:
minWaitTime
- Minimum number of ticks one has to wait for a fish biting
-
getMaxWaitTime
int getMaxWaitTime()Get the maximum number of ticks one has to wait for a fish biting.The default is 600 ticks (30 seconds).
Note that this is before applying lure.- Returns:
- Maximum number of ticks one has to wait for a fish biting
-
setMaxWaitTime
void setMaxWaitTime(int maxWaitTime)Set the maximum number of ticks one has to wait for a fish biting.The default is 600 ticks (30 seconds).
Note that this is before applying lure.- Parameters:
maxWaitTime
- Maximum number of ticks one has to wait for a fish biting
-
getApplyLure
boolean getApplyLure()Get whether the lure enchantment should be applied to reduce the wait time.The default is true.
Lure reduces the wait time by 100 ticks (5 seconds) for each level of the enchantment.- Returns:
- Whether the lure enchantment should be applied to reduce the wait time
-
setApplyLure
void setApplyLure(boolean applyLure)Set whether the lure enchantment should be applied to reduce the wait time.The default is true.
Lure reduces the wait time by 100 ticks (5 seconds) for each level of the enchantment.- Parameters:
applyLure
- Whether the lure enchantment should be applied to reduce the wait time
-
getBiteChance
Deprecated.has no effect in newer Minecraft versionsGets the chance of a fish biting.0.0 = No Chance.
1.0 = Instant catch.- Returns:
- chance the bite chance
-
setBiteChance
Deprecated.has no effect in newer Minecraft versionsSets the chance of a fish biting.0.0 = No Chance.
1.0 = Instant catch.- Parameters:
chance
- the bite chance- Throws:
IllegalArgumentException
- if the bite chance is not between 0 and 1
-
isInOpenWater
boolean isInOpenWater()Check whether or not this fish hook is in open water.Open water is defined by a 5x4x5 area of water, air and lily pads. If in open water, treasure items may be caught.
- Returns:
- true if in open water, false otherwise
-
getHookedEntity
Get the entity hooked by this fish hook.- Returns:
- the hooked entity. null if none
-
setHookedEntity
Set the entity hooked by this fish hook.- Parameters:
entity
- the entity to set, or null to unhook
-
pullHookedEntity
boolean pullHookedEntity()Pull the hooked entity to the caster of this fish hook. If no entity is hooked, this method has no effect.- Returns:
- true if pulled, false if no entity is hooked
-
getState
Get the current state of this fish hook.- Returns:
- the fish hook state
-