Interface MentionModule

All Superinterfaces:

ModuleLocalization, ModuleSimple

public interface MentionModule
extends ModuleLocalization

Highlights a player's name in chat and notifies them.

Method Summary

Modifier and Type	Method	Description
MessageContext	addTags(MessageContext messageContext)	Registers the tags that highlight mentioned names.
Message.Format.Mention	config()	The config section this module reads its settings from.
MessageContext	format(MessageContext messageContext)	Finds the mentioned players and marks them in the message.
Localization.Message.Format.Mention	localization(FPlayer fPlayer)	The localization section for a player, picked from their chosen language.
Permission.Message.Format.Mention	permission()	The permission that gates this module.
void	sendMention(FPlayer fPlayer)	Notifies a player that they were mentioned.

Methods inherited from interface ModuleLocalization

cooldown, cooldownOrThrow, permissions, sound, soundOrThrow

Methods inherited from interface ModuleSimple

children, isDisable, name, onDisable, onEnable

Method Details

config

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

Description copied from interface: ModuleSimple

The permission that gates this module.

Specified by:

permission in interface ModuleSimple

Returns:

the permission

localization

Localization.Message.Format.Mention 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

format

MessageContext format(MessageContext messageContext)

Finds the mentioned players and marks them in the message.

Parameters:

messageContext - the message being formatted

Returns:

the formatted context

addTags

MessageContext addTags(MessageContext messageContext)

Registers the tags that highlight mentioned names.

Parameters:

messageContext - the message being formatted

Returns:

the context with the tags added

sendMention

void sendMention(FPlayer fPlayer)

Notifies a player that they were mentioned.

Parameters:

fPlayer - the mentioned player