Interface WorldModule

All Superinterfaces:

ModuleSimple

public interface WorldModule
extends ModuleSimple

Inserts the sender's world into a message, by name or by type.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	WorldModule.Mode	Whether the world is shown by name or by type.

Method Summary

Modifier and Type	Method	Description
MessageContext	addTag(MessageContext messageContext)	Registers the tag that renders the sender's world.
Message.Format.World	config()	The config section this module reads its settings from.
Permission.Message.Format.World	permission()	The permission that gates this module.
void	update(FPlayer fPlayer)	Refreshes the world recorded for a player after they change dimension.

Methods inherited from interface ModuleSimple

children, isDisable, name, onDisable, onEnable, permissions

Method Details

config

Message.Format.World 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.Format.World permission()

Description copied from interface: ModuleSimple

The permission that gates this module.

Specified by:

permission in interface ModuleSimple

Returns:

the permission

addTag

MessageContext addTag(MessageContext messageContext)

Registers the tag that renders the sender's world.

Parameters:

messageContext - the message being formatted

Returns:

the context with the tag added

update

void update(FPlayer fPlayer)

Refreshes the world recorded for a player after they change dimension.

Parameters:

fPlayer - the player