Page 1 of 1

CoreProtect - API [v3]

Posted: Tue Jun 02, 2015 10:57 am
by Intelli
CoreProtect API v3 [CoreProtect v2.11.0+]

This post is for v3 of the CoreProtect API.
A newer version can be found here: http://minerealm.com/community/viewtopi ... 32&t=16390


The CoreProtect API enables you to log your own block changes, perform lookups, rollbacks, restores, and more. This is for advanced plugin developers.

Upgrading From API v2
The changes from the previous API version are as follows:
  • 1. The following functions no longer work:
    Code: Select all
    List<String[]> performPartialLookup(String user, int time, int radius, Location location, List<Integer> restrict, List<Integer> exclude, int limit_offset, int limit_count)
    
    List<String[]> performLookup(String user, int time, int radius, Location location, List<Integer> restrict, List<Integer> exclude)
    
    List<String[]> performRollback(String user, int time, int radius, Location location, List<Integer> restrict, List<Integer> exclude)
    
    List<String[]> performRestore(String user, int time, int radius, Location location, List<Integer> restrict, List<Integer> exclude)
    
    boolean logPlacement(String user, Location location, int type, byte data)
    
    boolean logRemoval(String user, Location location, int type, byte data)
  • 2. The following functions have been added:
    Code: Select all
    List<String[]> performPartialLookup(String user, int time, int radius, Location location, List<Object> restrict, List<Object> exclude, int limit_offset, int limit_count)
    
    List<String[]> performLookup(String user, int time, int radius, Location location, List<Object> restrict, List<Object> exclude)
    
    List<String[]> performRollback(String user, int time, int radius, Location location, List<Object> restrict, List<Object> exclude)
    
    List<String[]> performRestore(String user, int time, int radius, Location location, List<Object> restrict, List<Object> exclude)
    
    boolean logPlacement(String user, Location location, Material type, byte data)
    
    boolean logRemoval(String user, Location location, Material type, byte data)
Please note: In CoreProtect 2.11, usage of entity IDs and block IDs has been completely removed, and replaced by usage of Bukkit's internal EntiityType and Material types.

You can use the following code to map an entity ID or a block ID to EntityType or Material.
Code: Select all
// Convert a block ID to a Material
int blockId = 1; //stone
Material material = Material.getMaterial(blockId);

// Convert an entity ID to an EntityType
int entityId = 50; //creeper
EntityType entityType = EntityType.fromId(entityId);
Getting Started

Ensure you're using CoreProtect 2.11.0 or higher. Add it as an external jar to your plugin in your IDE.

The first thing you need to do is get access to CoreProtect. You can do this by using code similar to the following:
Code: Select all
import net.coreprotect.CoreProtect;
import net.coreprotect.CoreProtectAPI;

private CoreProtectAPI getCoreProtect() {
Plugin plugin = getServer().getPluginManager().getPlugin("CoreProtect");
     
// Check that CoreProtect is loaded
if (plugin == null || !(plugin instanceof CoreProtect)) {
    return null;
}
        
// Check that the API is enabled
CoreProtectAPI CoreProtect = ((CoreProtect)plugin).getAPI();
if (CoreProtect.isEnabled()==false){
    return null;
}

// Check that a compatible version of the API is loaded
if (CoreProtect.APIVersion() < 3){
    return null;
}
      	
return CoreProtect;
}
With this code, you can then access the API with a call like the following:
Code: Select all
CoreProtectAPI CoreProtect = getCoreProtect();
if (CoreProtect!=null){ //Ensure we have access to the API
  CoreProtect.testAPI(); //Will print out "[CoreProtect] API Test Successful." in the console.
}
Hooray, you're now using the CoreProtect API!

Quick Documentation

Available functions:
Code: Select all
boolean isEnabled()

void testAPI()

List<String[]> performLookup(String user, int time, int radius, Location location, List<Object> restrict, List<Object> exclude)

List<String[]> performRollback(String user, int time, int radius, Location location, List<Object> restrict, List<Object> exclude)

List<String[]> performRestore(String user, int time, int radius, Location location, List<Object> restrict, List<Object> exclude)

List<String[]> blockLookup(Block block, int time)

ParseResult parseResult(String[] data)

boolean logPlacement(String user, Location location, Material type, byte data)

boolean logRemoval(String user, Location location, Material type, byte data)

boolean logInteraction(String user, Location location)

boolean hasPlaced(String user, Block block, int time, int offset)

