Cheat (common 2.4.2 API)

java.lang.Object
- com.elikill58.negativity.universal.detections.AbstractDetection<CheatKeys>
- - com.elikill58.negativity.universal.detections.Cheat

All Implemented Interfaces:

Comparable<CheatKeys>

Direct Known Subclasses:

AimBot, AirJump, AirPlace, AntiKnockback, AntiPotion, AutoClick, AutoSteal, Blink, Chat, Critical, ElytraFly, FastBow, FastEat, FastLadder, FastPlace, FastStairs, Fly, ForceField, GroundSpoof, IncorrectPacket, InventoryMove, Jesus, NoFall, NoPitchLimit, NoSlowDown, NoWeb, Nuker, Phase, PingSpoof, Reach, Regen, Scaffold, Sneak, Speed, Spider, Step, Strafe, SuperKnockback, Timer, XRay
```
public abstract class Cheat
extends AbstractDetection<CheatKeys>
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Cheat.CheatCategory

static class Cheat.CheatDescription

static class Cheat.CheatHover

Nested Classes
Modifier and Type	Class and Description
`static class`	`Cheat.CheatCategory`
`static class`	`Cheat.CheatDescription`
`static class`	`Cheat.CheatHover`

Field Summary

Fields
Modifier and Type Field and Description

static List<Cheat> CHEATS
- Fields inherited from class com.elikill58.negativity.universal.detections.AbstractDetection
  config, key, material

Fields
Modifier and Type	Field and Description
`static List<Cheat>`	`CHEATS`

Constructor Summary

Constructors
Constructor and Description
`Cheat(CheatKeys key, Cheat.CheatCategory type, Material m, Cheat.CheatDescription... options)` Create a new cheat object and load default config

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`allowKick()` Check if the cheat is allowed to kick player
`boolean`	`checkActive(Check check)` Check if a detection is active
`boolean`	`checkActive(String checkName)` Check if a detection is active
`static Cheat`	`forKey(CheatKeys key)` Get the cheat according to the key
`static Cheat`	`fromString(String name)` Get cheat from a name Can be the key, the name or one of the alias
`int`	`getAlertToKick()` Get the amount of needed alert to kick.
`static Map<CheatKeys,Cheat>`	`getCheatByKeys()` Return a map of cheat keys and their corresponding cheat instance
`Cheat.CheatCategory`	`getCheatCategory()` Get the category of the cheat
`static Set<CheatKeys>`	`getCheatKeys()` Get all cheat keys
`static CheckManager`	`getCheckManager()`
`List<Check>`	`getChecks()`
`String`	`getCommandName()` Get the exact name of the cheat but for command (without special char, space ...)
`static List<Cheat>`	`getEnabledCheat()`
`int`	`getMaxAlertPing()` Get the maximum ping to create alert By default it's 150ms
`String`	`getName()` Get the exact name of the cheat
`List<Cheat.CheatDescription>`	`getOptions()`
`int`	`getReliabilityAlert()` Get needed reliability to see alert By default it's 60%
`boolean`	`hasOption(Cheat.CheatDescription o)`
`boolean`	`hasVerif()` Check if the cheat can verif someone
`Cheat.CheatHover`	`hoverMsg(String key, Object... placeholders)` Create a new hover message
`boolean`	`isSetBack()` Check if the setBack option is enabled
`static void`	`loadCheat()` Load all cheat Support reload
`@Nullable String`	`makeVerificationSummary(VerifData data, NegativityPlayer np)` Create a verification summary
`void`	`performSetBack(Player p)` Use set back option of the player Warn: this doesn't check if setBack option is enabled
`<T> void`	`recordData(UUID target, VerifData.DataType<T> type, T value)` Add data to verification
`boolean`	`setAllowKick(boolean b)` Set the allowability to kick.
`boolean`	`setBack(boolean b)` Set if setback option is active Warn: this don't save the config
`void`	`setCheckActive(Check check, boolean active)` Check if a detection is active
`void`	`setCheckActive(String checkName, boolean active)` Check if a detection is active
`void`	`setVerif(boolean verif)` Set if the cheat is used in verif Warn: this don't save the config
`static List<Cheat>`	`values()`

Methods inherited from class com.elikill58.negativity.universal.detections.AbstractDetection
compareTo, getConfig, getKey, getMaterial, isActive, isDisabledForBedrock, saveConfig, setActive

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CHEATS
```
public static final List<Cheat> CHEATS
```
- Constructor Detail
  - Cheat
```
public Cheat(CheatKeys key,
             Cheat.CheatCategory type,
             Material m,
             Cheat.CheatDescription... options)
```
    Create a new cheat object and load default config
    
    Parameters:
    
    key - the cheat key
    
    type - the cheat category
    
    m - the material used in inventory to represent this cheat
    
    options - all options that describe the cheat
- Method Detail
  - getCheckManager
```
public static CheckManager getCheckManager()
```
  - getName
```
public String getName()
```
    Get the exact name of the cheat
    
    Overrides:
    
    getName in class AbstractDetection<CheatKeys>
    
    Returns:
    
    the name
  - getCommandName
```
public String getCommandName()
```
    Get the exact name of the cheat but for command (without special char, space ...)
    
    Returns:
    
    the name formatted
  - checkActive
```
public boolean checkActive(String checkName)
```
    Check if a detection is active
    
    Parameters:
    
    checkName - the name of the detection
    
    Returns:
    
    true if the detection is active
  - checkActive
```
public boolean checkActive(Check check)
```
    Check if a detection is active
    
    Parameters:
    
    check - the check that we are looking to check
    
    Returns:
    
    true if the detection is active
  - setCheckActive
```
public void setCheckActive(String checkName,
                           boolean active)
