It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file.


ZenScript
 Copy
import crafttweaker.api.world.MCWorld;

Implemented Interfaces

MCWorld implements the following interfaces. That means all methods defined in these interfaces are also available in MCWorld

AutoCloseable

Casters

Result type	Is Implicit
MCServerWorld	false

Methods

addEntity

add an entity to the world, return if the entity is added successfully.

Return Type: boolean


ZenScript
 Copy
MCWorld.addEntity(entity as MCEntity) as boolean

Parameter	Type	Description
entity	MCEntity	No Description Provided

asServerWorld

Return Type: MCServerWorld


ZenScript
 Copy
// MCWorld.asServerWorld() as MCServerWorld

world.asServerWorld();

destroyBlock

Destroys a block within the world.

Returns: Whether or not the block was changed.
Return Type: boolean


ZenScript
 Copy
// MCWorld.destroyBlock(pos as BlockPos, doDrops as boolean) as boolean

world.destroyBlock(new BlockPos(0, 1, 2), true);

Parameter	Type	Description
pos	BlockPos	The position of the block.
doDrops	boolean	Whether or not the block drops itself and it's loot.

destroyBlock

Destroys a block within the world.

Returns: Whether or not the block was changed.
Return Type: boolean


ZenScript
 Copy
// MCWorld.destroyBlock(pos as BlockPos, doDrops as boolean, breaker as MCEntity) as boolean

world.destroyBlock(new BlockPos(0, 1, 2), true, player);

Parameter	Type	Description
pos	BlockPos	The position of the block.
doDrops	boolean	Whether or not the block drops itself and it's loot.
breaker	MCEntity	The entity to break the block.

getBiome

Gets the biome at a given position.

Returns: The biome at the given position.
Return Type: MCBiome


ZenScript
 Copy
// MCWorld.getBiome(pos as BlockPos) as MCBiome

world.getBiome(new BlockPos(0, 1, 2));

Parameter	Type	Description
pos	BlockPos	The position to look up.

getBlockState

Gets the block state at a given position.

Returns: The block state at the position.
Return Type: MCBlockState


ZenScript
 Copy
// MCWorld.getBlockState(pos as BlockPos) as MCBlockState

world.getBlockState(new BlockPos(0, 1, 2));

Parameter	Type	Description
pos	BlockPos	The position to look up.

getEntitiesInArea

Gets all entities in given area, but the arguments are block poses. If pos2 is omitted, it will use pos1.add(1, 1, 1)

Returns: all entities in given area
Return Type: stdlib.List<MCEntity>


ZenScript
 Copy
// MCWorld.getEntitiesInArea(pos1 as BlockPos, pos2 as BlockPos) as stdlib.List<MCEntity>

world.getEntitiesInArea(new BlockPos(0, 1, 2), new BlockPos(3, 4, 5));

Parameter	Type	Description	Optional	DefaultValue
pos1	BlockPos	No Description Provided	false
pos2	BlockPos	No Description Provided	true

getEntitiesInArea

Gets all entities in given area.

Returns: all entities in given area.
Return Type: stdlib.List<MCEntity>


ZenScript
 Copy
// MCWorld.getEntitiesInArea(x1 as double, y1 as double, z1 as double, x2 as double, y2 as double, z2 as double) as stdlib.List<MCEntity>

world.getEntitiesInArea(1.0, 1.0, 1.0, 11.4, 11.4, 11.4);

Parameter	Type	Description
x1	double	No Description Provided
y1	double	No Description Provided
z1	double	No Description Provided
x2	double	No Description Provided
y2	double	No Description Provided
z2	double	No Description Provided

getEntitiesInAreaExcluding

Return Type: stdlib.List<MCEntity>


ZenScript
 Copy
// MCWorld.getEntitiesInAreaExcluding(excludingEntity as MCEntity?, predicate as Predicate<MCEntity>, pos1 as BlockPos, pos2 as BlockPos) as stdlib.List<MCEntity>

world.getEntitiesInAreaExcluding(entity, (entityIn) => entityIn.isInWater(), new BlockPos(0, 1, 2), new BlockPos(3, 4, 5));

Parameter	Type	Description	Optional
excludingEntity	MCEntity?	No Description Provided	false
predicate	Predicate<MCEntity>	No Description Provided	false
pos1	BlockPos	No Description Provided	false
pos2	BlockPos	No Description Provided	true

getEntitiesInAreaExcluding

Gets all entities in given area, excluding the one passed into it.

Return Type: stdlib.List<MCEntity>


ZenScript
 Copy
// MCWorld.getEntitiesInAreaExcluding(excludingEntity as MCEntity?, x1 as double, y1 as double, z1 as double, x2 as double, y2 as double, z2 as double, predicate as Predicate<MCEntity>) as stdlib.List<MCEntity>

world.getEntitiesInAreaExcluding(entity, 1.0, 1.0, 1.0, 11.4, 11.4, 11.4, (entityIn) => entityIn.isInWater());

Parameter	Type	Description
excludingEntity	MCEntity?	No Description Provided
x1	double	No Description Provided
y1	double	No Description Provided
z1	double	No Description Provided
x2	double	No Description Provided
y2	double	No Description Provided
z2	double	No Description Provided
predicate	Predicate<MCEntity>	the entity filter

getRedstonePower

Gets the redstone signal strength available to a position from a given direction.

Returns: The redstone signal strength available from that direction.
Return Type: int


ZenScript
 Copy
// MCWorld.getRedstonePower(pos as BlockPos, direction as Direction) as int

world.getRedstonePower(new BlockPos(0, 1, 2), <direction:north>);

Parameter	Type	Description
pos	BlockPos	The position to check.
direction	Direction	The direction to query.

