org.pepsoft.worldpainter.tools.scripts

Class ScriptingContext

java.lang.Object

org.pepsoft.worldpainter.tools.scripts.ScriptingContext

public class ScriptingContext
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
boolean	commandLine

Constructor Summary

Constructors

Constructor and Description
ScriptingContext(boolean commandLine)

Method Summary

Modifier and Type	Method and Description
MappingOp	applyHeightMap(HeightMap heightMap) Map a height map to a layer or to the terrain type, optionally using a filter or other conditions.
MappingOp	applyLayer(Layer layer) Apply a layer to the world, optionally using a filter or other conditions.
MappingOp	applyTerrain(int terrainIndex) Apply a layer to the world, optionally using a filter or other conditions.
void	checkGoCalled(java.lang.String commandName)
CreateFilterOp	createFilter()
ImportHeightMapOp	createWorld() Import a height map as a new WorldPainter world.
ExportWorldOp	exportWorld(World2 world) Export a WorldPainter world as a new Minecraft map.
GetBiomeIdOp	getBiomeId() Get a biome ID by name.
GetHeightMapOp	getHeightMap()
GetLayerOp	getLayer() Get a WorldPainter layer from a file, an existing world, or from the standard WorldPainter layers.
GetPlatformOp	getMapFormat() Get a map format by id or name.
GetTerrainOp	getTerrain() Load a WorldPainter .terrain file from the file system.
java.lang.String	getVersion() Get the WorldPainter version string.
GetWorldOp	getWorld() Load a WorldPainter .world file from the file system.
InstallCustomTerrainOp	installCustomTerrain(MixedMaterial terrain) Install a custom terrain in a world, returning the terrain index to use for applying the terrain.
MergeWorldOp	mergeWorld()
SaveWorldOp	saveWorld(World2 world) Save a world to disk.

Methods inherited from class java.lang.Object

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

Field Detail

commandLine

public final boolean commandLine

Constructor Detail

ScriptingContext

public ScriptingContext(boolean commandLine)

Method Detail

getVersion

public java.lang.String getVersion()

Get the WorldPainter version string.

Returns:

The WorldPainter version string.

getWorld

public GetWorldOp getWorld()

Load a WorldPainter .world file from the file system.

Returns:

Throws:

java.io.IOException

java.lang.ClassNotFoundException

getLayer

public GetLayerOp getLayer()

Get a WorldPainter layer from a file, an existing world, or from the standard WorldPainter layers.

Returns:

getTerrain

public GetTerrainOp getTerrain()

Load a WorldPainter .terrain file from the file system.

Returns:

Throws:

java.io.IOException

java.lang.ClassNotFoundException

createWorld

public ImportHeightMapOp createWorld()

Import a height map as a new WorldPainter world.

Returns:

exportWorld

public ExportWorldOp exportWorld(World2 world)
                          throws ScriptException

Export a WorldPainter world as a new Minecraft map. If there is already a map with the same name in the specified directory, it is moved to the backups directory.

Parameters:

world - The world to export.

Throws:

java.io.IOException

ScriptException

mergeWorld

public MergeWorldOp mergeWorld()

saveWorld

public SaveWorldOp saveWorld(World2 world)
                      throws ScriptException

Save a world to disk.

Parameters:

world - The world to save.

Returns:

Throws:

ScriptException

getHeightMap

public GetHeightMapOp getHeightMap()

applyHeightMap

public MappingOp applyHeightMap(HeightMap heightMap)
                         throws ScriptException

Map a height map to a layer or to the terrain type, optionally using a filter or other conditions.

Returns:

Throws:

ScriptException

applyLayer

public MappingOp applyLayer(Layer layer)
                     throws ScriptException

Apply a layer to the world, optionally using a filter or other conditions.

Returns:

Throws:

ScriptException

applyTerrain

public MappingOp applyTerrain(int terrainIndex)
                       throws ScriptException

Apply a layer to the world, optionally using a filter or other conditions.

Returns:

Throws:

ScriptException

installCustomTerrain

public InstallCustomTerrainOp installCustomTerrain(MixedMaterial terrain)
                                            throws ScriptException

Install a custom terrain in a world, returning the terrain index to use for applying the terrain.

Parameters:

terrain - The terrain to install.

Returns:

Throws:

ScriptException

createFilter

public CreateFilterOp createFilter()

getMapFormat

public GetPlatformOp getMapFormat()

Get a map format by id or name.

getBiomeId

public GetBiomeIdOp getBiomeId()

Get a biome ID by name.

checkGoCalled

public void checkGoCalled(java.lang.String commandName)