```
    Check if a detection is active
    
    Parameters:
    
    checkName - the name of the detection
    
    active - if the check will be active
  - setCheckActive
```
public void setCheckActive(Check check,
                           boolean active)
```
    Check if a detection is active
    
    Parameters:
    
    check - the check of the detection
    
    active - if the check will be active
  - getCheatCategory
```
public Cheat.CheatCategory getCheatCategory()
```
    Get the category of the cheat
    
    Returns:
    
    the cheat category
  - getReliabilityAlert
```
public int getReliabilityAlert()
```
    Get needed reliability to see alert By default it's 60%
    
    Returns:
    
    the needed reliability
  - isSetBack
```
public boolean isSetBack()
```
    Check if the setBack option is enabled
    
    Returns:
    
    true if enabled
  - allowKick
```
public boolean allowKick()
```
    Check if the cheat is allowed to kick player
    
    Returns:
    
    true if kick is allowed
  - setAllowKick
```
public boolean setAllowKick(boolean b)
```
    Set the allowability to kick.
    Warn: this doesn't save the config
    
    Parameters:
    
    b - the new value
    
    Returns:
    
    the given boolean value
  - getAlertToKick
```
public int getAlertToKick()
```
    Get the amount of needed alert to kick.
    By default it's 5
    
    Returns:
    
    the needed alert counter
  - setBack
```
public boolean setBack(boolean b)
```
    Set if setback option is active Warn: this don't save the config
    
    Parameters:
    
    b - the new value
    
    Returns:
    
    the given boolean value
  - getMaxAlertPing
```
public int getMaxAlertPing()
```
    Get the maximum ping to create alert By default it's 150ms
    
    Returns:
    
    the max ping to create alert
  - setVerif
```
public void setVerif(boolean verif)
```
    Set if the cheat is used in verif Warn: this don't save the config
    
    Parameters:
    
    verif - the new value
  - hasVerif
```
public boolean hasVerif()
```
    Check if the cheat can verif someone
    
    Returns:
    
    true if the cheat can verif
  - performSetBack
```
public void performSetBack(Player p)
```
    Use set back option of the player Warn: this doesn't check if setBack option is enabled
    
    Parameters:
    
    p - the player which have to be set back
  - hoverMsg
```
public Cheat.CheatHover hoverMsg(String key,
                                 Object... placeholders)
```
    Create a new hover message
    
    Parameters:
    
    key - the key of the message
    
    placeholders - all placeholders of the message
    
    Returns:
    
    the cheatHover which will be showed
  - makeVerificationSummary
```
public @Nullable String makeVerificationSummary(VerifData data,
                                                NegativityPlayer np)
```
    Create a verification summary
    
    Parameters:
    
    data - the verif data
    
    np - the negativity player
    
    Returns:
    
    the summary (or null if cheat didn't verif/find something)
  - recordData
```
public final <T> void recordData(UUID target,
                                 VerifData.DataType<T> type,
                                 T value)
```
    Add data to verification
    
    Type Parameters:
    
    T - The type of the recorded data
    
    Parameters:
    
    target - the player which create the data
    
    type - the data type
    
    value - the value recorded
  - getChecks
```
public List<Check> getChecks()
```
  - getOptions
```
public List<Cheat.CheatDescription> getOptions()
```
  - hasOption
```
public boolean hasOption(Cheat.CheatDescription o)
```
  - fromString
```
public static Cheat fromString(String name)
```
    Get cheat from a name Can be the key, the name or one of the alias
    
    Parameters:
    
    name - the cheat name
    
    Returns:
    
    the cheat or null if anything found
  - forKey
```
public static Cheat forKey(CheatKeys key)
```
    Get the cheat according to the key
    
    Parameters:
    
    key - the cheat key
    
    Returns:
    
    the cheat or null if anything is found
  - getCheatKeys
```
public static Set<CheatKeys> getCheatKeys()
```
    Get all cheat keys
    
    Returns:
    
    all cheat keys
  - getCheatByKeys
```
public static Map<CheatKeys,Cheat> getCheatByKeys()
```
    Return a map of cheat keys and their corresponding cheat instance
    
    Returns:
    
    keys and their cheat
  - loadCheat
```
public static void loadCheat()
```
    Load all cheat Support reload
  - values
```
public static List<Cheat> values()
```
  - getEnabledCheat
```
public static List<Cheat> getEnabledCheat()
```

Class Cheat

Nested Class Summary

Field Summary

Fields inherited from class com.elikill58.negativity.universal.detections.AbstractDetection

Constructor Summary

Method Summary

Methods inherited from class com.elikill58.negativity.universal.detections.AbstractDetection

Methods inherited from class java.lang.Object

Field Detail

CHEATS

Constructor Detail

Cheat

Method Detail

getCheckManager

getName

getCommandName

checkActive

checkActive

setCheckActive

setCheckActive

getCheatCategory

getReliabilityAlert

isSetBack

allowKick

setAllowKick

getAlertToKick

setBack

getMaxAlertPing

setVerif

hasVerif

performSetBack

hoverMsg

makeVerificationSummary

recordData

getChecks

getOptions

hasOption

fromString

forKey

getCheatKeys

getCheatByKeys

loadCheat

values

getEnabledCheat