mirror of
https://github.com/NoCheatPlus/NoCheatPlus.git
synced 2025-01-15 03:51:20 +01:00
Javadoc corrections.
This commit is contained in:
parent
a1ee0a43d4
commit
3cdbab6877
@ -10,7 +10,7 @@ import fr.neatmonster.nocheatplus.permissions.Permissions;
|
||||
|
||||
/**
|
||||
* Configuration for the net checks (fast version, sparse).
|
||||
* @author web4web1
|
||||
* @author asofold
|
||||
*
|
||||
*/
|
||||
public class NetConfig extends ACheckConfig {
|
||||
|
@ -8,7 +8,7 @@ import fr.neatmonster.nocheatplus.config.WorldConfigCache;
|
||||
|
||||
/**
|
||||
* Copy-on-write per-world configuration cache.
|
||||
* @author web4web1
|
||||
* @author asofold
|
||||
*
|
||||
*/
|
||||
public class NetConfigCache extends WorldConfigCache<NetConfig> implements CheckConfigFactory {
|
||||
|
@ -5,7 +5,7 @@ import fr.neatmonster.nocheatplus.utilities.ActionFrequency;
|
||||
|
||||
/**
|
||||
* Primary thread only.
|
||||
* @author web4web1
|
||||
* @author asofold
|
||||
*
|
||||
*/
|
||||
public class NetData extends ACheckData {
|
||||
|
@ -9,7 +9,7 @@ import fr.neatmonster.nocheatplus.checks.access.CheckDataFactory;
|
||||
|
||||
/**
|
||||
* Currently primary thread only!
|
||||
* @author web4web1
|
||||
* @author asofold
|
||||
*
|
||||
*/
|
||||
public class NetDataFactory implements CheckDataFactory {
|
||||
|
@ -5,7 +5,7 @@ import org.bukkit.entity.Player;
|
||||
|
||||
/**
|
||||
* JourneyMap + VoxelMap mod.
|
||||
* @author web4web1
|
||||
* @author asofold
|
||||
*
|
||||
*/
|
||||
public class JourneyMapMOTD extends ClientMOTD {
|
||||
|
@ -10,7 +10,7 @@ import fr.neatmonster.nocheatplus.components.NoCheatPlusAPI;
|
||||
|
||||
/**
|
||||
* Feature selection, based on the version.
|
||||
* @author web4web1
|
||||
* @author asofold
|
||||
*
|
||||
*/
|
||||
public class Bugs {
|
||||
|
@ -7,7 +7,7 @@ import fr.neatmonster.nocheatplus.utilities.ds.corw.LinkedHashMapCOW;
|
||||
|
||||
/**
|
||||
* Simple cache for configurations, adding some convenience functionality.
|
||||
* @author web4web1
|
||||
* @author asofold
|
||||
*
|
||||
*/
|
||||
public abstract class ConfigCache <K, C> {
|
||||
|
@ -4,7 +4,7 @@ import org.bukkit.World;
|
||||
|
||||
/**
|
||||
* World-specific cache for configurations. World names are used as keys, convenience methods are added.
|
||||
* @author web4web1
|
||||
* @author asofold
|
||||
*
|
||||
* @param <C>
|
||||
*/
|
||||
|
@ -42,20 +42,21 @@ public class NCPExemptionManager {
|
||||
/**
|
||||
* Exempt an entity from all checks permanently.
|
||||
*
|
||||
* @param entityId
|
||||
* the entity id
|
||||
* @param id
|
||||
* The unique id.
|
||||
*/
|
||||
public static final void exemptPermanently(final UUID id) {
|
||||
exemptPermanently(id, CheckType.ALL);
|
||||
}
|
||||
|
||||
/**
|
||||
* Exempt an entity from the given check or check group permanently (only until restart).
|
||||
* Exempt an entity from the given check or check group permanently (only
|
||||
* until restart).
|
||||
*
|
||||
* @param entityId
|
||||
* the entity id
|
||||
* @param id
|
||||
* The unique id.
|
||||
* @param checkType
|
||||
* the check type
|
||||
* The check type.
|
||||
*/
|
||||
public static final void exemptPermanently(final UUID id, final CheckType checkType) {
|
||||
exempted.get(checkType).add(id);
|
||||
@ -78,9 +79,9 @@ public class NCPExemptionManager {
|
||||
* Exempt a player from a check or check group permanently.
|
||||
*
|
||||
* @param player
|
||||
* the player
|
||||
* The player to exempt.
|
||||
* @param checkType
|
||||
* the check type
|
||||
* The check type.
|
||||
*/
|
||||
public static final void exemptPermanently(final Player player, final CheckType checkType) {
|
||||
exemptPermanently(player.getUniqueId(), checkType);
|
||||
@ -89,15 +90,16 @@ public class NCPExemptionManager {
|
||||
/**
|
||||
* Check if an entity is exempted from a check right now by entity id.
|
||||
* <hr>
|
||||
* This might help exempting NPCs from checks for all time, making performance a lot better. A future purpose might
|
||||
* be to exempt vehicles and similar (including passengers) from checks.
|
||||
* This might help exempting NPCs from checks for all time, making
|
||||
* performance a lot better. A future purpose might be to exempt vehicles
|
||||
* and similar (including passengers) from checks.
|
||||
*
|
||||
* @param entityId
|
||||
* the entity id to exempt from checks
|
||||
* @param id
|
||||
* The unique id.
|
||||
* @param checkType
|
||||
* the type of check to exempt the player from. This can be individual check types, as well as a check
|
||||
* group like MOVING or ALL
|
||||
* @return if the entity is exempted from checks right now
|
||||
* This can be individual check types, as well as a check group
|
||||
* like MOVING or ALL.
|
||||
* @return If the entity is exempted from checks right now.
|
||||
*/
|
||||
public static final boolean isExempted(final UUID id, final CheckType checkType) {
|
||||
return exempted.get(checkType).contains(id);
|
||||
@ -107,11 +109,11 @@ public class NCPExemptionManager {
|
||||
* Check if a player is exempted from a check right now.
|
||||
*
|
||||
* @param player
|
||||
* the player to exempt from checks
|
||||
* The player to exempt from checks
|
||||
* @param checkType
|
||||
* the type of check to exempt the player from. This can be individual check types, as well as a check
|
||||
* group like MOVING or ALL
|
||||
* @return if the player is exempted from the check right now
|
||||
* This can be individual check types, as well as a check group
|
||||
* like MOVING or ALL.
|
||||
* @return If the player is exempted from the check right now.
|
||||
*/
|
||||
public static final boolean isExempted(final Player player, final CheckType checkType) {
|
||||
return isExempted(player.getUniqueId(), checkType);
|
||||
@ -121,7 +123,7 @@ public class NCPExemptionManager {
|
||||
* Undo exempting an entity from all checks.
|
||||
*
|
||||
* @param id
|
||||
* Unique id of a player to exempt.
|
||||
* The unique id.
|
||||
*/
|
||||
public static final void unexempt(final UUID id) {
|
||||
unexempt(id, CheckType.ALL);
|
||||
@ -130,10 +132,10 @@ public class NCPExemptionManager {
|
||||
/**
|
||||
* Undo exempting an entity from a certain check, or check group, as given.
|
||||
*
|
||||
* @param entityId
|
||||
* the entity id
|
||||
* @param id
|
||||
* The unique id.
|
||||
* @param checkType
|
||||
* the check type
|
||||
* The check type.
|
||||
*/
|
||||
public static final void unexempt(final UUID id, final CheckType checkType) {
|
||||
exempted.get(checkType).remove(id);
|
||||
|
@ -15,7 +15,7 @@ public class PluginTests {
|
||||
|
||||
/**
|
||||
* Dummy API, providing only a minimal subset of functionality for offline-testing. Some methods do nothing, some throw an UnsupportedOperationException, some will do something (set/get MCAccess).
|
||||
* @author web4web1
|
||||
* @author asofold
|
||||
*
|
||||
*/
|
||||
public static class DummyNoCheatPlusAPI implements NoCheatPlusAPI {
|
||||
|
Loading…
Reference in New Issue
Block a user