Package fr.multimc.api.spigot.common.worlds.locations.zones.effects

Class ZoneEffect

java.lang.Object
fr.multimc.api.spigot.common.worlds.locations.zones.effects.ZoneEffect
All Implemented Interfaces:
ZoneListener
public class ZoneEffect extends Object implements ZoneListener
This class represents a zone effect that applies a set of effects to players or entities when they enter or exit a specified zone.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ZoneEffect(@NotNull Zone zone, IZoneEffect... zoneEffects)
    Create new ZoneEffect with a given zone, and IZoneEffect array
    ZoneEffect(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull org.bukkit.Location center, @NotNull RelativeLocation location1, @NotNull RelativeLocation location2, IZoneEffect... zoneEffects)
    Constructs a new zone effect with a circular zone.
    ZoneEffect(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull org.bukkit.Location location1, @NotNull org.bukkit.Location location2, IZoneEffect... zoneEffects)
    Constructs a new zone effect with a rectangular zone.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    onEntityEnter(io.papermc.paper.event.entity.EntityMoveEvent e)
    Applies the effects to the entity when they enter the zone.
    void
    onEntityExit(io.papermc.paper.event.entity.EntityMoveEvent e)
    Removes the effects from the entity when they exit the zone.
    void
    onPlayerEnter(org.bukkit.event.player.PlayerMoveEvent e)
    Applies the effects to the player when they enter the zone.
    void
    onPlayerExit(org.bukkit.event.player.PlayerMoveEvent e)
    Removes the effects from the player when they exit the zone.
    void
    update()
    Re-apply the zone effects to all entities (player includes) in the zone.
    void
    updateSync(org.bukkit.plugin.Plugin plugin)
    Synchronously re-apply the zone effects to all entities (player includes) in the zone.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ZoneEffect

      public ZoneEffect(@NotNull @NotNull org.bukkit.plugin.Plugin plugin, @NotNull @NotNull org.bukkit.Location location1, @NotNull @NotNull org.bukkit.Location location2, IZoneEffect... zoneEffects)
      Constructs a new zone effect with a rectangular zone.
      Parameters:
      plugin - Plugin creating the zone effect
      location1 - Location that represents the first corner of the rectangle
      location2 - Location that represents the second corner of the rectangle
      zoneEffects - IZoneEffect to apply when players or entities enter or exit the zone

    • ZoneEffect

      public ZoneEffect(@NotNull @NotNull org.bukkit.plugin.Plugin plugin, @NotNull @NotNull org.bukkit.Location center, @NotNull @NotNull RelativeLocation location1, @NotNull @NotNull RelativeLocation location2, IZoneEffect... zoneEffects)
      Constructs a new zone effect with a circular zone.
      Parameters:
      plugin - Plugin creating the zone effect
      center - Location that represents the center of the circle
      location1 - RelativeLocation location of the first radius point
      location2 - RelativeLocation the relative location of the second radius point
      zoneEffects - IZoneEffect to apply when players or entities enter or exit the zone

    • ZoneEffect

      public ZoneEffect(@NotNull @NotNull Zone zone, IZoneEffect... zoneEffects)
      Create new ZoneEffect with a given zone, and IZoneEffect array
      Parameters:
      zone - : given Zone to be used as the zone
      zoneEffects - IZoneEffect to apply when players or entities enter or exit the zone

  • Method Details

    • update

      public void update()
      Re-apply the zone effects to all entities (player includes) in the zone. Must be run synchronously.

    • updateSync

      public void updateSync(org.bukkit.plugin.Plugin plugin)
      Synchronously re-apply the zone effects to all entities (player includes) in the zone.

    • onPlayerEnter

      public void onPlayerEnter(org.bukkit.event.player.PlayerMoveEvent e)
      Applies the effects to the player when they enter the zone.
      Specified by:
      onPlayerEnter in interface ZoneListener
      Parameters:
      e - PlayerMoveEvent that triggered the callback

    • onEntityEnter

      public void onEntityEnter(io.papermc.paper.event.entity.EntityMoveEvent e)
      Applies the effects to the entity when they enter the zone.
      Specified by:
      onEntityEnter in interface ZoneListener
      Parameters:
      e - EntityMoveEvent that triggered the callback

    • onPlayerExit

      public void onPlayerExit(org.bukkit.event.player.PlayerMoveEvent e)
      Removes the effects from the player when they exit the zone.
      Specified by:
      onPlayerExit in interface ZoneListener
      Parameters:
      e - PlayerMoveEvent that triggered the callback

    • onEntityExit

      public void onEntityExit(io.papermc.paper.event.entity.EntityMoveEvent e)
      Removes the effects from the entity when they exit the zone.
      Specified by:
      onEntityExit in interface ZoneListener
      Parameters:
      e - EntityMoveEvent that triggered the callback