net.risingworld.api

Interface World

public interface World

Represents the current server world. In provides some information about the world state, but is also used for any kind of modification you want to do.

Method Summary

Modifier and Type	Method and Description
boolean	areCavesEnabled() Gets whether caves are enabled or not.
boolean	areDungeonsEnabled() Gets whether dungeons are enabled or not.
boolean	areVegetationsEnabled() Gets whether vegetations are enabled or not.
void	changeObjectStatus(int objectID, float globalPositionX, float globalPositionY, float globalPositionZ, int newStatus) Changes the status of an object.
Storage	createNewStorage(int slots) Creates a new storage in the database.
void	executeBlockEditBatch(WorldEditBatch batch) Executes a block edit batch.
void	executeTerrainEditBatch(WorldEditBatch batch) Executes a terrain edit batch.
WorldItem	findNearestItem(short itemID, Vector3f position)
WorldItem	findNearestItem(Vector3f position) Gets the world item which has the shortest distance to a position.
Npc	findNearestNpc(short typeID, Vector3f position) Gets the npc which has the shortest distance to a world position.
Npc	findNearestNpc(Vector3f position) Gets the npc which has the shortest distance to a world position.
void	fixChunkBorders(int x, int y, int z) Updates chunk borders, i.e. removes "tears" between this chunk and all adjacent chunks.
java.util.Collection<Chest>	getAllChests(java.util.Collection<Chest> storeTo) Deprecated. Use getAllStorages(java.util.Collection) instead!
java.util.Collection<WorldItem>	getAllItems(java.util.Collection<WorldItem> storeTo) Gets all global world items (i.e. items that have either been spawned by calling spawnItem(short, int, int, net.risingworld.api.utils.Vector3f, net.risingworld.api.utils.Quaternion, boolean), or items that have been dropped by players).
java.util.Collection<WorldItem>	getAllItemsInArea(Area area, java.util.Collection<WorldItem> storeTo)
java.util.Collection<Npc>	getAllNpcs(java.util.Collection<Npc> storeTo) Gets all npcs which are spawned in this world.
java.util.Collection<Npc>	getAllNpcsInArea(Area area, java.util.Collection<Npc> storeTo)
java.util.Collection<Storage>	getAllStorages(java.util.Collection<Storage> storeTo) Gets all storages in this world.
int	getBlockID(int cx, int cy, int cz, int bx, int by, int bz) Gets the block id at the given position.
int	getBlockID(Vector3i chunkPosition, Vector3i blockPosition) Gets the block id at the given position.
Chest	getChest(int globalID) Deprecated. Use getStorage(int) instead!
Chunk	getChunk(int x, int y, int z) Gets a chunk, either from the cache, or - if this chunk isn't loaded yet - from the database.
ChunkLOD	getChunkLOD(int x, int z) Gets an LOD chunk, either from the cache, or - if this chunk isn't loaded yet - from the database.
long	getCreationDate() Gets the creation date of the world as a timestamp (millis).
java.util.List<java.lang.String>	getDisabledAnimals() Gets a list of all disabled npc.
WorldItem	getItem(int globalID)
java.lang.String	getName() Gets the world name.
int	getNextNpcGroupID() Gets the next "free" (unused) group ID for npcs.
Npc	getNpc(int globalID)
int	getNumChests() Deprecated. Use getNumStorages() instead!
int	getNumItems() Gets the current amount of global world items (i.e. items that have either been spawned by calling spawnItem(short, int, int, net.risingworld.api.utils.Vector3f, net.risingworld.api.utils.Quaternion, boolean), or items that have been dropped by players).
int	getNumNpcs() Gets the current amount of npcs in the world.
int	getNumStorages() Gets the total amount of storages in the world.
int	getOreAmount() Gets the ore amount (0-4).
java.lang.String	getSeed() Gets the world seed, as a string.
Sign	getSign(int globalID) Gets a particular sign.
Storage	getStorage(int globalID) Gets a particular storage (i.e. the content of the storage).
int	getTemperature(float x, float y, float z) Gets the current environment temperature at a given location.
int	getTerrainID(int cx, int cy, int cz, int bx, int by, int bz) Gets the terrain id at the given position.
int	getTerrainID(Vector3i chunkPosition, Vector3i blockPosition) Gets the terrain id at the given position.
java.io.File	getWorldFolder()
java.io.File	getWorldsFolder()
java.lang.String	getWorldtype() Gets the world type (e.g.
boolean	isChunkModified(int x, int y, int z) Checks if a chunk has been modified, i.e. if it is "dirty".
boolean	isInitialized() Gets whether the world is already initialized or not.
void	placeBlock(int blockID, int cx, int cy, int cz, int bx, int by, int bz) Places a block at the given position.
void	placeBlock(int blockID, Vector3i chunkPosition, Vector3i blockPosition) Places a block at the given position.
void	placeObject(int objectID, int variation, float globalPositionX, float globalPositionY, float globalPositionZ, float rotationX, float rotationY, float rotationZ) Creates a new object (e.g. furniture) at the given position.
void	placeObject(int objectID, int variation, int cx, int cy, int cz, float bx, float by, float bz, float rotationX, float rotationY, float rotationZ) Creates a new object (e.g. furniture) at the given position.
void	placeObject(int objectID, int variation, Vector3f globalPosition, float rotationX, float rotationY, float rotationZ) Creates a new object (e.g. furniture) at the given position.
void	placeObject(int objectID, int variation, Vector3i chunkPosition, Vector3i blockPosition, float rotationX, float rotationY, float rotationZ) Creates a new object (e.g. furniture) at the given position.
void	placeTerrain(int terrainID, int cx, int cy, int cz, int bx, int by, int bz) Places "terrain" (e.g. stone, dirt, gravel, sand etc) at the given position.
void	placeTerrain(int terrainID, Vector3i chunkPosition, Vector3i blockPosition) Places "terrain" (e.g. stone, dirt, gravel, sand etc) at the given position.
void	placeVegetation(int plantID, float globalPositionX, float globalPositionY, float globalPositionZ, float rotationX, float rotationY, float rotationZ) Creates a new plant at the given position.
void	placeVegetation(int plantID, int cx, int cy, int cz, float bx, float by, float bz, float rotationX, float rotationY, float rotationZ) Creates a new plant at the given position.
void	placeVegetation(int plantID, Vector3f globalPosition, float rotationX, float rotationY, float rotationZ) Creates a new plant at the given position.
void	placeVegetation(int plantID, Vector3i chunkPosition, Vector3i blockPosition, float rotationX, float rotationY, float rotationZ) Creates a new plant at the given position.
void	removeAllConstructionsInArea(Area area) Removes all constructions (e.g. planks, beams, windows etc.) inside the given area.
void	removeAllConstructionsInArea(int startChunkX, int startChunkY, int startChunkZ, int startBlockX, int startBlockY, int startBlockZ, int endChunkX, int endChunkY, int endChunkZ, int endBlockX, int endBlockY, int endBlockZ) Removes all constructions (e.g. planks, beams, windows etc.) inside the given area.
void	removeAllConstructionsInArea(Vector3i startChunkPosition, Vector3i startBlockPosition, Vector3i endChunkPosition, Vector3i endBlockPosition) Removes all constructions (e.g. planks, beams, windows etc.) inside the given area.
void	removeAllObjectsInArea(Area area) Removes all objects (e.g. furniture, lamps etc.) inside the given area.
void	removeAllObjectsInArea(int startChunkX, int startChunkY, int startChunkZ, int startBlockX, int startBlockY, int startBlockZ, int endChunkX, int endChunkY, int endChunkZ, int endBlockX, int endBlockY, int endBlockZ) Removes all objects (e.g. furniture, lamps etc.) inside the given area.
void	removeAllObjectsInArea(Vector3i startChunkPosition, Vector3i startBlockPosition, Vector3i endChunkPosition, Vector3i endBlockPosition) Removes all objects (e.g. furniture, lamps etc.) inside the given area.
void	removeAllVegetationsInArea(Area area) Removes all vegetations (plants, trees etc.) inside the given area.
void	removeAllVegetationsInArea(int startChunkX, int startChunkY, int startChunkZ, int startBlockX, int startBlockY, int startBlockZ, int endChunkX, int endChunkY, int endChunkZ, int endBlockX, int endBlockY, int endBlockZ) Removes all vegetations (plants, trees etc.) inside the given area.
void	removeAllVegetationsInArea(Vector3i startChunkPosition, Vector3i startBlockPosition, Vector3i endChunkPosition, Vector3i endBlockPosition) Removes all vegetations (plants, trees etc.) inside the given area.
void	removeObject(int objectID, float globalPositionX, float globalPositionY, float globalPositionZ) Removes an object.
void	removeVegetation(int plantID, float globalPositionX, float globalPositionY, float globalPositionZ) Removes a plant.
void	saveChunk(Chunk chunk) Saves the chunk.
void	saveChunkLOD(ChunkLOD chunkLOD) Saves the LOD chunk.
void	setBlockDataInArea(int blockID, Area area) Sets the block id in the given area (i.e. every block inside this area will be set to the block id).
void	setBlockDataInArea(int blockID, int startChunkX, int startChunkY, int startChunkZ, int startBlockX, int startBlockY, int startBlockZ, int endChunkX, int endChunkY, int endChunkZ, int endBlockX, int endBlockY, int endBlockZ) Sets the block id in the given area which is described by the start and end position.
void	setBlockDataInArea(int blockID, Vector3i startChunkPosition, Vector3i startBlockPosition, Vector3i endChunkPosition, Vector3i endBlockPosition) Sets the block id in the given area which is described by the start and end position.
void	setBlockDataInRadius(int blockID, int radius, int cx, int cy, int cz, int bx, int by, int bz) Sets the block id in the given radius (spherical).
void	setBlockDataInRadius(int blockID, int radius, Vector3i chunkPosition, Vector3i blockPosition) Sets the block id in the given radius (spherical).
void	setTerrainDataInArea(int terrainID, Area area) Sets the terrain id in the given area (i.e. every block inside this area will be set to the terrain id).
void	setTerrainDataInArea(int terrainID, int startChunkX, int startChunkY, int startChunkZ, int startBlockX, int startBlockY, int startBlockZ, int endChunkX, int endChunkY, int endChunkZ, int endBlockX, int endBlockY, int endBlockZ) Sets the terrain id in the given area which is described by the start and end position.
void	setTerrainDataInArea(int terrainID, Vector3i startChunkPosition, Vector3i startBlockPosition, Vector3i endChunkPosition, Vector3i endBlockPosition) Sets the terrain id in the given area which is described by the start and end position.
void	setTerrainDataInRadius(int terrainID, int radius, int cx, int cy, int cz, int bx, int by, int bz) Sets the terrain id in the given radius (spherical).
void	setTerrainDataInRadius(int terrainID, int radius, Vector3i chunkPosition, Vector3i blockPosition) Sets the terrain id in the given radius (spherical).
WorldItem	spawnCustomItem(java.lang.String uuid, int variation, int stacksize, Vector3f position, Quaternion rotation, boolean physical) Spawns a custom item in the world.
WorldItem	spawnItem(short itemID, int variation, int stacksize, Vector3f position, Quaternion rotation, boolean physical) Spawns a global item in the world.
Npc	spawnNpc(short typeID, byte variation, Vector3f position, Quaternion rotation) Spawns a new npc in the world.
Npc	spawnNpc(short typeID, byte variation, Vector3f position, Quaternion rotation, boolean temporary) Spawns a new npc in the world.
Npc	spawnNpc(short typeID, Vector3f position, Quaternion rotation) Spawns a new npc in the world.
WorldItem	spawnObjectItem(short objectID, int variation, int stacksize, Vector3f position, Quaternion rotation, boolean physical) Spawns a global object item in the world, i.e. an item which represents an object.
void	spawnProjectile(byte typeID, Vector3f position, Vector3f direction, float velocity, boolean causeDamage) Spawns a projectile in the world.
void	triggerExplosion(Vector3f position, boolean causeDamage, boolean playSound) Creates an explosion in the world.
void	triggerFirework(Vector3f position, float scale, int color1, int color2, int color3, boolean playSound) Creates a firework effect in the world at the given position.

Method Detail

getName

java.lang.String getName()

Gets the world name.

Returns:

the world name.

getSeed

java.lang.String getSeed()

Gets the world seed, as a string.

Returns:

the world seed.

getCreationDate

long getCreationDate()

Gets the creation date of the world as a timestamp (millis).

Returns:

the creation date.

getWorldtype

java.lang.String getWorldtype()

Gets the world type (e.g. "Superflat").

Returns:

the world type.

areCavesEnabled

boolean areCavesEnabled()

Gets whether caves are enabled or not.

Returns:

true if caves are enabled, false if not.

areVegetationsEnabled

boolean areVegetationsEnabled()

Gets whether vegetations are enabled or not.

Returns:

true if vegetations are enabled, false if not.

areDungeonsEnabled

boolean areDungeonsEnabled()

Gets whether dungeons are enabled or not.

Returns:

true if dungeons are enabled, false if not.

getOreAmount

int getOreAmount()

Gets the ore amount (0-4).

Returns:

the ore amount.

getDisabledAnimals

java.util.List<java.lang.String> getDisabledAnimals()

Gets a list of all disabled npc.

Returns:

a list containing all disabled npc.

isInitialized

boolean isInitialized()

Gets whether the world is already initialized or not.
Note: If the world isn't fully initialized yet, the various world-functions may return invalid data.

Returns:

true if the the world is initialized (i.e. the server has fully loaded it), false if not.

getWorldFolder

java.io.File getWorldFolder()

getWorldsFolder

java.io.File getWorldsFolder()

getTemperature

int getTemperature(float x,
                   float y,
                   float z)

Gets the current environment temperature at a given location.

Parameters:

x - the world x position.

y - the world y position.

z - the world z position.

Returns:

the current temperature (taking biome, weather and daytime into account) at a given location.

spawnItem

WorldItem spawnItem(short itemID,
                    int variation,
                    int stacksize,
                    Vector3f position,
                    Quaternion rotation,
                    boolean physical)

Spawns a global item in the world.

Parameters:

itemID - the item id.

variation - the variation/texture of the item (only relevant for blocks etc). Typicall the the variation for most items is 0.

stacksize - the stack size (i.e. amount of items).

position - the global position of the item.

rotation - the rotation of the item.

physical - determines if the item has physical behaviour (i.e. it falls to the ground) or not (in this case it hovers in the air). Please note that it's necessary that a player is close to the item in order to provide accurate physical behaviour.

Returns:

a WorldItem representing the global item.

spawnObjectItem

WorldItem spawnObjectItem(short objectID,
                          int variation,
                          int stacksize,
                          Vector3f position,
                          Quaternion rotation,
                          boolean physical)

Spawns a global object item in the world, i.e. an item which represents an object. This method always spawns an "objectkit" with the appropriate item attribute.

Parameters:

objectID - the object id.

variation - the object variation (texture). By default 0

stacksize - the stack size (i.e. amount of items).

position - the global position of the item.

rotation - the rotation of the item.

physical - determines if the item has physical behaviour (i.e. it falls to the ground) or not (in this case it hovers in the air). Please note that it's necessary that a player is close to the item in order to provide accurate physical behaviour.

Returns:

a WorldItem representing the global item.

spawnCustomItem

WorldItem spawnCustomItem(java.lang.String uuid,
                          int variation,
                          int stacksize,
                          Vector3f position,
                          Quaternion rotation,
                          boolean physical)

Spawns a custom item in the world.

Parameters:

uuid - the UUID of the custom item.

variation - the optional item variation. By default 0

stacksize - the stack size (i.e. amount of items).

position - the global position of the item.

rotation - the rotation of the item.

physical - determines if the item has physical behaviour (i.e. it falls to the ground) or not (in this case it hovers in the air). Please note that it's necessary that a player is close to the item in order to provide accurate physical behaviour.

Returns:

a WorldItem representing the global item.

getItem

WorldItem getItem(int globalID)

getAllItems

java.util.Collection<WorldItem> getAllItems(java.util.Collection<WorldItem> storeTo)

Gets all global world items (i.e. items that have either been spawned by calling spawnItem(short, int, int, net.risingworld.api.utils.Vector3f, net.risingworld.api.utils.Quaternion, boolean), or items that have been dropped by players). The items are stored in the provided Collection.

Parameters:

storeTo - the Collection you want to store the items in (for example, you can use an ArrayList for that). If null, a new ArrayList will be created.

Returns:

the collection containing all items. Never null.

Example: Get all items and delete every item that is close to the player

1	//The player (delete all items in his proximity)
2	Player player = getServer().findPlayer("Playername");
3
4	//Continue only if we have an actual player object (i.e. player != null)
5	if(player != null){
6	//If we don't have a list yet to store the items in, it's better to
7	//provide "null" as argument and use the returned list
8	ArrayList<WorldItem> items = getAllItems(null);
9
10	//If list is not empty, continue
11	if(!items.isEmpty()){
12	//Iterate over list
13	for(WorldItem item : items){
14	//If distance between player and item is less than 10 units,
15	//delete the item by calling "item.destroy()"
16	if(item.getPosition().distance(player.getPosition()) <= 10){
17	item.destroy();
18	}
19	}
20	}
21	}

getAllItemsInArea

java.util.Collection<WorldItem> getAllItemsInArea(Area area,
                                                  java.util.Collection<WorldItem> storeTo)

findNearestItem

WorldItem findNearestItem(Vector3f position)

Gets the world item which has the shortest distance to a position.

Parameters:

position - the world position.

Returns:

the closest item, or null if no world item exists.

findNearestItem

WorldItem findNearestItem(short itemID,
                          Vector3f position)

getNumItems

int getNumItems()

Gets the current amount of global world items (i.e. items that have either been spawned by calling spawnItem(short, int, int, net.risingworld.api.utils.Vector3f, net.risingworld.api.utils.Quaternion, boolean), or items that have been dropped by players).

Returns:

the current amount of global world items.

spawnNpc

Npc spawnNpc(short typeID,
             Vector3f position,
             Quaternion rotation)

Spawns a new npc in the world.

Parameters:

typeID - the npc type id.

position - the global npc position.

rotation - the rotation of the npc.

Returns:

an Npc object representing the npc.

Example #1: Spawn npc by using Definitions

1	//Get npc definition of a bear
2	Definitions.NpcDefinition npcDef = Definitions.getNpcDefinition("bear");
3
4	//spawn the npc at a certain position using default rotation
5	//(identity quaternion, which looks towards north)
6	world.spawnNpc(npcDef.getID(), new Vector3f(...), Quaternion.IDENTITY);

Example #2: Spawn npc in front of a player

1	//We want to spawn the npc in front of the player.
2	//So first we create a new unit vector which shows towards north (+Z)
3	Vector3f position = new Vector3f(0f, 0f, 1f);
4
5	//get the player position and rotation
6	Vector3f playerPos = player.getPosition();
7	Quaternion playerRot = player.getRotation();
8
9	//multiply rotation by a vector. As a result, the rotation will
10	//be applied to the vector
11	playerRot.multLocal(position);
12
13	//we don't want the npc to spawn higher or lower than the player, so we set
14	//y to 0. Remember to normalize the vector after doing that!
15	position.setY(0f).normalizeLocal();
16
17	//we want the npc to look into the player direction, so we create a new
18	//quaternion, use the "lookAt()" function and and provide the negated
19	//vector as direction (do not use the original vector, instead create
20	//a new one and negate it!)
21	Quaternion rotation = new Quaternion();
22	rotation.lookAt(new Vector3f(position).negateLocal());
23
24	//we want the npc to spawn 5 units in front of the player, so we multiply
25	//the vector by 5
26	position.multLocal(5f);
27
28	//finally add the current player position to the vector
29	position.addLocal(playerPos);
30
31	//spawn the npc, a cow in this case (id 2)
32	getWorld().spawnNpc((short) 2, position, rotation);

spawnNpc

Npc spawnNpc(short typeID,
             byte variation,
             Vector3f position,
             Quaternion rotation)

Spawns a new npc in the world.

Parameters:

typeID - the npc type id.

variation - the variation of the npc. Only certain npc have different variations.

position - the global npc position.

rotation - the rotation of the npc.

Returns:

an Npc object representing the npc.

spawnNpc

Npc spawnNpc(short typeID,
             byte variation,
             Vector3f position,
             Quaternion rotation,
             boolean temporary)

Spawns a new npc in the world.

Parameters:

typeID - the npc type id.

variation - the variation of the npc. Only certain npc have different variations.

position - the global npc position.

rotation - the rotation of the npc.

temporary - if set to true, the npc will not be stored in the world database. This means the npc will despawn if the server restarts or if the world is unloaded.

Returns:

an Npc object representing the npc.

getNpc

Npc getNpc(int globalID)

getAllNpcs

java.util.Collection<Npc> getAllNpcs(java.util.Collection<Npc> storeTo)

Gets all npcs which are spawned in this world. The results are stored in the provided Collection.

Parameters:

storeTo - the Collection you want to store the npcs in (for example, you can use an ArrayList for that). If null, a new ArrayList will be created.

Returns:

the collection containing all npcs. Never null.

Example: Kill all npcs if their health are lower than 10 hp

1	Collection<Npc> npcs = getWorld().getAllNpcs(null);
2	for(Npc npc : npcs){
3	if(npc.getHealth() < 10){
4	npc.kill();
5	}
6	}

getAllNpcsInArea

java.util.Collection<Npc> getAllNpcsInArea(Area area,
                                           java.util.Collection<Npc> storeTo)

getNumNpcs

int getNumNpcs()

Gets the current amount of npcs in the world.

Returns:

the current amount of npcs.

getNextNpcGroupID

int getNextNpcGroupID()

Gets the next "free" (unused) group ID for npcs. Call this method to get an ID which hasn't been used.

Returns:

the next unuused group ID.

findNearestNpc

Npc findNearestNpc(Vector3f position)

Gets the npc which has the shortest distance to a world position.

Parameters:

position - the world position.

Returns:

the closest npc, or null if no npc exists.

findNearestNpc

Npc findNearestNpc(short typeID,
                   Vector3f position)

Gets the npc which has the shortest distance to a world position.

Parameters:

typeID - the npc type id.

position - the world position.

Returns:

the closest npc, or null if no npc exists.

createNewStorage

Storage createNewStorage(int slots)

Creates a new storage in the database. This storage is not bound to a specific item or an object in the world. This could be used for personal player storages, backpacks, custom chests etc.
The storage has a unique id and is created permanently (until it gets deleted manually).

Parameters:

slots - the amount of slots the new storage should have.

Returns:

the newly created storage.

getStorage

Storage getStorage(int globalID)

Gets a particular storage (i.e. the content of the storage).

Parameters:

globalID - the global id of the storage.

Returns:

the storage with the specified id, or null if no such storage exists.

getAllStorages

java.util.Collection<Storage> getAllStorages(java.util.Collection<Storage> storeTo)

Gets all storages in this world. The storages are stored in the provided Collection.

Parameters:

storeTo - the Collection you want to store the storages in (for example, you can use an ArrayList for that). If null, a new ArrayList will be created.

Returns:

the collection containing all storages. Never null.

getNumStorages

int getNumStorages()

Gets the total amount of storages in the world.

Returns:

the total amount of storages.

getChest

Chest getChest(int globalID)

Deprecated. Use getStorage(int) instead!

Parameters:

globalID - N/A

Returns:

N/A

getAllChests

java.util.Collection<Chest> getAllChests(java.util.Collection<Chest> storeTo)

Deprecated. Use getAllStorages(java.util.Collection) instead!

Parameters:

storeTo - N/A

Returns:

N/A

getNumChests

int getNumChests()

Deprecated. Use getNumStorages() instead!

Returns:

N/A

getSign

Sign getSign(int globalID)

Gets a particular sign.

Parameters:

globalID - the global id of the sign.

Returns:

the sign with the specified id, or null if no such sign/text exists.

placeBlock

void placeBlock(int blockID,
                Vector3i chunkPosition,
                Vector3i blockPosition)

Places a block at the given position.

Parameters:

blockID - the block id.

chunkPosition - the chunk position.

blockPosition - the block position.

placeBlock

void placeBlock(int blockID,
                int cx,
                int cy,
                int cz,
                int bx,
                int by,
                int bz)

Places a block at the given position.

Parameters:

blockID - the block id.

cx - the x chunk position.

cy - the y chunk position.

cz - the z chunk position.

bx - the x block position.

by - the y block position.

bz - the z block position.

getBlockID

int getBlockID(Vector3i chunkPosition,
               Vector3i blockPosition)

Gets the block id at the given position.

Parameters:

chunkPosition - the chunk position.

blockPosition - the block position.

Returns:

the block id.

getBlockID

int getBlockID(int cx,
               int cy,
               int cz,
               int bx,
               int by,
               int bz)

Gets the block id at the given position.

Parameters:

cx - the x chunk position.

cy - the y chunk position.

cz - the z chunk position.

bx - the x block position.

by - the y block position.

bz - the z block position.

Returns:

the block id.

executeBlockEditBatch

void executeBlockEditBatch(WorldEditBatch batch)

Executes a block edit batch. This is useful if you want to do multiple world modifications, since all changes will be done at once.

Parameters:

batch - the batch you want to execute.

See Also:

WorldEditBatch

Example: Place multiple metal blocks (id 182)

1	//Create new WorldEditBatch with initial capacity of 4 (since we want to do 4 modifications)
2	WorldEditBatch batch = new WorldEditBatch(4);
3
4	//Get current player chunk
5	Vector3i chunkPos = player.getChunkPosition();
6
7	//Place a block (id 65) in player chunk at 0,0,0
8	batch.addToBatch(65, chunkPos.x, chunkPos.y, chunkPos.z, 0, 0, 0);
9	//Place a block (id 99) in player chunk at 15,0,0
10	batch.addToBatch(99, chunkPos.x, chunkPos.y, chunkPos.z, 15, 0, 0);
11	//Place a block (id 21) in player chunk at 0,0,15
12	batch.addToBatch(21, chunkPos.x, chunkPos.y, chunkPos.z, 0, 0, 15);
13	//Place a block (id 182) in player chunk at 15,0,15
14	batch.addToBatch(182, chunkPos.x, chunkPos.y, chunkPos.z, 15, 0, 15);
15
16	//Execute batch
17	getWorld().executeBlockEditBatch(batch);

setBlockDataInArea

void setBlockDataInArea(int blockID,
                        Area area)

Sets the block id in the given area (i.e. every block inside this area will be set to the block id).

Parameters:

blockID - the block id (0 == air).

area - the Area which covers the area you want to edit.

setBlockDataInArea

void setBlockDataInArea(int blockID,
                        Vector3i startChunkPosition,
                        Vector3i startBlockPosition,
                        Vector3i endChunkPosition,
                        Vector3i endBlockPosition)

Sets the block id in the given area which is described by the start and end position.

Parameters:

blockID - the block id (0 == air).

startChunkPosition - the start chunk position.

startBlockPosition - the start block position.

endChunkPosition - the end chunk position.

endBlockPosition - the end block position.

setBlockDataInArea

void setBlockDataInArea(int blockID,
                        int startChunkX,
                        int startChunkY,
                        int startChunkZ,
                        int startBlockX,
                        int startBlockY,
                        int startBlockZ,
                        int endChunkX,
                        int endChunkY,
                        int endChunkZ,
                        int endBlockX,
                        int endBlockY,
                        int endBlockZ)

Sets the block id in the given area which is described by the start and end position.

Parameters:

blockID - the block id (0 == air).

startChunkX - the start x chunk position.

startChunkY - the start y chunk position.

startChunkZ - the start z chunk position.

startBlockX - the start x block position.

startBlockY - the start y block position.

startBlockZ - the start z block position.

endChunkX - the end x chunk position.

endChunkY - the end y chunk position.

endChunkZ - the end z chunk position.

endBlockX - the end x block position.

endBlockY - the end y block position.

endBlockZ - the end z block position.

setBlockDataInRadius

void setBlockDataInRadius(int blockID,
                          int radius,
                          Vector3i chunkPosition,
                          Vector3i blockPosition)

Sets the block id in the given radius (spherical).

Parameters:

blockID - the block id (0 == air).

radius - the radius.

chunkPosition - the chunk position (center).

blockPosition - the block position (center).

setBlockDataInRadius

void setBlockDataInRadius(int blockID,
                          int radius,
                          int cx,
                          int cy,
                          int cz,
                          int bx,
                          int by,
                          int bz)

Sets the block id in the given radius (spherical).

Parameters:

blockID - the block id (0 == air).

radius - the radius.

cx - the x chunk position (center).

cy - the y chunk position (center).

cz - the z chunk position (center).

bx - the x block position (center).

by - the y block position (center).

bz - the z block position (center).

placeTerrain

void placeTerrain(int terrainID,
                  Vector3i chunkPosition,
                  Vector3i blockPosition)

Places "terrain" (e.g. stone, dirt, gravel, sand etc) at the given position.

Parameters:

terrainID - the terrain block id.

chunkPosition - the chunk position.

blockPosition - the block position.

placeTerrain

void placeTerrain(int terrainID,
                  int cx,
                  int cy,
                  int cz,
                  int bx,
                  int by,
                  int bz)

Places "terrain" (e.g. stone, dirt, gravel, sand etc) at the given position.

Parameters:

terrainID - the terrain block id.

cx - the x chunk position.

cy - the y chunk position.

cz - the z chunk position.

bx - the x block position.

by - the y block position.

bz - the z block position.

getTerrainID

int getTerrainID(Vector3i chunkPosition,
                 Vector3i blockPosition)

Gets the terrain id at the given position.

Parameters:

chunkPosition - the chunk position.

blockPosition - the block position.

Returns:

the terrain id.

getTerrainID

int getTerrainID(int cx,
                 int cy,
                 int cz,
                 int bx,
                 int by,
                 int bz)

Gets the terrain id at the given position.

Parameters:

cx - the x chunk position.

cy - the y chunk position.

cz - the z chunk position.

bx - the x block position.

by - the y block position.

bz - the z block position.

Returns:

the terrain id.

executeTerrainEditBatch

void executeTerrainEditBatch(WorldEditBatch batch)

Executes a terrain edit batch. This is useful if you want to do multiple world modifications, since all changes will be done at once.

Parameters:

batch - the batch you want to execute.

See Also:

WorldEditBatch

setTerrainDataInArea

void setTerrainDataInArea(int terrainID,
                          Area area)

Sets the terrain id in the given area (i.e. every block inside this area will be set to the terrain id).

Parameters:

terrainID - the terrain id (0 == air).

area - the Area which covers the area you want to edit.

setTerrainDataInArea

void setTerrainDataInArea(int terrainID,
                          Vector3i startChunkPosition,
                          Vector3i startBlockPosition,
                          Vector3i endChunkPosition,
                          Vector3i endBlockPosition)

Sets the terrain id in the given area which is described by the start and end position.

Parameters:

terrainID - the terrain id (0 == air).

startChunkPosition - the start chunk position.

startBlockPosition - the start block position.

endChunkPosition - the end chunk position.

endBlockPosition - the end block position.

setTerrainDataInArea

void setTerrainDataInArea(int terrainID,
                          int startChunkX,
                          int startChunkY,
                          int startChunkZ,
                          int startBlockX,
                          int startBlockY,
                          int startBlockZ,
                          int endChunkX,
                          int endChunkY,
                          int endChunkZ,
                          int endBlockX,
                          int endBlockY,
                          int endBlockZ)

Sets the terrain id in the given area which is described by the start and end position.

Parameters:

terrainID - the terrain id (0 == air).

startChunkX - the start x chunk position.

startChunkY - the start y chunk position.

startChunkZ - the start z chunk position.

startBlockX - the start x block position.

startBlockY - the start y block position.

startBlockZ - the start z block position.

endChunkX - the end x chunk position.

endChunkY - the end y chunk position.

endChunkZ - the end z chunk position.

endBlockX - the end x block position.

endBlockY - the end y block position.

endBlockZ - the end z block position.

setTerrainDataInRadius

void setTerrainDataInRadius(int terrainID,
                            int radius,
                            Vector3i chunkPosition,
                            Vector3i blockPosition)

Sets the terrain id in the given radius (spherical).

Parameters:

terrainID - the terrain id (0 == air).

radius - the radius.

chunkPosition - the chunk position (center).

blockPosition - the block position (center).

setTerrainDataInRadius

void setTerrainDataInRadius(int terrainID,
                            int radius,
                            int cx,
                            int cy,
                            int cz,
                            int bx,
                            int by,
                            int bz)

Sets the terrain id in the given radius (spherical).

Parameters:

terrainID - the terrain id (0 == air).

radius - the radius.

cx - the x chunk position (center).

cy - the y chunk position (center).

cz - the z chunk position (center).

bx - the x block position (center).

by - the y block position (center).

bz - the z block position (center).

placeVegetation

void placeVegetation(int plantID,
                     Vector3f globalPosition,
                     float rotationX,
                     float rotationY,
                     float rotationZ)

Creates a new plant at the given position.
Note: All rotation values are provided in radians. To convert degrees to radians, see Utils.MathUtils#degreeToRadian(float)

Parameters:

plantID - the plant type id.

globalPosition - the target world position.

rotationX - rotation in radians around x axis (typically 0).

rotationY - rotation in radians around y axis (heading)

rotationZ - rotation in radians around z axis (typically 0).

placeVegetation

void placeVegetation(int plantID,
                     float globalPositionX,
                     float globalPositionY,
                     float globalPositionZ,
                     float rotationX,
                     float rotationY,
                     float rotationZ)

Creates a new plant at the given position.
Note: All rotation values are provided in radians. To convert degrees to radians, see Utils.MathUtils#degreeToRadian(float)

Parameters:

plantID - the plant type id.

globalPositionX - the target world x position.

globalPositionY - the target world y position.

globalPositionZ - the target world z position.

rotationX - rotation in radians around x axis (typically 0).

rotationY - rotation in radians around y axis (heading)

rotationZ - rotation in radians around z axis (typically 0).

placeVegetation

void placeVegetation(int plantID,
                     Vector3i chunkPosition,
                     Vector3i blockPosition,
                     float rotationX,
                     float rotationY,
                     float rotationZ)

Creates a new plant at the given position.
Note: All rotation values are provided in radians. To convert degrees to radians, see Utils.MathUtils#degreeToRadian(float)

Parameters:

plantID - the plant type id.

chunkPosition - the target chunk position.

blockPosition - the target block position.

rotationX - rotation in radians around x axis (typically 0).

rotationY - rotation in radians around y axis (heading)

rotationZ - rotation in radians around z axis (typically 0).

placeVegetation

void placeVegetation(int plantID,
                     int cx,
                     int cy,
                     int cz,
                     float bx,
                     float by,
                     float bz,
                     float rotationX,
                     float rotationY,
                     float rotationZ)

Creates a new plant at the given position.
Note: All rotation values are provided in radians. To convert degrees to radians, see Utils.MathUtils#degreeToRadian(float)

Parameters:

plantID - the plant type id.

cx - the target chunk x position.

cy - the target chunk y position.

cz - the target chunk z position.

bx - the target block x position.

by - the target block y position.

bz - the target block z position.

rotationX - rotation in radians around x axis (typically 0).

rotationY - rotation in radians around y axis (heading)

rotationZ - rotation in radians around z axis (typically 0).

removeVegetation

void removeVegetation(int plantID,
                      float globalPositionX,
                      float globalPositionY,
                      float globalPositionZ)

Removes a plant.

Parameters:

plantID - the plant type id.

globalPositionX - the world x position of the plant.

globalPositionY - the world y position of the plant.

globalPositionZ - the world z position of the plant.

placeObject

void placeObject(int objectID,
                 int variation,
                 Vector3f globalPosition,
                 float rotationX,
                 float rotationY,
                 float rotationZ)

Creates a new object (e.g. furniture) at the given position.
Note: All rotation values are provided in radians. To convert degrees to radians, see Utils.MathUtils#degreeToRadian(float)

Parameters:

objectID - the object type id.

variation - the variation (e.g. texture), by default 0

globalPosition - the target world position.

rotationX - rotation in radians around x axis (typically 0).

rotationY - rotation in radians around y axis (heading)

rotationZ - rotation in radians around z axis (typically 0).

placeObject

void placeObject(int objectID,
                 int variation,
                 float globalPositionX,
                 float globalPositionY,
                 float globalPositionZ,
                 float rotationX,
                 float rotationY,
                 float rotationZ)

Creates a new object (e.g. furniture) at the given position.
Note: All rotation values are provided in radians. To convert degrees to radians, see Utils.MathUtils#degreeToRadian(float)

Parameters:

objectID - the object type id.

variation - the variation (e.g. texture), by default 0

globalPositionX - the target world x position.

globalPositionY - the target world y position.

globalPositionZ - the target world z position.

rotationX - rotation in radians around x axis (typically 0).

rotationY - rotation in radians around y axis (heading)

rotationZ - rotation in radians around z axis (typically 0).

placeObject

void placeObject(int objectID,
                 int variation,
                 Vector3i chunkPosition,
                 Vector3i blockPosition,
                 float rotationX,
                 float rotationY,
                 float rotationZ)

Creates a new object (e.g. furniture) at the given position.
Note: All rotation values are provided in radians. To convert degrees to radians, see Utils.MathUtils#degreeToRadian(float)

Parameters:

objectID - the object type id.

variation - the variation (e.g. texture), by default 0

chunkPosition - the target chunk position.

blockPosition - the target block position.

rotationX - rotation in radians around x axis (typically 0).

rotationY - rotation in radians around y axis (heading)

rotationZ - rotation in radians around z axis (typically 0).

placeObject

void placeObject(int objectID,
                 int variation,
                 int cx,
                 int cy,
                 int cz,
                 float bx,
                 float by,
                 float bz,
                 float rotationX,
                 float rotationY,
                 float rotationZ)

Creates a new object (e.g. furniture) at the given position.
Note: All rotation values are provided in radians. To convert degrees to radians, see Utils.MathUtils#degreeToRadian(float)

Parameters:

objectID - the object type id.

variation - the variation (e.g. texture), by default 0

cx - the target chunk x position.

cy - the target chunk y position.

cz - the target chunk z position.

bx - the target block x position.

by - the target block y position.

bz - the target block z position.

rotationX - rotation in radians around x axis (typically 0).

rotationY - rotation in radians around y axis (heading)

rotationZ - rotation in radians around z axis (typically 0).

changeObjectStatus

void changeObjectStatus(int objectID,
                        float globalPositionX,
                        float globalPositionY,
                        float globalPositionZ,
                        int newStatus)

Changes the status of an object. This is not supported by all objects. For example, it's used to specify the door status (0 == closed, 1 == opened), furnace status (depending on the furnace, status 0-3), chests (only to represent the visual state) etc.

Parameters:

objectID - the object type id.

globalPositionX - the world x position of the object.

globalPositionY - the world y position of the object.

globalPositionZ - the world z position of the object.

newStatus - the new object status. Note that the new status gets saved and is still active after a server restart (until someone else changes the status again).

Example: When a player tries to destroy a door, just open it instead

1	@EventMethod
2	public void onObjectDestroy(PlayerDestroyObjectEvent event){
3	//We only want doors to be affected (check object definition)
4	if(event.getObjectDefinition().isDoor()){
5	//Cancel the event, so the door will not be destroyed
6	event.setCancelled(true);
7
8	//Now open the door if it's closed (i.e. if status is currently 0)
9	if(event.getObjectStatus() == 0){
10	//We have to call "changeObjectStatus()" on the "World" object
11	getWorld().changeObjectStatus(event.getObjectTypeID(), event.getObjectPositionX(), event.getObjectPositionY(), event.getObjectPositionZ(), 1);
12	}
13	}
14	}

removeObject

void removeObject(int objectID,
                  float globalPositionX,
                  float globalPositionY,
                  float globalPositionZ)

Removes an object.

Parameters:

objectID - the object type id.

globalPositionX - the world x position of the object.

globalPositionY - the world y position of the object.

globalPositionZ - the world z position of the object.

removeAllVegetationsInArea

void removeAllVegetationsInArea(Area area)

Removes all vegetations (plants, trees etc.) inside the given area.

Parameters:

area - the Area which covers the area you want to edit.

removeAllVegetationsInArea

void removeAllVegetationsInArea(Vector3i startChunkPosition,
                                Vector3i startBlockPosition,
                                Vector3i endChunkPosition,
                                Vector3i endBlockPosition)

Removes all vegetations (plants, trees etc.) inside the given area.

Parameters:

startChunkPosition - the start chunk position.

startBlockPosition - the start block position.

endChunkPosition - the end chunk position.

endBlockPosition - the end block position.

removeAllVegetationsInArea

void removeAllVegetationsInArea(int startChunkX,
                                int startChunkY,
                                int startChunkZ,
                                int startBlockX,
                                int startBlockY,
                                int startBlockZ,
                                int endChunkX,
                                int endChunkY,
                                int endChunkZ,
                                int endBlockX,
                                int endBlockY,
                                int endBlockZ)

Removes all vegetations (plants, trees etc.) inside the given area.

Parameters:

startChunkX - the start x chunk position.

startChunkY - the start y chunk position.

startChunkZ - the start z chunk position.

startBlockX - the start x block position.

startBlockY - the start y block position.

startBlockZ - the start z block position.

endChunkX - the end x chunk position.

endChunkY - the end y chunk position.

endChunkZ - the end z chunk position.

endBlockX - the end x block position.

endBlockY - the end y block position.

endBlockZ - the end z block position.

removeAllObjectsInArea

void removeAllObjectsInArea(Area area)

Removes all objects (e.g. furniture, lamps etc.) inside the given area.

Parameters:

area - the Area which covers the area you want to edit.

removeAllObjectsInArea

void removeAllObjectsInArea(Vector3i startChunkPosition,
                            Vector3i startBlockPosition,
                            Vector3i endChunkPosition,
                            Vector3i endBlockPosition)

Removes all objects (e.g. furniture, lamps etc.) inside the given area.

Parameters:

startChunkPosition - the start chunk position.

startBlockPosition - the start block position.

endChunkPosition - the end chunk position.

endBlockPosition - the end block position.

removeAllObjectsInArea

void removeAllObjectsInArea(int startChunkX,
                            int startChunkY,
                            int startChunkZ,
                            int startBlockX,
                            int startBlockY,
                            int startBlockZ,
                            int endChunkX,
                            int endChunkY,
                            int endChunkZ,
                            int endBlockX,
                            int endBlockY,
                            int endBlockZ)

Removes all objects (e.g. furniture, lamps etc.) inside the given area.

Parameters:

startChunkX - the start x chunk position.

startChunkY - the start y chunk position.

startChunkZ - the start z chunk position.

startBlockX - the start x block position.

startBlockY - the start y block position.

startBlockZ - the start z block position.

endChunkX - the end x chunk position.

endChunkY - the end y chunk position.

endChunkZ - the end z chunk position.

endBlockX - the end x block position.

endBlockY - the end y block position.

endBlockZ - the end z block position.

removeAllConstructionsInArea

void removeAllConstructionsInArea(Area area)

Removes all constructions (e.g. planks, beams, windows etc.) inside the given area.

Parameters:

area - the Area which covers the area you want to edit.

removeAllConstructionsInArea

void removeAllConstructionsInArea(Vector3i startChunkPosition,
                                  Vector3i startBlockPosition,
                                  Vector3i endChunkPosition,
                                  Vector3i endBlockPosition)

Removes all constructions (e.g. planks, beams, windows etc.) inside the given area.

Parameters:

startChunkPosition - the start chunk position.

startBlockPosition - the start block position.

endChunkPosition - the end chunk position.

endBlockPosition - the end block position.

removeAllConstructionsInArea

void removeAllConstructionsInArea(int startChunkX,
                                  int startChunkY,
                                  int startChunkZ,
                                  int startBlockX,
                                  int startBlockY,
                                  int startBlockZ,
                                  int endChunkX,
                                  int endChunkY,
                                  int endChunkZ,
                                  int endBlockX,
                                  int endBlockY,
                                  int endBlockZ)

Removes all constructions (e.g. planks, beams, windows etc.) inside the given area.

Parameters:

startChunkX - the start x chunk position.

startChunkY - the start y chunk position.

startChunkZ - the start z chunk position.

startBlockX - the start x block position.

startBlockY - the start y block position.

startBlockZ - the start z block position.

endChunkX - the end x chunk position.

endChunkY - the end y chunk position.

endChunkZ - the end z chunk position.

endBlockX - the end x block position.

endBlockY - the end y block position.

endBlockZ - the end z block position.

getChunk

Chunk getChunk(int x,
               int y,
               int z)

Gets a chunk, either from the cache, or - if this chunk isn't loaded yet - from the database. If the chunk neither exists in the server cache nor in the database, the result will be null.

Parameters:

x - the x chunk offset.

y - the y chunk offset.

z - the z chunk offset.

Returns:

a chunk object, or null if the chunk does not exist.

Example: Load a chunk and change the biome ID

1	World world = getWorld();
2	//Load chunk 0, 1, 0
3	Chunk chunk = world.getChunk(0, 1, 0);
4	//Change the biome
5	chunk.biome = 0;
6	//Save chunk
7	world.saveChunk(chunk);

isChunkModified

boolean isChunkModified(int x,
                        int y,
                        int z)

Checks if a chunk has been modified, i.e. if it is "dirty". If a chunk is "untouched", this function returns false.

Parameters:

x - the x chunk offset.

y - the y chunk offset.

z - the z chunk offset.

Returns:

true if the chunk has been modified by a player (is dirty), false if it is hasn't been touched.

saveChunk

void saveChunk(Chunk chunk)

Saves the chunk. This has no influence on the clientside chunk, i.e. modifying a chunk and saving it does not affect visible chunks (a player has to reload the world or move away from the particular chunk in order to load the new chunk).

Note: Since this method also updates the server cache, it is relatively slow. If you only want to update the chunk in the database, you can call WorldDatabase.saveChunkToDb(net.risingworld.api.utils.Chunk) instead.

Warning: The save task is queued and may be executed a few ticks later, i.e. the chunk will not be safed immediately

Parameters:

chunk - the chunk object.

getChunkLOD

ChunkLOD getChunkLOD(int x,
                     int z)

Gets an LOD chunk, either from the cache, or - if this chunk isn't loaded yet - from the database. If the chunk neither exists in the server cache nor in the database, the result will be null.

Parameters:

x - the x chunk offset.

z - the z chunk offset.

Returns:

an LOD chunk object, or null if the LOD chunk does not exist.

saveChunkLOD

void saveChunkLOD(ChunkLOD chunkLOD)

Saves the LOD chunk. This has no influence on the clientside LOD chunk, i.e. modifying a chunk and saving it does not affect visible chunks (a player has to reload the world or move away from the particular chunk in order to load the new chunk).

Note: Since this method also updates the server cache, it is relatively slow. If you only want to update the LOD chunk in the database, you can call WorldDatabase.saveChunkLODToDb(net.risingworld.api.utils.ChunkLOD) instead.

Warning: The save task is queued and may be executed a few ticks later, i.e. the chunk will not be safed immediately

Parameters:

chunkLOD - the LOD chunk object.

fixChunkBorders

void fixChunkBorders(int x,
                     int y,
                     int z)

Updates chunk borders, i.e. removes "tears" between this chunk and all adjacent chunks. Similar to the F10 button in creative mode.

Parameters:

x - the chunk x offset.

y - the chunk y offset.

z - the chunk z offset.

Example: Fix chunks around player

1	World world = getWorld();
2	Vector3f chunkPos = player.getChunkPosition();
3	world.fixChunkBorders(chunkPos.x, chunkPos.y, chunkPos.z);

triggerExplosion

void triggerExplosion(Vector3f position,
                      boolean causeDamage,
                      boolean playSound)

Creates an explosion in the world. Same as a tnt explosion.

Parameters:

position - the global world position (center of the explosion).

causeDamage - true if the explosion should cause damage (to players, npcs, environment and buildings), false if you only want to spawn a visual explosion which does not cause any damage.

playSound - true if you want the explosion sound to be audible.

triggerFirework

void triggerFirework(Vector3f position,
                     float scale,
                     int color1,
                     int color2,
                     int color3,
                     boolean playSound)

Creates a firework effect in the world at the given position.

Parameters:

position - the global world position of the firework effect.

scale - the "scale" of the effect. Default is 1.0f

color1 - the primary color of the firework effect, as int RGBA (e.g. 0xFFFFFFFF for fully opaque white).

color2 - the secondary color of the firework effect, as int RGBA (e.g. 0xFF000099 for semi-transparent red).

color3 - the tertiary color of the firework effect, as int RGBA (e.g. 0x0000FF33 for transparent blue).

playSound - true if you want the effect to be audible.

spawnProjectile

void spawnProjectile(byte typeID,
                     Vector3f position,
                     Vector3f direction,
                     float velocity,
                     boolean causeDamage)

Spawns a projectile in the world.

Parameters:

typeID - the projectile type id.

position - the start position.

direction - the fly direction.

velocity - the velocity of the projectile (between 0 and 1, while 0 means no power, 1 means full speed).

causeDamage - true if you want the projectile to cause damage, false if not.

Example: Spawn an arrow (ID: 3) at the player position

1	world.spawnProjectile((byte) 3, player.getPosition().add(0f, 0.5f, 0f), player.getViewDirection(), 1f, true);