Package fr.prodrivers.bukkit.commons.sections

Interface IProdriversSection

public interface IProdriversSection
Interface for all Prodrivers Commons-compatible Section implementations. Sections implementing IProdriversSection shall register themselves using SectionManager.register

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    forceNextSection()
    Get if we shall force the player to go to the preferred next section.
    String
    getName()
    Get the section's name, as used by players in commands
    String
    getPreferredNextSection()
    Get this section's preferred next section, ie. the section where the player should go by default when exiting this section
    boolean
    isHub()
    Get if the section should be considered as a hub (player is not in a minigame)
    boolean
    join(org.bukkit.entity.Player player, String subSection, String leavedSection)
    Section join callback, called before teleporting the player to the section.
    boolean
    leave(org.bukkit.entity.Player player, String enteredSection)
    Section leave callback, called before teleporting the player to the section.
    void
    postJoin(org.bukkit.entity.Player player, String subSection, String leavedSection)
    Section post-join callback, called after teleporting the player to the section.
    void
    postLeave(org.bukkit.entity.Player player, String enteredSection)
    Section post-leave callback, called after teleporting the player to the section.
    boolean
    shouldMoveParty()
    Get if the whole party should enter the section

  • Method Details

    • getName

      String getName()
      Get the section's name, as used by players in commands
      Returns:
      Section's name

    • getPreferredNextSection

      String getPreferredNextSection()
      Get this section's preferred next section, ie. the section where the player should go by default when exiting this section
      Returns:
      Section's name or null

    • forceNextSection

      boolean forceNextSection()
      Get if we shall force the player to go to the preferred next section.
      Returns:
      true Force the player to go to the preferred next section

    • isHub

      boolean isHub()
      Get if the section should be considered as a hub (player is not in a minigame)
      Returns:
      true Section is a hub

    • shouldMoveParty

      boolean shouldMoveParty()
      Get if the whole party should enter the section
      Returns:
      true Force the whole party to enter

    • join

      boolean join(org.bukkit.entity.Player player, String subSection, String leavedSection)
      Section join callback, called before teleporting the player to the section. Should prepare the player to enter the section, or deny its entry if he should not.
      Parameters:
      player - Player that joins the section
      subSection - Sub-section to enter. May be null.
      leavedSection - Section name to be leaved. May be null.
      Returns:
      true Continue the section enter process

    • postJoin

      void postJoin(org.bukkit.entity.Player player, String subSection, String leavedSection)
      Section post-join callback, called after teleporting the player to the section. Should makes the final preparation for the player entering the section. Should not kick the player.
      Parameters:
      player - Player that joins the section
      subSection - Sub-section to enter. May be null.
      leavedSection - Section name to be entered. May be null.

    • leave

      boolean leave(org.bukkit.entity.Player player, String enteredSection)
      Section leave callback, called before teleporting the player to the section. Should prepare the player to leave the section, or deny its exit if he should not.
      Parameters:
      player - Player that leaves the section
      enteredSection - Section name to be entered. May be null.
      Returns:
      true Continue the section enter process

    • postLeave

      void postLeave(org.bukkit.entity.Player player, String enteredSection)
      Section post-leave callback, called after teleporting the player to the section. Should makes the final preparation for the player leaving the section.
      Parameters:
      player - Player that leaves the section
      enteredSection - Section name to be entered. May be null.