boolean hasRemoved(String user, Block block, int time, int offset)
Usage:
isEnabled()
Calling this will return true if the server has the CoreProtect API enabled, and false if it does not.

--
testAPI()
Running this will print out "[CoreProtect] API Test Successful." in the server console.

--
performLookup(String user, int time, int radius, Location location, List<Object> restrict, List<Object> exclude)
This will perform a lookup.
  • user: Specify a username to perform a lookup on. Can be set to "null" if both a radius and a location are specified.
  • time: Specify the amount of time to search back. "5" would return results from the last 5 seconds.
  • radius: Specify a radius to restrict the search to. A location must be specified if using this. Set to "0" to disable.
  • location: Specify a location to search around. Can be set to "null" if no radius is specified, and a user is specified.
  • restrict: Specify a list of EntityType's or Material's to restrict the search to. Can be set to "null"
  • exclude: Specify a list of EntityType's or Material's to exclude from the search. Can be set to "null"
--
performRollback(String user, int time, int radius, Location location, List<Object> restrict, List<Object> exclude)
This will perform a rollback.
  • user: Specify a username to perform a rollback on. Can be set to "null" if both a radius and a location are specified.
  • time: Specify the amount of time to rollback. "5" would return results from the last 5 seconds.
  • radius: Specify a radius to restrict the rollback to. A location must be specified if using this. Set to "0" to disable.
  • location: Specify a location to rollback around. Can be set to "null" if no radius is specified, and a user is specified.
  • restrict: Specify a list of EntityType's or Material's to restrict the rollback to. Can be set to "null"
  • exclude: Specify a list of EntityType's or Material's to exclude from the rollback. Can be set to "null"
--
performRestore(String user, int time, int radius, Location location, List<Object> restrict, List<Object> exclude)
This will perform a restore.
  • user: Specify a username to perform a restore on. Can be set to "null" if both a radius and a location are specified.
  • time: Specify the amount of time to restore. "5" would return results from the last 5 seconds.
  • radius: Specify a radius to restrict the restore to. A location must be specified if using this. Set to "0" to disable.
  • location: Specify a location to restore around. Can be set to "null" if no radius is specified, and a user is specified.
  • restrict: Specify a list of EntityType's or Material's to restrict the restore to. Can be set to "null"
  • exclude: Specify a list of EntityType's or Material's to exclude from the restore. Can be set to "null"
--
blockLookup(Block block, int time)
This will perform a full lookup on a single block.
  • block: The block to perform the lookup on.
  • time: Specify the amount of time to lookup. "5" would return results from the last 5 seconds.
--
ParseResult parseResult(String[] data)
This will parse results from a lookup. You'll then be able to view the following:
  • getX(): Get the X coordinate of the block.
  • getY(): Get the Y coordinate of the block.
  • getZ(): Get the Z coordinate of the block.
  • getType(): Get the Material of the block.
  • getData(): Get the byte data of the block.
  • getActionId(): Get the action ID. (0=removed, 1=placed, 2=interaction)
  • getActionString(): Get the action as a string. (Removal, Placement, Interaction)
  • isRolledBack(): If the block is currently rolled back or not.
  • worldName(): The name of the world the block is located in.
--
logPlacement(String user, Location location, Material type, byte data)
This will log a block as being placed.
  • user: Specify the username to log as having placed the block.
  • location: Specify the location of the block you're logging.
  • type: Specify the Material of the block you're logging.
  • data: Specify the byte data value of the block you're logging.
--
logRemoval(String user, Location location, Material type, byte data)
This will log a block as being removed/broken.
  • user: Specify the username to log as having removed the block.
  • location: Specify the location of the block you're logging.
  • type: Specify the Material of the block you're logging.
  • data: Specify the byte data value of the block you're logging.
--
logInteraction(String user, Location location)
This will log a block as having been interacted with.
  • user: Specify the username to log as having caused the interaction.
  • location: Specify the location of the interaction you're logging.
--
hasPlaced(String user, Block block, int time, int offset)
This will return true if a user has already placed a block at the location within the specified time limit.
  • user: The username you're checking to see if they've placed a block already.
  • block: The block you're checking.
  • time: How far back to check. "5" would only check through the last 5 seconds of logged blocks.
  • offset: A time offset. "2" would ignore the last 2 seconds of most recently ignored data. (0=no offset)
