Package fr.prodrivers.bukkit.commons.hubs

Class MainHub

java.lang.Object

fr.prodrivers.bukkit.commons.sections.Section

fr.prodrivers.bukkit.commons.hubs.MainHub

Direct Known Subclasses:

DefaultMainHub

public abstract class MainHub
extends Section

Base class for Prodrivers Commons-managed main hub.

Implement this class if you want to use Prodrivers Commons' managed main hub with your own logic. Used implementation can be changed in configuration.

Method Summary

Modifier and Type	Method	Description
@NonNull Set<SectionCapabilities>	getCapabilities()	Get all capabilities of a section.
boolean	join(@NonNull org.bukkit.entity.Player player)	Section join callback.
boolean	leave(@NonNull org.bukkit.OfflinePlayer player)	Section leave callback.
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.
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.

Methods inherited from class fr.prodrivers.bukkit.commons.sections.Section

add, addChildren, addParent, contains, contains, getChildSections, getFullName, getName, getParentSection, getParentsFullName, getPlayers, getSelectionUI, getSplitFullName, remove, removeChildren, removeParent

Methods inherited from class java.lang.Object

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

Method Details

getCapabilities

public @NonNull Set<SectionCapabilities> getCapabilities()

Description copied from class: Section

Get all capabilities of a section.

Specified by:

getCapabilities in class Section

Returns:

true Section capabilities

preJoin

public boolean preJoin(@NonNull org.bukkit.entity.Player player,
 Section targetSection,
 boolean fromParty)

Description copied from class: Section

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.

Specified by:

preJoin in class 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 boolean join(@NonNull org.bukkit.entity.Player player)

Description copied from class: Section

Section join callback. Should do the actions required when a player enters a section.

Specified by:

join in class Section

Parameters:

player - Player that joins the section

Returns:

true Continue the section enter process

preLeave

public boolean preLeave(@NonNull org.bukkit.OfflinePlayer player,
 Section targetSection,
 boolean fromParty)

Description copied from class: Section

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.

Specified by:

preLeave in class 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 boolean leave(@NonNull org.bukkit.OfflinePlayer player)

Description copied from class: Section

Section leave callback. Should do the actions required when a player leaves a section.

Specified by:

leave in class Section

Parameters:

player - Player that leaves the section

Returns:

true Continue the section enter process