Interface SwearModule

All Superinterfaces:

ModuleLocalization, ModuleSimple

public interface SwearModule
extends ModuleLocalization

Censors messages that contain forbidden words.

Method Summary

Modifier and Type	Method	Description
MessageContext	addTag(MessageContext messageContext)	Registers the tag that renders a censored word.
Message.Format.Moderation.Swear	config()	The config section this module reads its settings from.
MessageContext	format(MessageContext messageContext)	Censors the forbidden words and records a violation if the rule was broken.
boolean	isRestricted(UUID uuid)	Whether this player has broken the rule often enough to be punished for it.
Localization.Message.Format.Moderation.Swear	localization(FPlayer fPlayer)	The localization section for a player, picked from their chosen language.
Permission.Message.Format.Moderation.Swear	permission()	The permission that gates this module.

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.Moderation.Swear 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.Moderation.Swear 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.Moderation.Swear 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)

Censors the forbidden words and records a violation if the rule was broken.

Parameters:

messageContext - the message being formatted

Returns:

the formatted context

addTag

MessageContext addTag(MessageContext messageContext)

Registers the tag that renders a censored word.

Parameters:

messageContext - the message being formatted

Returns:

the context with the tag added

isRestricted

boolean isRestricted(UUID uuid)

Whether this player has broken the rule often enough to be punished for it.

Parameters:

uuid - the player

Returns:

true if the violation limit has been reached