Package fr.prodrivers.bukkit.commons.sections

Class Section

java.lang.Object
fr.prodrivers.bukkit.commons.sections.Section
Direct Known Subclasses:
MainHub
public abstract class Section extends Object
Define the base Prodrivers Commons Section implementation. Sections make plugins play nice together.

A section is a logical subdivision of a server. A section can be a hub, a mini-game hub, a mini-game instance, or any other needed subdivision. Sections are organized in a tree, with a root (default) section that is its point of entry. Each section has event handlers to react to a player entering or leaving it, doing needed preparation and cleanup work.

Its main use is to allow different plugins to play together by calling preparation and/or cleanup code when player is moving between different subdivisions of the server without handling it themselves/having special code to handle all cases, such as moving between a hub and a mini-game, or a mini-game to another mini-game. Prodrivers Commons' role is to ensure that all join and leave event handlers are correctly called when moving along the section tree. For example, it allows a player to move from one plugin's mini-game to another plugin's mini-game, on the same server or across servers, with proper quit and join code called for each of them, without those plugins having to handle themselves.

It ultimately allows plugins, that where not built to handle other plugins on a server or across servers in mind, to implement those capabilities without many modifications, or even without any modifications by having another plugin handle the interface for it.

Every new player enters the section mechanism by entering the root section. Each player, at any point in time, is guaranteed to be part of a single section, as long as it is part of the mechanism.

