Package com.gamersafer.minecraft.auth.common.onboarding

Interface IOnboardingService

All Known Implementing Classes:

BaseOnboardingService

public interface IOnboardingService

Method Summary

Modifier and Type	Method	Description
void	add(@NonNull IPlayer player)	Adds the player to the onboarding room.
boolean	inRoom(@NonNull IPlayer player)	Returns true if the player is in the onboarding room.
boolean	inWorld(@NonNull IPlayer player)	Returns true if player is in the onboarding world.
boolean	isEnabled()	Returns true if the onboarding room is enabled.
void	reload()	Reloads the onboarding service.
void	remove(@NonNull IPlayer player)	If player is in the onboarding room, then this method will remove the player from the room.
void	showBook(@NonNull IPlayer player)	Shows the onboarding book to player.

Method Details

add

void add(@NonNull IPlayer player)

Adds the player to the onboarding room.

Parameters:

player - the player

remove

void remove(@NonNull IPlayer player)

If player is in the onboarding room, then this method will remove the player from the room.

Otherwise, this method will do nothing.

Parameters:

player - the player

showBook

void showBook(@NonNull IPlayer player)

Shows the onboarding book to player.

Parameters:

player - the player

isEnabled

boolean isEnabled()

Returns true if the onboarding room is enabled.

Returns:

true or false

inRoom

boolean inRoom(@NonNull IPlayer player)

Returns true if the player is in the onboarding room.

If the player is in the onboarding world, but not currently onboarding, then this will return false.

Use inWorld(IPlayer) to check if they are in the world.

Parameters:

player - the player

Returns:

true or false

inWorld

boolean inWorld(@NonNull IPlayer player)

Returns true if player is in the onboarding world.

Note that this method will return true if the player is in the world, regardless of their status with the onboarding room.

Parameters:

player - the player

Returns:

true or false

reload

void reload()

Reloads the onboarding service.