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

Class famiHologram

java.lang.Object
me.fami6xx.rpuniverse.core.holoapi.types.holograms.famiHologram
Direct Known Subclasses:
FollowingHologram, SellStepHologram, StaticHologram, WorkingStepHologram
public abstract class famiHologram extends Object

  • Constructor Summary

    Constructors
    Constructor
    Description
    famiHologram​(eu.decentsoftware.holograms.api.holograms.Hologram holo)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    eu.decentsoftware.holograms.api.holograms.HologramLine
    addLine​(String line)
     
    boolean
    canSeeThroughBlocks()
     
    void
    destroy()
    Destroys hologram and hides it from all players
    abstract org.bukkit.Location
    getBaseLocation()
    This function is only for Visibility calculations as it needs to get from where to send RayTrace
    double
    getDistance()
     
    eu.decentsoftware.holograms.api.holograms.Hologram
    getHologram()
     
    int
    getIntDistance()
     
    abstract int
    getPageToDisplay​(org.bukkit.entity.Player player)
    This method is used to retrieve the page number to display for a given player.
    int
    getShownPage​(org.bukkit.entity.Player player)
    Get shown page for player
    UUID
    getUUID()
     
    void
    hide​(org.bukkit.entity.Player player)
    Hides hologram from player
    boolean
    isVisible​(org.bukkit.entity.Player player)
    Checks if hologram is visible to player
    abstract boolean
    shouldShow​(org.bukkit.entity.Player player)
    Determines whether the hologram should be shown to the given player.
    void
    show​(org.bukkit.entity.Player player)
    Shows hologram to player
    void
    updatedPlayerMode​(PlayerData data)
     
    void
    updateVisibility​(double distance, boolean seeThroughBlocks)
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • famiHologram

      public famiHologram​(eu.decentsoftware.holograms.api.holograms.Hologram holo)

  • Method Details

    • addLine

      public eu.decentsoftware.holograms.api.holograms.HologramLine addLine​(String line)

    • updateVisibility

      public void updateVisibility​(double distance, boolean seeThroughBlocks)

    • getDistance

      public double getDistance()

    • getIntDistance

      public int getIntDistance()

    • canSeeThroughBlocks

      public boolean canSeeThroughBlocks()

    • getHologram

      public eu.decentsoftware.holograms.api.holograms.Hologram getHologram()

    • getUUID

      public UUID getUUID()

    • updatedPlayerMode

      public void updatedPlayerMode​(PlayerData data)

    • getBaseLocation

      public abstract org.bukkit.Location getBaseLocation()
      This function is only for Visibility calculations as it needs to get from where to send RayTrace
      Returns:
      Location of the base of the hologram

    • destroy

      public void destroy()
      Destroys hologram and hides it from all players

    • show

      public void show​(org.bukkit.entity.Player player)
      Shows hologram to player
      Parameters:
      player - Player to show hologram to

    • getPageToDisplay

      public abstract int getPageToDisplay​(org.bukkit.entity.Player player)
      This method is used to retrieve the page number to display for a given player.
      Parameters:
      player - The player for whom to retrieve the page number.
      Returns:
      The page number to display for the given player.

    • shouldShow

      public abstract boolean shouldShow​(org.bukkit.entity.Player player)
      Determines whether the hologram should be shown to the given player.
      Parameters:
      player - The player to check.
      Returns:
      true if the hologram should be shown to the player, false otherwise.

    • hide

      public void hide​(org.bukkit.entity.Player player)
      Hides hologram from player
      Parameters:
      player - Player to hide hologram from

    • getShownPage

      public int getShownPage​(org.bukkit.entity.Player player)
      Get shown page for player
      Parameters:
      player - Player to get shown page for
      Returns:
      Shown page for player

    • isVisible

      public boolean isVisible​(org.bukkit.entity.Player player)
      Checks if hologram is visible to player
      Parameters:
      player - Player to check visibility for
      Returns:
      true if hologram is visible to player, false otherwise