MutliWorldEdit

A library that abstracts over WorldEdit's API to bring cross-version compatibility.

The MultiWorldEdit library as of now only supports WorldEdit's API v6 & v7. It was made for the SpeedBridge2 project.

Library Details

Wrappers

The library current has the following wrappers:

• VectorWrapper
• ClipboardWrapper
• RegionWrapper
• EditSessionWrapper
• PasteBuilderWrapper

Each wrapper were created for multi-version cross comatibility in mind - here's the reasons for whose are interested:

• VectorWrapper - The removal of Vector class on v6 version
• ClipboardWrapper - To wrap Clipboard's vector's method (getOrigin, getMinimumPoint, and getMaximumPoint)
• RegionWrapper - To wrap Clipboard's vector's method (getMinimumPoint, and getMaximumPoint)
• EditSessionWrapper - EditSession were not closeable on v6 version, but were required to be closed on v7 version for the changes to be reflected
• PasteBuilderWrapper - Clipboard#createPaste & PasteBuilder#to methods were not consistant between v6, and v7 versions

Examples

Retrieve a clipboard

  // the schematic file
  final File schematicFile = new File("test.schematic");
  // reading the schematic file with our library - for cross-compatibility purposes
  final Clipboard clipboard = MultiWorldEditAPI.getMultiWorldEdit()
                    .read(schematicFile);

Paste a schematic

        // WorldEdit's world
        final World world = ...;
        // The schematic clipboard we'll be pasting below
        final Clipboard clipboard = ...;

        // the location where the schematic should be pasted at
        final int x, y, z;

        // Using the edit session wrapper for cross-compatibility purposes
        // WARNING: you are required to close the session on v7 for the blocks operation to be completed
        try (final EditSessionWrapper editSessionWrapper = MultiWorldEditAPI.getMultiWorldEdit()
                .create(world, -1)) {
            // retrieving our actual session
            final EditSession editSession = editSessionWrapper.to();

            // creating our operation with the library - for cross-compatibility
            final Operation operation = MultiWorldEditAPI.getWorldEdit()
                    .create(clipboard, editSession, world)
                    .to(x, y, z)
                    .ignoreAirBlocks(true)
                    .build();

            // starting the operation process
            Operations.completeLegacy(operation);
        } catch (IOException e) {
            throw new IllegalStateException(e);
        }

Other

        // our clipboard experiment for the day
        final Clipboard clipboard = ...;
        // wraping our clipboard object with ClipboardWrapper
        final ClipboardWrapper clipboardWrapper = worldEdit.create(clipboard);

        // retrieving the regions's origin with ClipboardWrapper's wrapper
        final VectorWrapper origin = clipboardWrapper.getOrigin();

        // wraping our region object with RegionWrapper
        final RegionWrapper regionWrapper = MultiWorldEditAPI.create(clipboardWrapper.to().getRegion());
        // retrieving the clipboard's maximumpoint with RegionWrapper's wrapper
        final VectorWrapper maximumVector = regionWrapper.getMaximumPoint();

To get started

1. Load the library with Maven/Gradle.

      <repositories>
        <repository>
            <id>jitpack.io</id>
            <url>https://jitpack.io</url>
        </repository>
      </repositories>
    
      <dependencies>
        <dependency>
            <groupId>com.github.Tofpu.MultiWorldEdit</groupId>
            <artifactId>multiworldedit-api</artifactId>
            <version>321a69d3e8</version>
        </dependency>
      </dependencies>

2. Load the library on onLoad/onEnable via WorldEditAPI.load(Plugin) method (It's recommended to softdepend/depend WorldEdit on your plugin.yml).

Contributors

This library was mainly made for my personal projects, therefore do not expect this library to cover everything. If you wanted to contribute something, you're very welcome to do so! :)