--
hasRemoved(String user, Block block, int time, int offset)
This will return true if a user has already removed a block at the location within the specified time limit.
  • user: The username you're checking to see if they've removed a block already.
  • block: The block you're checking.
  • time: How far back to check. "5" would only check through the last 5 seconds of logged blocks.
  • offset: A time offset. "2" would ignore the last 2 seconds of most recently ignored data. (0=no offset)
Examples

1. Get the last 60 seconds of block data for the user "Notch".
Code: Select all
CoreProtectAPI CoreProtect = getCoreProtect();
if (CoreProtect!=null){ //Ensure we have access to the API
  List<String[]> lookup = CoreProtect.performLookup("Notch", 60, 0, null, null, null);
  if (lookup!=null){
    for (String[] value : lookup){
      ParseResult result = CoreProtect.parseResult(value);
      int x = result.getX();
      int y = result.getY();
      int z = result.getZ();
      //...
    }
  }
}
--

2. Get the last 60 seconds of block data for the user "Notch", excluding dirt and grass blocks.
Code: Select all
CoreProtectAPI CoreProtect = getCoreProtect();
if (CoreProtect!=null){ //Ensure we have access to the API
  List<Object> exclude = Arrays.asList(Material.DIRT, Material.GRASS);
  List<String[]> lookup = CoreProtect.performLookup("Notch", 60, 0, null, null, exclude);
  if (lookup!=null){
    for (String[] value : lookup){
      ParseResult result = CoreProtect.parseResult(value);
      int x = result.getX();
      int y = result.getY();
      int z = result.getZ();
      //...
    }
  }
}
--

3. Get the last 60 seconds of block data within 5 blocks of a location.
Code: Select all
CoreProtectAPI CoreProtect = getCoreProtect();
if (CoreProtect!=null){ //Ensure we have access to the API
  List<String[]> lookup = CoreProtect.performLookup(null, 60, 5, location, null, null);
  if (lookup!=null){
    for (String[] value : lookup){
      ParseResult result = CoreProtect.parseResult(value);
      int x = result.getX();
      int y = result.getY();
      int z = result.getZ();
      //...
    }
  }
}
--

4. Rollbacks / restores use the same code structure as the above examples. For example:
Code: Select all
CoreProtectAPI CoreProtect = getCoreProtect();
if (CoreProtect!=null){ //Ensure we have access to the API
  List<String[]> lookup = CoreProtect.performRollback("Notch", 60, 0, null, null, null);
  if (lookup!=null){
    for (String[] value : lookup){
      ParseResult result = CoreProtect.parseResult(value);
      int x = result.getX();
      int y = result.getY();
      int z = result.getZ();
      //...
    }
  }
}
--

5. Check if the user "Notch" has already placed a block at a location within the last 60 seconds.
Code: Select all
CoreProtectAPI CoreProtect = getCoreProtect();
if (CoreProtect!=null){ //Ensure we have access to the API
  boolean hasplaced = CoreProtect.HasPlaced("Notch", block, 60, 0);
}
--

6. Get the last 60 seconds of block data for a specific block.
Code: Select all
CoreProtectAPI CoreProtect = getCoreProtect();
if (CoreProtect!=null){ //Ensure we have access to the API
  List<String[]> lookup = CoreProtect.blockLookup(block, 60);
  if (lookup!=null){
    for (String[] value : lookup){
      ParseResult result = CoreProtect.parseResult(value);
      int x = result.getX();
      int y = result.getY();
      int z = result.getZ();
      //...
    }
  }
}
--

7. Log the placement of a block at a location by the user "Notch".
Code: Select all
CoreProtectAPI CoreProtect = getCoreProtect();
if (CoreProtect!=null){ //Ensure we have access to the API
  boolean success = CoreProtect.logPlacement("Notch", block.getLocation(), block.getType(), block.getData());
}
--

8. Perform a multi-threaded placement check to see if the user "Notch" has already placed a block at a location within the last 60 seconds. This ignores the most recent 1 second of logged data, to account for the fact that that new block data may have already been logged, depending on your code.
Code: Select all
final Block block = null; //Should be an actual block
class BasicThread implements Runnable {
  @Override
  public void run() {
    try {
      CoreProtectAPI CoreProtect = getCoreProtect();
      if (CoreProtect!=null){ //Ensure we have access to the API
        boolean hasplaced = CoreProtect.hasPlaced("Notch", block, 60, 1);
      }
    }
    catch (Exception e){
      e.printStackTrace(); 
    }
  }
}
Runnable runnable = new BasicThread();
Thread thread = new Thread(runnable);
thread.start();