Package de.eldoria.schematicbrush.brush.config.modifier

Class PlacementModifier

java.lang.Object

de.eldoria.schematicbrush.brush.config.util.Nameable

de.eldoria.schematicbrush.brush.config.modifier.BaseModifier

de.eldoria.schematicbrush.brush.config.modifier.PlacementModifier

public class PlacementModifier
extends BaseModifier

Represents a placement modifier which is applied to a SchematicBrush.

A placement modifier must be added via BrushSettingsRegistry.registerPlacementModifier(PlacementModifier, ModifierProvider).

A Placement modifier is a key represented by a string

Field Summary

Fields

Modifier and Type	Field	Description
static final PlacementModifier	FILTER	Filter modifier key
static final PlacementModifier	FLIP	Flip modifier key
static final PlacementModifier	INCLUDE_AIR	IncludeAir modifier key
static final PlacementModifier	OFFSET	Offset modifier key
static final PlacementModifier	PLACEMENT	Placement modifier key
static final PlacementModifier	REPLACE_ALL	ReplaceAll modifier key
static final PlacementModifier	ROTATION	Rotation modifier key

Method Summary

Modifier and Type	Method	Description
static PlacementModifier	of(String name, String localizedName, String description, boolean required)	Creates a new PlacementModifier.

Methods inherited from class de.eldoria.schematicbrush.brush.config.modifier.BaseModifier

description, getLocalizedName, required

Methods inherited from class de.eldoria.schematicbrush.brush.config.util.Nameable

equals, hashCode, name, of, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

PLACEMENT

public static final PlacementModifier PLACEMENT

Placement modifier key

INCLUDE_AIR

public static final PlacementModifier INCLUDE_AIR

IncludeAir modifier key

REPLACE_ALL

public static final PlacementModifier REPLACE_ALL

ReplaceAll modifier key

OFFSET

public static final PlacementModifier OFFSET

Offset modifier key

FILTER

public static final PlacementModifier FILTER

Filter modifier key

FLIP

public static final PlacementModifier FLIP

Flip modifier key

ROTATION

public static final PlacementModifier ROTATION

Rotation modifier key

Method Details

of

public static PlacementModifier of(String name,
 String localizedName,
 String description,
 boolean required)

Creates a new PlacementModifier.

Parameters:

name - name of the modifier

description - the description of the modifier

required - true if this modifier is required to be set. This will enforce a default value for the modifier.

Returns:

new PlacementModifier