PolarDocs Client Area

Check Interface

Introduction#

The Check interface represents an anticheat check in Polar. It provides methods to access information about the check.

Methods#

type#

java
CheckType type();

Description:

Gets the type of the check.

Returns:

The CheckType of the check.

name#

java
String name();

Description:

Gets the name of the check.

Returns:

The name of the check as a String.

punishable#

java
boolean punishable();

Description:

Determines if the check is punishable.

Returns:

true if the check is punishable, false otherwise.

punishmentType#

java
PunishmentType punishmentType();

Description:

Gets the type of punishment associated with the check.

Returns:

The PunishmentType for the check.

enabled#

java
boolean enabled();

Description:

Determines if the check is enabled.

Returns:

true if the check is enabled, false otherwise.

punishVl#

java
double punishVl();

Description:

Gets the violation level threshold at which a punishment is triggered.

Returns:

The punishment violation level threshold as a double.

violationLevel#

java
double violationLevel();

Description:

Gets the current violation level for this check.

Returns:

The current violation level as a double.