Package me.fami6xx.rpuniverse.core.holoapi.types.holograms

Class FollowingHologram

java.lang.Object

me.fami6xx.rpuniverse.core.holoapi.types.holograms.famiHologram

me.fami6xx.rpuniverse.core.holoapi.types.holograms.FollowingHologram

public class FollowingHologram
extends famiHologram

Constructor Summary

Constructors

Constructor	Description
FollowingHologram(org.bukkit.entity.Entity toFollow)	Creates a new FollowingHologram that will be visible by default and can be seen through blocks with no max visible distance
FollowingHologram(org.bukkit.entity.Entity toFollow, double visibleDistance, boolean isVisibleByDefault, boolean seeThroughBlocks)	Creates a new FollowingHologram that will stay on the entity until it is destroyed
FollowingHologram(org.bukkit.entity.Entity toFollow, double visibleDistance, boolean isVisibleByDefault, boolean seeThroughBlocks, int timeAlive)	Creates a new FollowingHologram that will stay on the entity for a certain amount of time

Method Summary

Modifier and Type	Method	Description
org.bukkit.Location	getBaseLocation()	This function is only for Visibility calculations as it needs to get from where to send RayTrace
org.bukkit.entity.Entity	getFollowing()
int	getPageToDisplay(org.bukkit.entity.Player player)	This method is used to retrieve the page number to display for a given player.
boolean	shouldShow(org.bukkit.entity.Player player)	Determines whether the hologram should be shown to the given player.
String	toString()

Methods inherited from class me.fami6xx.rpuniverse.core.holoapi.types.holograms.famiHologram

addLine, canSeeThroughBlocks, destroy, getDistance, getHologram, getIntDistance, getShownPage, getUUID, hide, isVisible, show, updatedPlayerMode, updateVisibility

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

FollowingHologram

public FollowingHologram(org.bukkit.entity.Entity toFollow)

Creates a new FollowingHologram that will be visible by default and can be seen through blocks with no max visible distance

Parameters:

toFollow - Entity to follow

FollowingHologram

public FollowingHologram(org.bukkit.entity.Entity toFollow,
 double visibleDistance,
 boolean isVisibleByDefault,
 boolean seeThroughBlocks)

Creates a new FollowingHologram that will stay on the entity until it is destroyed

Parameters:

toFollow - Entity to follow

visibleDistance - Distance in blocks in which the hologram is visible

isVisibleByDefault - If the hologram is visible by default

seeThroughBlocks - If the hologram can be seen through blocks

FollowingHologram

public FollowingHologram(org.bukkit.entity.Entity toFollow,
 double visibleDistance,
 boolean isVisibleByDefault,
 boolean seeThroughBlocks,
 int timeAlive)

Creates a new FollowingHologram that will stay on the entity for a certain amount of time

Parameters:

toFollow - Entity to follow

visibleDistance - Distance in blocks in which the hologram is visible

isVisibleByDefault - If the hologram is visible by default

seeThroughBlocks - If the hologram can be seen through blocks

timeAlive - Time in ticks after which the hologram will be destroyed

Method Details

getFollowing

public org.bukkit.entity.Entity getFollowing()

shouldShow

public boolean shouldShow(org.bukkit.entity.Player player)

Description copied from class: famiHologram

Determines whether the hologram should be shown to the given player.

Specified by:

shouldShow in class famiHologram

Parameters:

player - The player to check.

Returns:

true if the hologram should be shown to the player, false otherwise.

getBaseLocation

public org.bukkit.Location getBaseLocation()

Description copied from class: famiHologram

This function is only for Visibility calculations as it needs to get from where to send RayTrace

Specified by:

getBaseLocation in class famiHologram

Returns:

Location of the base of the hologram

getPageToDisplay

public int getPageToDisplay(org.bukkit.entity.Player player)

Description copied from class: famiHologram

This method is used to retrieve the page number to display for a given player.

Specified by:

getPageToDisplay in class famiHologram

Parameters:

player - The player for whom to retrieve the page number.

Returns:

The page number to display for the given player.

toString

public String toString()

Overrides:

toString in class Object