Sections implementing it shall register themselves using SectionManager.register

  • Constructor Summary

    Constructors
    Constructor
    Description
    Section(@NonNull String fullName)
    Initialize a new section

  • Method Summary

    Modifier and Type
    Method
    Description
    protected boolean
    add(@NonNull org.bukkit.OfflinePlayer player)
    Adds a player to this section.
    protected void
    addChildren(@NonNull Section section)
    Adds a section as a child to this section.
    protected void
    addParent(@NonNull Section section)
    Adds a section as a parent to this section.
    boolean
    contains(@NonNull Section child)
    Check if a section is a child to this section.
    boolean
    contains(@NonNull org.bukkit.OfflinePlayer player)
    Checks if a player is inside this section.
    abstract @NonNull Set<SectionCapabilities>
    getCapabilities()
    Get all capabilities of a section.
    @NonNull Collection<Section>
    getChildSections()
    Get section's child sections.
    @NonNull String
    getFullName()
    Get the section's full name, containing the name of its parents sections, as used by players in commands
    @NonNull String
    getName()
    Get the section's name, without its parents sections
    @Nullable Section
    getParentSection()
    Get section's parent section.
    @NonNull List<String>
    getParentsFullName()
    Get all the section's parents full names, including the section's full name
    @NonNull Collection<org.bukkit.OfflinePlayer>
    getPlayers()
    Get all players in a section.
    protected SelectionUI
    getSelectionUI()
    Returns this section's selection UI.
    @NonNull List<String>
    getSplitFullName()
    Get the section's full name, containing the name of its parent sections, split along the node separator
    abstract boolean
    join(@NonNull org.bukkit.entity.Player player)
    Section join callback.
    abstract boolean
    leave(@NonNull org.bukkit.OfflinePlayer player)
    Section leave callback.
    abstract boolean
    preJoin(@NonNull org.bukkit.entity.Player player, Section targetSection, boolean fromParty)
    Section pre join callback, called to check whether the player should enter the section.
    abstract boolean
    preLeave(@NonNull org.bukkit.OfflinePlayer player, Section targetSection, boolean fromParty)
    Section pre leave callback, called to check whether the player can leave the section.
    protected boolean
    remove(@NonNull org.bukkit.OfflinePlayer player)
    Removes a player from this section.
    protected void
    removeChildren(@NonNull Section section)
    Removes a section as a child to this section.
    protected void
    removeParent()
    Removes the parent from this section.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Section

      public Section(@NonNull String fullName)
      Initialize a new section
      Parameters:
      fullName - Section full name

  • Method Details

    • getName

      public @NonNull String getName()
      Get the section's name, without its parents sections
      Returns:
      Section's name

    • getFullName

      public @NonNull String getFullName()
      Get the section's full name, containing the name of its parents sections, as used by players in commands
      Returns:
      Section's full name

    • getSplitFullName

      public @NonNull List<String> getSplitFullName()
      Get the section's full name, containing the name of its parent sections, split along the node separator
      Returns:
      Section's split full name

    • getParentsFullName

      public @NonNull List<String> getParentsFullName()
      Get all the section's parents full names, including the section's full name
      Returns:
      Section's parents full name

    • getCapabilities

      public abstract @NonNull Set<SectionCapabilities> getCapabilities()
      Get all capabilities of a section.
      Returns:
      true Section capabilities

    • preJoin

      public abstract boolean preJoin(@NonNull org.bukkit.entity.Player player, Section targetSection, boolean fromParty)
      Section pre join callback, called to check whether the player should enter the section.

      This could be called at any point in the section's lifetime. The player is not guaranteed to actually enter the section.

      The return value should be a guarantee that the player can enter the section.

      Parameters:
      player - Player that should join the section
      targetSection - Section where the player will end up
      fromParty - Indicate that the process was started by the party owner
      Returns:
      true The user is authorized to enter the section

    • join

      public abstract boolean join(@NonNull org.bukkit.entity.Player player)
      Section join callback. Should do the actions required when a player enters a section.
      Parameters:
      player - Player that joins the section
      Returns:
      true Continue the section enter process

    • preLeave

      public abstract boolean preLeave(@NonNull org.bukkit.OfflinePlayer player, Section targetSection, boolean fromParty)
      Section pre leave callback, called to check whether the player can leave the section.

      This could be called at any point in the section's lifetime. The player is not guaranteed to actually leave the section. This can be called even if the player is not actually in the section (ex: called during the check pass of section tree traversal)

      The return value should be a guarantee that the player can leave the section.

      Parameters:
      player - Player that should leave the section
      targetSection - Section where the player will end up
      fromParty - Indicate that the process was started by the party owner
      Returns:
      true The user is authorized to leave the section

    • leave

      public abstract boolean leave(@NonNull org.bukkit.OfflinePlayer player)
      Section leave callback. Should do the actions required when a player leaves a section.
      Parameters:
      player - Player that leaves the section
      Returns:
      true Continue the section enter process

    • getPlayers

      public @NonNull Collection<org.bukkit.OfflinePlayer> getPlayers()
      Get all players in a section.
      Returns:
      Section's players

    • getParentSection

      public @Nullable Section getParentSection()
      Get section's parent section.
      Returns:
      Section's parent section

    • contains

      public boolean contains(@NonNull org.bukkit.OfflinePlayer player)
      Checks if a player is inside this section.
      Parameters:
      player - Player to consider
      Returns:
      true if the player is in this section

    • add

      protected boolean add(@NonNull org.bukkit.OfflinePlayer player)
      Adds a player to this section.
      Parameters:
      player - Player to add
      Returns:
      true if the player was added to this section

    • remove

      protected boolean remove(@NonNull org.bukkit.OfflinePlayer player)
      Removes a player from this section.
      Parameters:
      player - Player to remove
      Returns:
      true if the player was removed from this section

    • getChildSections

      public @NonNull Collection<Section> getChildSections()
      Get section's child sections.
      Returns:
      Section's child sections

    • contains

      public boolean contains(@NonNull Section child)
      Check if a section is a child to this section.
      Parameters:
      child - Section to consider
      Returns:
      true if the section is a child to this section

    • addChildren

      protected void addChildren(@NonNull Section section)
      Adds a section as a child to this section.
      Parameters:
      section - Section to add as a child

    • removeChildren

      protected void removeChildren(@NonNull Section section)
      Removes a section as a child to this section.
      Parameters:
      section - Section to remove as a child

    • addParent

      protected void addParent(@NonNull Section section)
      Adds a section as a parent to this section. A section can only have one parent a time. Calling this will erase the previous parent.
      Parameters:
      section - Section to add as a parent

    • removeParent

      protected void removeParent()
      Removes the parent from this section. Ensure that you add another parent afterwards. Only the root section should have no parent.

    • getSelectionUI

      protected SelectionUI getSelectionUI()
      Returns this section's selection UI. Called only when section returns capability SectionCapabilities.CUSTOM_SELECTION_UI. If not, the section manager will call the default selection UI.
      Returns:
      This section's selection UI