diff --git a/CompatNoCheatPlus/src/me/asofold/bpl/cncp/hooks/ncp/CheckType.java b/CompatNoCheatPlus/src/me/asofold/bpl/cncp/hooks/ncp/CheckType.java index 10e21bb..498bac4 100644 --- a/CompatNoCheatPlus/src/me/asofold/bpl/cncp/hooks/ncp/CheckType.java +++ b/CompatNoCheatPlus/src/me/asofold/bpl/cncp/hooks/ncp/CheckType.java @@ -1,7 +1,10 @@ package me.asofold.bpl.cncp.hooks.ncp; - - +/** + * Type of checks and their groups (potentially parents). + * @author mc_dev + * + */ public enum CheckType { // GENERAL @@ -32,7 +35,8 @@ public enum CheckType { BLOCKBREAK_FASTBREAK(BLOCKBREAK), BLOCKBREAK_NOSWING(BLOCKBREAK), BLOCKBREAK_DIRECTION(BLOCKBREAK), - // .... + + // TODO: add more .... ; // end of members. diff --git a/CompatNoCheatPlus/src/me/asofold/bpl/cncp/hooks/ncp/NCPHook.java b/CompatNoCheatPlus/src/me/asofold/bpl/cncp/hooks/ncp/NCPHook.java index 64a58ef..be5ccb8 100644 --- a/CompatNoCheatPlus/src/me/asofold/bpl/cncp/hooks/ncp/NCPHook.java +++ b/CompatNoCheatPlus/src/me/asofold/bpl/cncp/hooks/ncp/NCPHook.java @@ -25,9 +25,9 @@ public interface NCPHook{ /** * This is called on failure of a check.
- * This is the minimal interface, one should probably add specific information - * like (target) locations and VL, but with this a lot is possible already (cncp).
- * See AbstractNCPHook for future questions. + * This is the minimal interface, it might later be extended by specific information + * like (target) locations and VL, but with this a lot is possible already (see cncp).
+ * See AbstractNCPHook for future compatibility questions. * @param checkType the check that failed. * @param player The player that failed the check. * @return If to cancel the check failure processing. diff --git a/CompatNoCheatPlus/src/me/asofold/bpl/cncp/hooks/ncp/NCPHookManager.java b/CompatNoCheatPlus/src/me/asofold/bpl/cncp/hooks/ncp/NCPHookManager.java index 12edcfe..0092268 100644 --- a/CompatNoCheatPlus/src/me/asofold/bpl/cncp/hooks/ncp/NCPHookManager.java +++ b/CompatNoCheatPlus/src/me/asofold/bpl/cncp/hooks/ncp/NCPHookManager.java @@ -40,7 +40,7 @@ public final class NCPHookManager { private final static Map allHooks = new HashMap(); /** - * Mapping the check ids to the hooks. + * Mapping the check types to the hooks. */ private static final Map> hooksByChecks = new HashMap>(); @@ -74,7 +74,7 @@ public final class NCPHookManager { } /** - * Add hook to the hooksByChecks mappings, for the check id and if different group id. + * Add hook to the hooksByChecks mappings, for the check type and if present, group type. * assumes that the hook already has been registered in the allHooks map. * @param checkType * @param hook @@ -206,7 +206,7 @@ public final class NCPHookManager { /* External API for adding hooks etc. */ /** - * Register a hook for a specific check id (all, group, or an individual check). + * Register a hook for a specific check type (all, group, or an individual check). * @param checkType * @param hook * @return An id to identify the hook, will return the existing id if the hook was already present somewhere. @@ -220,15 +220,15 @@ public final class NCPHookManager { /** * Register a hook for several individual checks ids (all, group, or an individual checks). - * @param checkIds Array of ids to register the hook for. If you pass null this hok will be registered for all checks. + * @param checkTypes Array of check types to register the hook for. If you pass null this hook will be registered for all checks. * @param hook * @return */ - public static Integer addHook(CheckType[] checkIds, NCPHook hook){ - if (checkIds == null) checkIds = new CheckType[]{CheckType.ALL}; + public static Integer addHook(CheckType[] checkTypes, NCPHook hook){ + if (checkTypes == null) checkTypes = new CheckType[]{CheckType.ALL}; Integer hookId = getId(hook); - for (CheckType checkId : checkIds){ - addToMappings(checkId, hook); + for (CheckType checkType : checkTypes){ + addToMappings(checkType, hook); } logHookAdded(hook); return hookId;