Interface SidebarModule

All Superinterfaces:

ModuleListLocalization, ModuleLocalization, ModuleSimple

public interface SidebarModule
extends ModuleListLocalization

Draws the rotating sidebar lines.

Method Summary

Modifier and Type	Method	Description
Message.Sidebar	config()	The config section this module reads its settings from.
void	create(UUID uuid)	Shows the sidebar to a player, looked up by id.
void	create(FPlayer fPlayer)	Shows the sidebar to a player.
Localization.Message.Sidebar	localization(FPlayer fPlayer)	The localization section for a player, picked from their chosen language.
Permission.Message.Sidebar	permission()	The permission that gates this module.
void	remove(FPlayer fPlayer)	Takes the sidebar away from a player.
void	update(FPlayer fPlayer)	Advances the sidebar to its next set of lines.

Methods inherited from interface ModuleListLocalization

getAvailableMessages, getCurrentMessage, getNextMessage, getNextMessage, getPlayerIndexOrDefault, joinMultiList, nextInt, savePlayerIndex

Methods inherited from interface ModuleLocalization

cooldown, cooldownOrThrow, permissions, sound, soundOrThrow

Methods inherited from interface ModuleSimple

children, isDisable, name, onDisable, onEnable

Method Details

config

Message.Sidebar config()

Description copied from interface: ModuleSimple

The config section this module reads its settings from.

Specified by:

config in interface ModuleSimple

Returns:

the settings

permission

Permission.Message.Sidebar permission()

Description copied from interface: ModuleSimple

The permission that gates this module.

Specified by:

permission in interface ModuleSimple

Returns:

the permission

localization

Localization.Message.Sidebar localization(FPlayer fPlayer)

Description copied from interface: ModuleLocalization

The localization section for a player, picked from their chosen language.

Specified by:

localization in interface ModuleLocalization

Parameters:

fPlayer - the player the text is for

Returns:

the localization settings

remove

void remove(FPlayer fPlayer)

Takes the sidebar away from a player.

Parameters:

fPlayer - the player

update

void update(FPlayer fPlayer)

Advances the sidebar to its next set of lines.

Parameters:

fPlayer - the player

create

void create(UUID uuid)

Shows the sidebar to a player, looked up by id.

Parameters:

uuid - the player

create

void create(FPlayer fPlayer)

Shows the sidebar to a player.

Parameters:

fPlayer - the player