Interface AutoModule

All Superinterfaces:

ModuleListLocalization, ModuleLocalization, ModuleSimple

public interface AutoModule
extends ModuleListLocalization

Broadcasts the configured messages on a timer.

Method Summary

Modifier and Type	Method	Description
Message.Auto	config()	The config section this module reads its settings from.
Localization.Message.Auto	localization(FPlayer fPlayer)	The localization section for a player, picked from their chosen language.
Permission.Message.Auto	permission()	The permission that gates this module.
void	send(FPlayer fPlayer, String name, Message.Auto.Type type, Pair<Sound, PermissionSetting> sound)	Sends one scheduled broadcast.

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.Auto 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.Auto permission()

Description copied from interface: ModuleSimple

The permission that gates this module.

Specified by:

permission in interface ModuleSimple

Returns:

the permission

localization

Localization.Message.Auto 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

send

void send(FPlayer fPlayer,
 String name,
 Message.Auto.Type type,
 Pair<Sound, PermissionSetting> sound)

Sends one scheduled broadcast.

Parameters:

fPlayer - the reader

name - the config entry the message comes from

type - the broadcast settings

sound - the sound and the permission to hear it