IWorld

The IWorld object contains information on a Dimension within the game.

Importing the class

It might be required to import the class to avoid errors.
import crafttweaker.world.IWorld

Extending IBlockProperties

IWorld extends IBlockAccess. That means that all methods that are available to IBlockAccess objects are also available to IWorld.

Creating an IWorld object

Normally, you can derive this object from entities or other functions. If you need to create it yourself though, this is the way to go:
Note that this method should only be called inside functions that are meant to be run inside minecraft, not during the loading circle.

crafttweaker.world.IWorld.getFromID(int id);

ZenMethods without parameters and ZenGetters

ZenMethods with parameters

Get Biome at specific Position

Use either an IPosition3f or an IBlockPos object.
Returns an IBiome Object.

worldObj.getBiome(IPosition3f position);
worldObj.getBiome(IBlockPos position);

Get Brightness at specific Position

Use either three ints or an IBlockPos object. Returns an int.

worldObj.getBrightness(int x, int y, int z);
worldObj.getBrightness(IBlockPos position);

Get Block at specific Position

Use either three ints or an IBlockPos object. Returns an IBlock Object.

worldObj.getBlock(int x, int y, int z);
worldObj.getBlock(IBlockPos position);

Get or Set a blockState at a specific Position

Use an IBlockPos Object and for the setter also an IBlockState Object. Optionally an IData object can be specified to define NBT data for the blockstate’s TileEntity when it is set. Getter Returns an IBlockState, setter a bool.

worldObj.getBlockState(IBlockPos pos);
worldObj.setBlockState(IBlockState state, IBlockPos pos);
worldObj.setBlockState(IBlockState state, IData tileEntityData, IBlockPos pos);

Spawn Entity

Use an IEntity object.
Returns a bool that states if the spawn was successful.

worldObj.spawnEntity(IEntity entity);

Create Lightningbolt

Returns the Lightningbolt as an IEntity object.

worldObj.createLightningBolt(double x, double y, double z, @Optional boolean effectOnly);

Add a Weather Effect

Use an IEntity object.
Returns a bool that states if the spawn was successful.

worldObj.addWeatherEffect(IEntity entity);

Remove Entity

Use an IEntity object.
Returns a bool that states if the remove was successful.

worldObj.removeEntity(IEntity entity);

Get a raytrace result

Use two IVector3d objects, and three booleans to get an IRayTraceResult.
Can be null

The first vector describes the starting point, the 2nd vector the direction and length we are searching in.
Only the last parameter is true by default.

worldObj.rayTraceBlocks(IVector3d begin, IVector3d ray, @Optional boolean stopOnLiquid, @Optional boolean ignoreBlockWithoutBoundingBox, @Optional(true) boolean returnLastUncollidableBlock)

Get the picked block

Use an IBlockPos, an IRayTraceResult and an IPlayer.
Returns an IItemStack.
Can be null

Gets the IItemStack that would be obtained by picking the block at the position.

worldObj.getPickedBlock(IBlockPos pos, IRayTraceResult rayTraceResult, IPlayer player);

Check if a position is a spawn chunk

Returns a bool that states if the position is a spawn chunk.

worldObj.isSpawnChunk(int x, int z);

Extinguish Fire

Returns a bool.

worldObj.extinguishFire(IPlayer player, IBlockPos pos, IFacing side);

Create an explosion object

Use an IEntity, three doubles, a float, and two booleans. Returns an IExplosion.

Creates an IExplosion in the world at the given coordinates. The explosion will have the specified placer (can be null), as well as the size of the explosion and whether it should cause fire and/or cause terrain damage, respectively.

worldObj.createExplosion(IEntity exploder, double x, double y, double z, float size, bool causesFire, bool damagesTerrain);

Perform an explosion in the world

Create & perform in the same method

Use an IEntity, three doubles, a float, and two booleans. Returns the created and performed IExplosion.

Creates and performs an IExplosion in the world at the given coordinates. The explosion will have the specified placer (can be null), as well as the size of the explosion and whether it should cause fire and/or cause terrain damage, respectively.

worldObj.performExplosion(IEntity exploder, double x, double y, double z, float size, bool causesFire, bool damagesTerrain);

Only perform an existing explosion

Use an IExplosion. Returns the performed IExplosion.

Performs the IExplosion in the world.

worldObj.performExplosion(IExplosion explosion);