getRedstonePowerFromNeighbors

Gets the highest redstone signal available to a position from any of it's neighbors.

Returns: The highest redstone signal available to the position.
Return Type: int


ZenScript
 Copy
// MCWorld.getRedstonePowerFromNeighbors(pos as BlockPos) as int

world.getRedstonePowerFromNeighbors(new BlockPos(0, 1, 2));

Parameter	Type	Description
pos	BlockPos	The position to check.

getStrongPower

Gets the highest strong (direct) redstone signal of any neighboring block.

Returns: The highest strong (direct) redstone signal of all directly neighboring blocks.
Return Type: int


ZenScript
 Copy
// MCWorld.getStrongPower(pos as BlockPos) as int

world.getStrongPower(new BlockPos(0, 1, 2));

Parameter	Type	Description
pos	BlockPos	The position to check.

getTileData

Gets the tile entity data for a tile entity at a given position.

Returns: The data of the tile entity.
Return Type: IData


ZenScript
 Copy
// MCWorld.getTileData(pos as BlockPos) as IData

world.getTileData(new BlockPos(0, 1, 2));

Parameter	Type	Description
pos	BlockPos	The position of the tile entity.

getTileEntity

Return Type: MCTileEntity?


ZenScript
 Copy
MCWorld.getTileEntity(pos as BlockPos) as MCTileEntity?

Parameter	Type	Description
pos	BlockPos	No Description Provided

isAir

Checks if the block at a given position is air.

Returns: Whether or not the block is air.
Return Type: boolean


ZenScript
 Copy
// MCWorld.isAir(pos as BlockPos) as boolean

world.isAir(new BlockPos(0, 1, 2));

Parameter	Type	Description
pos	BlockPos	The position to look up.

isBlockPowered

Checks if a given position is receiving a redstone signal.

Returns: Whether or not the position is receiving a redstone signal.
Return Type: boolean


ZenScript
 Copy
// MCWorld.isBlockPowered(pos as BlockPos) as boolean

world.isBlockPowered(new BlockPos(0, 1, 2));

Parameter	Type	Description
pos	BlockPos	The position to check.

isLoaded

Checks if the block at a given position is in a loaded chunk.

Returns: Whether or not the position is in a loaded chunk.
Return Type: boolean


ZenScript
 Copy
// MCWorld.isLoaded(pos as BlockPos) as boolean

world.isLoaded(new BlockPos(0, 1, 2));

Parameter	Type	Description
pos	BlockPos	The position to look up.

isRainingAt

Checks if it is raining at a specific position. This can never be true if the position does not have direct line of sight to the sky.

Returns: Whether or not it is raining at the current position.
Return Type: boolean


ZenScript
 Copy
// MCWorld.isRainingAt(pos as BlockPos) as boolean

world.isRainingAt(new BlockPos(0, 1, 2));

Parameter	Type	Description
pos	BlockPos	The position to check.

isRemote

Checks if the world is remote. This is always true on the rendering thread.

Returns: Whether or not the world is remote.
Return Type: boolean


ZenScript
 Copy
// MCWorld.isRemote() as boolean

world.isRemote();

playEvent

Triggers a predetermined event on the client. Using this on a server or integrated server will send the event to all nearby players.

Return Type: void


ZenScript
 Copy
// MCWorld.playEvent(eventId as int, pos as BlockPos, data as int) as void

world.playEvent(2005, new BlockPos(0, 1, 2), 0);

Parameter	Type	Description
eventId	int	The ID of the event to play.
pos	BlockPos	The position of the event.
data	int	Four bytes of additional data encoded as an integer. This is generally unused.

playEvent

Triggers a predetermined event on the client. Using this on a server or integrated server will send the event to all nearby players.

Return Type: void


ZenScript
 Copy
// MCWorld.playEvent(excluded as MCPlayerEntity, eventId as int, pos as BlockPos, data as int) as void

world.playEvent(player, 2005, new BlockPos(0, 1, 2), 0);

Parameter	Type	Description
excluded	MCPlayerEntity	An excluded player who will not receive the event.
eventId	int	The ID of the event to play.
pos	BlockPos	The position of the event.
data	int	Four bytes of additional data encoded as an integer. This is generally unused.

setBlockState

Sets the block and it's state at a given position.

Returns: Whether or not the block was changed.
Return Type: boolean


ZenScript
 Copy
// MCWorld.setBlockState(pos as BlockPos, state as MCBlockState) as boolean

world.setBlockState(new BlockPos(0, 1, 2), <blockstate:minecraft:iron_block>);

Parameter	Type	Description
pos	BlockPos	The position to set the block at.
state	MCBlockState	The new state of the block.

Properties

Name	Type	Has Getter	Has Setter	Description
dayTime	boolean	true	false	Checks if it is day time in the world. Different dimensions will have different logic for how this is determined.
difficulty	string	true	false	Gets the difficulty setting for the world.
difficultyLocked	boolean	true	false	Checks if the difficulty of the world has been locked.
dimension	string	true	false	Gets the registry name of the dimension this world represents.
gameTime	long	true	false	Gets the current game time in ticks.
hardcore	boolean	true	false	Checks if hardcore mode is enabled.
nightTime	boolean	true	false	Checks if it is night time in the world. Different dimensions will have different logic for how this is determined.
raining	boolean	true	false	Checks if it is raining.
random	Random	true	false	No Description Provided
remote	boolean	true	false	Checks if the world is remote. This is always true on the rendering thread.
seaLevel	int	true	false	Gets the height of the sea level.
thundering	boolean	true	false	Checks if there is a thunder storm.
timeOfDay	long	true	false	Gets the current time of the day in ticks.