FloodModule (api API)

All Superinterfaces:: ModuleLocalization, ModuleSimple

public interface FloodModule extends ModuleLocalization

Blocks messages that repeat characters or words.

Method Summary

Modifier and Type

Method

Description

Message.Format.Moderation.Flood

config()

The config section this module reads its settings from.

MessageContext

format(MessageContext messageContext)

Checks the message for repetition and records a violation if it breaks the rule.

boolean

isRestricted(UUID uuid)

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

Localization.Message.Format.Moderation.Flood

localization(FPlayer fPlayer)

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

Permission.Message.Format.Moderation.Flood

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
- localization
  
  Localization.Message.Format.Moderation.Flood 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
- config
  
  Message.Format.Moderation.Flood 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.Flood permission()
  
  Description copied from interface: ModuleSimple
  
  The permission that gates this module.
  
  Specified by:
  
  permission in interface ModuleSimple
  
  Returns:
  
  the permission
- format
  
  MessageContext format(MessageContext messageContext)
  
  Checks the message for repetition and records a violation if it breaks the rule.
  
  Parameters:
  
  messageContext - the message being formatted
  
  Returns:
  
  the formatted context
- 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