Previews API

For a mod that changes a build, for example to restyle or recolour it, and wants the player to see the result before anything is saved. From BuildPrint 0.1.19.

Show a copy in place of a build #

Map<String, Object> data = BuildprintPlacements.snapshot(id);
// Change data.get("palette") or data.get("blocks") here.

int[] o = BuildprintPlacements.origin(id);
int preview = BuildprintPreviews.create("mymod", data, o[0], o[1], o[2],
        BuildprintPlacements.rotation(id), BuildprintPlacements.flipped(id));
BuildprintPreviews.hide("mymod", id); // hide the original while the copy is up

The data is described under blueprint data. Only size, palette and blocks are needed. palette can also be a List<String>.

Change it, keep it or drop it #

BuildprintPreviews.update("mymod", preview, changed);   // same place, new blocks

BuildprintLibrary.save("mymod", preview, "Castle restyled", path -> {
    // path is inside the schematics folder, or null when writing failed
});

BuildprintPreviews.release("mymod"); // previews gone, hidden builds back

Good to know #

• A preview is a normal build while it is up. It is drawn, listed and checked against the world, and the editor tools and the printer work on it.
• It has no file. It is not saved with the world's placements, and it is gone when the player leaves the world. To keep it, save it with BuildprintLibrary.
• The player can remove a preview in BuildPrint like any other build. ids(owner) lists the ones still up.
• hide is not the player's own show and hide, and it is not saved. show, release and leaving the world bring the build back.
• Everything is per owner, your mod id. One mod cannot change or discard another mod's previews.

Reference #