Package me.remigio07.chatplugin.api.server.integration.anticheat

Class AnticheatManager

java.lang.Object

me.remigio07.chatplugin.api.server.integration.anticheat.AnticheatManager

All Implemented Interfaces:

ChatPluginManager

public abstract class AnticheatManager
extends Object
implements ChatPluginManager

Manager that handles an AnticheatIntegration's Violations.

See Also:

• ChatPlugin wiki/Modules/Integrations/Anticheats

Constructor Summary

Constructors

Constructor	Description
AnticheatManager()

Method Summary

Modifier and Type	Method	Description
abstract void	addViolation(OfflinePlayer cheater, IntegrationType<AnticheatIntegration> anticheat, String cheatID, String component, String server, int amount, int ping, double tps, VersionUtils.Version version)	Adds a violation to getViolations().
abstract void	clearViolations(OfflinePlayer cheater)	Clears violations for the specified player.
static AnticheatManager	getInstance()	Gets this manager's instance.
List<String>	getReasonsStartWith()	Gets the list of strings a punishment's reason has to start with to be considered created automatically by the anticheat.
Map<OfflinePlayer,List<Violation>>	getViolations()	Gets current violations' map.
List<Violation>	getViolations(OfflinePlayer player)	Gets a list of violations from getViolations().
long	getViolationsExpirationTimeout()	Gets the time required for a violation to expire, in milliseconds.
abstract boolean	isAnticheatReason(String reason)	Checks if the specified punishment's reason is contained in getReasonsStartWith().
boolean	isEnabled()	Checks if this manager is enabled.
abstract void	removeViolation(OfflinePlayer cheater, IntegrationType<AnticheatIntegration> anticheat, String cheatID)	Removes a violation from getViolations().

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface me.remigio07.chatplugin.api.common.util.manager.ChatPluginManager

checkAvailability, isReloadable, load, reload, unload

Constructor Details

AnticheatManager

public AnticheatManager()

Method Details

isEnabled

public boolean isEnabled()

Checks if this manager is enabled.

Will return IntegrationManager.isAtLeastOneAnticheatEnabled().

Specified by:

isEnabled in interface ChatPluginManager

Returns:

Whether this manager is enabled

getViolations

public Map<OfflinePlayer,List<Violation>> getViolations()

Gets current violations' map.

Every entry is composed of a player and the list of their Violations.

Do not modify the returned map. Use addViolation(OfflinePlayer, IntegrationType, String, String, String, int, int, double, Version), removeViolation(OfflinePlayer, IntegrationType, String) and clearViolations(OfflinePlayer) to interact with it.

Returns:

Current violations' map

getViolations

public List<Violation> getViolations(OfflinePlayer player)

Gets a list of violations from getViolations().

Will return Collections.emptyList() if getViolations() does not contain the specified player.

Do not modify the returned list. Use addViolation(OfflinePlayer, IntegrationType, String, String, String, int, int, double, Version), removeViolation(OfflinePlayer, IntegrationType, String) and clearViolations(OfflinePlayer) to interact with it.

Parameters:

player - Player to check

Returns:

Player's current violations

getReasonsStartWith

public List<String> getReasonsStartWith()

Gets the list of strings a punishment's reason has to start with to be considered created automatically by the anticheat.

Found at: "settings.anticheat-integration.reasons-start-with" in ConfigurationType.CONFIG

Returns:

Anticheat integration's reasons

getViolationsExpirationTimeout

public long getViolationsExpirationTimeout()

Gets the time required for a violation to expire, in milliseconds.

Found at: "settings.anticheat-integration.violations-expiration-timeout" in ConfigurationType.CONFIG

Returns:

Violations' expiration timeout

getInstance

public static AnticheatManager getInstance()

Gets this manager's instance.

Returns:

Manager's instance

addViolation

public abstract void addViolation(OfflinePlayer cheater,
 IntegrationType<AnticheatIntegration> anticheat,
 String cheatID,
 String component,
 String server,
 int amount,
 int ping,
 double tps,
 VersionUtils.Version version)

Adds a violation to getViolations().

Parameters:

cheater - Violation's cheater

anticheat - Anticheat that flagged the player

cheatID - Violation's cheat's ID

component - Violation's cheat's display name

server - Violation's origin server

amount - Amount of times the player got flagged

ping - Cheater's ping

tps - Origin server's TPS

version - Cheater's version

removeViolation

public abstract void removeViolation(OfflinePlayer cheater,
 IntegrationType<AnticheatIntegration> anticheat,
 String cheatID)

Removes a violation from getViolations().

Parameters:

cheater - Violation's cheater

anticheat - Anticheat that flagged the player

cheatID - Violation's cheat's ID

clearViolations

public abstract void clearViolations(OfflinePlayer cheater)

Clears violations for the specified player.

Parameters:

cheater - Player to clear the violations for

isAnticheatReason

public abstract boolean isAnticheatReason(String reason)

Checks if the specified punishment's reason is contained in getReasonsStartWith().

Case will be lowered and colors will be stripped using ChatColor.stripColor(String).

Will return false if reason == null.

Parameters:

reason - Punishment's reason

Returns:

Whether the reason is an anticheat's reason