From 31f3bc5ceea317a0f2769e4f21cdbb5b01b7cb0e Mon Sep 17 00:00:00 2001 From: Jesse Boyd Date: Tue, 9 May 2017 10:26:51 +1000 Subject: [PATCH] Updated Registering Custom Masks (markdown) --- ...g-Custom-Masks,-Patterns-and-Transforms.md | 11 +++++ Registering-Custom-Masks.md | 41 ------------------- 2 files changed, 11 insertions(+), 41 deletions(-) create mode 100644 Registering-Custom-Masks,-Patterns-and-Transforms.md delete mode 100644 Registering-Custom-Masks.md diff --git a/Registering-Custom-Masks,-Patterns-and-Transforms.md b/Registering-Custom-Masks,-Patterns-and-Transforms.md new file mode 100644 index 0000000..9067049 --- /dev/null +++ b/Registering-Custom-Masks,-Patterns-and-Transforms.md @@ -0,0 +1,11 @@ +With FAWE you can register your own custom masks, patterns and transforms. + +```Java +FaweAPI.registerMasks(maskMethods); +FaweAPI.registerPatterns(patternMethods); +FaweAPI.registerTransforms(transformMethods); +``` +Where + - `maskMethods` is a class like [this](https://github.com/boy0001/FastAsyncWorldedit/blob/master/core/src/main/java/com/sk89q/worldedit/command/MaskCommands.java) + - `patternMethods` is a class like [this](https://github.com/boy0001/FastAsyncWorldedit/blob/master/core/src/main/java/com/sk89q/worldedit/command/PatternCommands.java) + - `transformMethods` is a class like [this](https://github.com/boy0001/FastAsyncWorldedit/blob/master/core/src/main/java/com/sk89q/worldedit/command/TransformCommands.java) diff --git a/Registering-Custom-Masks.md b/Registering-Custom-Masks.md deleted file mode 100644 index 27cd0d3..0000000 --- a/Registering-Custom-Masks.md +++ /dev/null @@ -1,41 +0,0 @@ -With FAWE you can register your own custom masks to be used in commands. - -```Java -FaweAPI.registerMask(String name, Class mask) -``` - -Here's an example of a CustomMask implementation -```Java -/** - * A mask that only applies to blocks with NBT - */ -public class NBTMask extends CustomMask { - private final Extent extent; - - /** - * Constructor for custom mask - * When used in commands, use #custom: - * - * @param masks Any previous masks set (usually from //mask [previous] [thismask] - * @param input The input to parse - * @param context The context (for extent, player etc) - */ - public NBTMask(List masks, String input, ParserContext context) { - super(masks, input, context); - this.extent = context.getExtent(); - } - - @Override - public String description() { - return null; - } - - @Override - public boolean test(Vector vector) { - return extent.getBlock(vector).hasNbtData(); - } -} - -// Will be used in commands e.g. `//gmask #nbt` -FaweAPI.registerMask("nbt", NBTMask.class); -``` \ No newline at end of file