Skip to content

Developer API

MrGraycat edited this page Feb 25, 2023 · 4 revisions

Getting started

  • Add eGlow as a dependency

Maven:

<repositories>
  <repository>
    <id>jitpack</id>
    <url>https://jitpack.io/</url>
  </repository>
</repositories>

<dependencies>
  <!-- eGlow -->
  <dependency>
    <groupId>com.github.mrgraycat</groupId>
    <artifactId>eGlow</artifactId>
    <version>master-SNAPSHOT</version>
    <scope>provided</scope>
  </dependency>
</dependencies>

Gradle:

repositories {
    maven { url = 'https://jitpack.io/' }
}

dependencies {
    compileOnly 'com.github.mrgraycat:eGlow:master-SNAPSHOT'
}
  • Create a/use reference EGlowAPI (me.MrGraycat.eGlow.API.EGlowAPI) by using EGlow.getAPI();

EGlowAPI methods

getEGlowPlayer(Player player): Returns the IEGlowPlayer instance of the given player.
getEGlowPlayer(UUID uuid): Returns the IEGlowPlayer instance of the given UUID.
getEGlowEffect(String name): Returns the IEGlowEffect instance of the given String (null if not found).
getGlowColor(IEGlowPlayer player): Returns the current active glow color of the given player (nothing if not glowing).

enableGlow(IEGlowPlayer player, IEGlowEffect effect): Activate the given effect for the given player.
enableGlow(IEGlowPlayer player, EGlowColor color: Activate the given color for the given player.
enableGlow(IEGlowPlayer player, EGlowBlink blink: Activate the given blink for the given player.
enableGlow(IEGlowPlayer player, EGlowEffect effect: Activate the given effect for the given player.
disableGlow(IEGlowPlayer player): Disable the glow of the given player.

addCustomGlowReceiver(IEGlowPlayer player, Player receiver): Add a single player to the custom receiver list.
removeCustomGlowReceiver(IEGlowPlayer player, Player receiver): Remove a single player from the custom receiver list.
setCustomGlowReceivers(IEGlowPlayer player, List<Player> receivers: Add a list of players to the custom receiver list.
resetCustomGlowReceivers(IEGlowPlayer player): Remove all players from the custom receivers list to show it to everyone again.

EGlowColor

RED DARK_RED GOLD
YELLOW GREEN DARK_GREEN
AQUA DARK_AQUA BLUE
DARK_BLUE PURPLE PINK
WHITE GRAY DARK_GRAY
BLACK NONE

EGlowBlink

RED_SLOW RED_FAST
DARK_RED_SLOW DARK_RED_FAST
GOLD_SLOW GOLD_FAST
YELLOW_SLOW YELLOW_FAST
GREEN_SLOW GREEN_FAST
DARK_GREEN_SLOW DARK_GREEN_FAST
AQUA_SLOW AQUA_FAST
DARK_AQUA_SLOW DARK_AQUA_FAST
BLUE_SLOW BLUE_FAST
DARK_BLUE_SLOW DARK_BLUE_FAST
PURPLE_SLOW PURPLE_FAST
PINK_SLOW PINK_FAST
WHITE_SLOW WHITE_FAST
GRAY_SLOW GRAY_FAST
DARK_GRAY_SLOW DARK_GRAY_FAST
BLACK_SLOW BLACK_FAST

EGlowEffect

RAINBOW_SLOW RAINBOW_FAST