com.austinv11.collectiveframework.minecraft.utils

Class StructureCreator

java.lang.Object

com.austinv11.collectiveframework.minecraft.utils.StructureCreator

public class StructureCreator
extends java.lang.Object

A utility to aid in creating world gen structures

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StructureCreator.DefaultValidityChecker
static interface	StructureCreator.ICheckBlockValidity Implement this if you want to check for custom conditions

Constructor Summary

Constructors

Constructor and Description
StructureCreator()

Method Summary

Methods

Modifier and Type	Method and Description
void	addBlock(Location location, net.minecraft.block.Block block) Adds a block to the structure with the default implementation of StructureCreator.ICheckBlockValidity
void	addBlock(Location location, net.minecraft.block.Block block, int meta) Adds a block to the structure with the default implementation of StructureCreator.ICheckBlockValidity
void	addBlock(Location location, net.minecraft.block.Block block, int meta, StructureCreator.ICheckBlockValidity validityChecker) Adds a block to the structure with a custom implementation of StructureCreator.ICheckBlockValidity
void	generateStructure() Generates the structure, it won't generate if isStructureValid() is false
void	generateStructure(boolean forceOptionalBlocks) Generates the structure with the set flags, it won't generate if isStructureValid() is false
void	generateStructure(boolean forceOptionalBlocks, boolean forceNonOptionalBlocks) Generates the structure with the set flags
boolean	isStructureValid() Checks if the structure is valid for spawning

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StructureCreator

public StructureCreator()

Method Detail

addBlock

public void addBlock(Location location,
            net.minecraft.block.Block block)

Adds a block to the structure with the default implementation of StructureCreator.ICheckBlockValidity

Parameters:

location - The location of the block

block - The block

addBlock

public void addBlock(Location location,
            net.minecraft.block.Block block,
            int meta)

Adds a block to the structure with the default implementation of StructureCreator.ICheckBlockValidity

Parameters:

location - The location of the block

block - The block

meta - The meta for the block

addBlock

public void addBlock(Location location,
            net.minecraft.block.Block block,
            int meta,
            StructureCreator.ICheckBlockValidity validityChecker)

Adds a block to the structure with a custom implementation of StructureCreator.ICheckBlockValidity

Parameters:

location - The location of the block

block - The block

meta - The meta for the block

validityChecker - The StructureCreator.ICheckBlockValidity to use

isStructureValid

public boolean isStructureValid()

Checks if the structure is valid for spawning

Returns:

True if the structure can be generated, false if otherwise

generateStructure

public void generateStructure()

Generates the structure, it won't generate if isStructureValid() is false

generateStructure

public void generateStructure(boolean forceOptionalBlocks)

Generates the structure with the set flags, it won't generate if isStructureValid() is false

Parameters:

forceOptionalBlocks - If true, blocks which don't need to be generated for the structure to spawn will spawn

generateStructure

public void generateStructure(boolean forceOptionalBlocks,
                     boolean forceNonOptionalBlocks)

Generates the structure with the set flags

Parameters:

forceOptionalBlocks - If true, blocks which don't need to be generated for the structure to spawn will spawn

forceNonOptionalBlocks - If true, the structure will generate regardless of the results of isStructureValid()