Skip to content

Latest commit

 

History

History
53 lines (41 loc) · 1.72 KB

README.md

File metadata and controls

53 lines (41 loc) · 1.72 KB

Build Status Coverage

Microblock Plugin

Microblock Plugin is a NOVA Plugin that adds a microblock and multiblock system to NOVA. This API makes it easy to create microblocks and multiblocks.

Workspace Setup

Type the following command in the root directory of the repository.

gradlew idea

Dependency

  • NOVA-Core

Usage

Microblock

Add the Microblock component. Microblocks need a collider in order to be properly broken.

class ExampleBlock extends Block {
	public ExampleBlock() {
		add(new Microblock(this, function));
		add(new Collider());
	}
}

Where "function" is a callback you must provide to handle where your microblock should be placed.

Multiblock

Add the Multiblock component. The multiblock component requires a collider to be attached. Based on the size of the block collider, the multiblock will generate blocks to occupy space as to fill in required block space.

class ExampleBlock extends Block {
	public ExampleBlock() {
		add(new Multiblock(this));
		add(new Collider());
	}
}

Micro-Multi Blocks

A block can be both a microblock and and multiblock. This is probably the most used case. Simple attach both the Multiblock and Microblock components to the block, and based on the collider, microblock spaces and world block spaces will be occupied as needed. The amount of subdivions of a microblock container is fixed, so there is a limit to how detailed the microblock can be.

Credits

  • Calclavia