Class GlowingEntities

java.lang.Object
fr.skytasul.glowingentities.GlowingEntities
All Implemented Interfaces:
org.bukkit.event.Listener

public class GlowingEntities extends Object implements org.bukkit.event.Listener
A Spigot util to easily make entities glow.

1.17 -> 1.21

Version:
1.4.4
Author:
SkytAsul
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    protected static class 
     
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final @NotNull org.bukkit.plugin.Plugin
     
  • Constructor Summary

    Constructors
    Constructor
    Description
    GlowingEntities(@NotNull org.bukkit.plugin.Plugin plugin)
    Initializes the Glowing API.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Disables the API.
    void
    Enables the Glowing API.
    void
    onQuit(org.bukkit.event.player.PlayerQuitEvent event)
     
    void
    setGlowing(int entityID, String teamID, org.bukkit.entity.Player receiver)
    Make the entity with specified entity ID glow with its default team color.
    void
    setGlowing(int entityID, String teamID, org.bukkit.entity.Player receiver, org.bukkit.ChatColor color)
    Make the entity with specified entity ID glow with the specified color.
    void
    setGlowing(int entityID, String teamID, org.bukkit.entity.Player receiver, org.bukkit.ChatColor color, byte otherFlags)
    Make the entity with specified entity ID glow with the specified color, and keep some flags.
    void
    setGlowing(org.bukkit.entity.Entity entity, org.bukkit.entity.Player receiver)
    Make the Entity passed as a parameter glow with its default team color.
    void
    setGlowing(org.bukkit.entity.Entity entity, org.bukkit.entity.Player receiver, org.bukkit.ChatColor color)
    Make the Entity passed as a parameter glow with the specified color.
    void
    unsetGlowing(int entityID, org.bukkit.entity.Player receiver)
    Make the entity with specified entity ID passed as a parameter loose its custom glowing effect.
    void
    unsetGlowing(org.bukkit.entity.Entity entity, org.bukkit.entity.Player receiver)
    Make the Entity passed as a parameter loose its custom glowing effect.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • plugin

      @NotNull protected final @NotNull org.bukkit.plugin.Plugin plugin
  • Constructor Details

    • GlowingEntities

      public GlowingEntities(@NotNull @NotNull org.bukkit.plugin.Plugin plugin)
      Initializes the Glowing API.
      Parameters:
      plugin - plugin that will be used to register the events.
  • Method Details

    • enable

      public void enable()
      Enables the Glowing API.
      See Also:
    • disable

      public void disable()
      Disables the API.

      Methods such as setGlowing(int, String, Player, ChatColor, byte) and unsetGlowing(int, Player) will no longer be usable.

      See Also:
    • onQuit

      public void onQuit(org.bukkit.event.player.PlayerQuitEvent event)
    • setGlowing

      public void setGlowing(org.bukkit.entity.Entity entity, org.bukkit.entity.Player receiver) throws ReflectiveOperationException
      Make the Entity passed as a parameter glow with its default team color.
      Parameters:
      entity - entity to make glow
      receiver - player which will see the entity glowing
      Throws:
      ReflectiveOperationException
    • setGlowing

      public void setGlowing(org.bukkit.entity.Entity entity, org.bukkit.entity.Player receiver, org.bukkit.ChatColor color) throws ReflectiveOperationException
      Make the Entity passed as a parameter glow with the specified color.
      Parameters:
      entity - entity to make glow
      receiver - player which will see the entity glowing
      color - color of the glowing effect
      Throws:
      ReflectiveOperationException
    • setGlowing

      public void setGlowing(int entityID, String teamID, org.bukkit.entity.Player receiver) throws ReflectiveOperationException
      Make the entity with specified entity ID glow with its default team color.
      Parameters:
      entityID - entity id of the entity to make glow
      teamID - internal string used to add the entity to a team
      receiver - player which will see the entity glowing
      Throws:
      ReflectiveOperationException
    • setGlowing

      public void setGlowing(int entityID, String teamID, org.bukkit.entity.Player receiver, org.bukkit.ChatColor color) throws ReflectiveOperationException
      Make the entity with specified entity ID glow with the specified color.
      Parameters:
      entityID - entity id of the entity to make glow
      teamID - internal string used to add the entity to a team
      receiver - player which will see the entity glowing
      color - color of the glowing effect
      Throws:
      ReflectiveOperationException
    • setGlowing

      public void setGlowing(int entityID, String teamID, org.bukkit.entity.Player receiver, org.bukkit.ChatColor color, byte otherFlags) throws ReflectiveOperationException
      Make the entity with specified entity ID glow with the specified color, and keep some flags.
      Parameters:
      entityID - entity id of the entity to make glow
      teamID - internal string used to add the entity to a team
      receiver - player which will see the entity glowing
      color - color of the glowing effect
      otherFlags - internal flags that must be kept (on fire, crouching...). See wiki.vg for more informations.
      Throws:
      ReflectiveOperationException
    • unsetGlowing

      public void unsetGlowing(org.bukkit.entity.Entity entity, org.bukkit.entity.Player receiver) throws ReflectiveOperationException
      Make the Entity passed as a parameter loose its custom glowing effect.

      This has no effect on glowing status given by another plugin or vanilla behavior.

      Parameters:
      entity - entity to remove glowing effect from
      receiver - player which will no longer see the glowing effect
      Throws:
      ReflectiveOperationException
    • unsetGlowing

      public void unsetGlowing(int entityID, org.bukkit.entity.Player receiver) throws ReflectiveOperationException
      Make the entity with specified entity ID passed as a parameter loose its custom glowing effect.

      This has no effect on glowing status given by another plugin or vanilla behavior.

      Parameters:
      entityID - entity id of the entity to remove glowing effect from
      receiver - player which will no longer see the glowing effect
      Throws:
      ReflectiveOperationException