Worlds represent a dimension within the game. They are used to interact with the blocks, mobs, and other variables within that dimension.

Importare la Classe

Link to importare-la-classe

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;

Extending CapabilityProvider<MCWorld>

Link to extending-capabilityprovidermcworld

MCWorld extends CapabilityProvider<MCWorld>. That means all methods available in CapabilityProvider<MCWorld> are also available in MCWorld

Interfacce Implementate

Link to interfacce-implementate

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

  • AutoCloseable
Tipo RisultatoImplicito
Tipo Risultato
MCBlockDisplayReader
Implicito
Tipo Risultato
MCServerWorld
Implicito
no

Name: 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
ParametroTipoDescrizione
Parametro
entity
Tipo
MCEntity
Descrizione
No Description Provided

Link to asBlockDisplayReader

Name: asBlockDisplayReader

Return Type: MCBlockDisplayReader

ZenScript
Copy
// MCWorld.asBlockDisplayReader() as MCBlockDisplayReader

world.asBlockDisplayReader();

Name: asServerWorld

Return Type: MCServerWorld

ZenScript
Copy
// MCWorld.asServerWorld() as MCServerWorld

world.asServerWorld();

Name: 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);
ParametroTipoDescrizione
Parametro
pos
Tipo
BlockPos
Descrizione
The position of the block.
Parametro
doDrops
Tipo
boolean
Descrizione
Whether or not the block drops itself and it's loot.

Name: 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);
ParametroTipoDescrizione
Parametro
pos
Tipo
BlockPos
Descrizione
The position of the block.
Parametro
doDrops
Tipo
boolean
Descrizione
Whether or not the block drops itself and it's loot.
Parametro
breaker
Tipo
MCEntity
Descrizione
The entity to break the block.

Name: 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));
ParametroTipoDescrizione
Parametro
pos
Tipo
BlockPos
Descrizione
The position to look up.

Name: 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));
ParametroTipoDescrizione
Parametro
pos
Tipo
BlockPos
Descrizione
The position to look up.

Link to getEntitiesInArea

Name: 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));
ParametroTipoDescrizioneOptionalDefaultValue
Parametro
pos1
Tipo
BlockPos
Descrizione
No Description Provided
Optional
no
DefaultValue
Parametro
pos2
Tipo
BlockPos
Descrizione
No Description Provided
Optional
DefaultValue

Link to getEntitiesInArea

Name: 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);
ParametroTipoDescrizione
Parametro
x1
Tipo
double
Descrizione
No Description Provided
Parametro
y1
Tipo
double
Descrizione
No Description Provided
Parametro
z1
Tipo
double
Descrizione
No Description Provided
Parametro
x2
Tipo
double
Descrizione
No Description Provided
Parametro
y2
Tipo
double
Descrizione
No Description Provided
Parametro
z2
Tipo
double
Descrizione
No Description Provided

Link to getEntitiesInAreaExcluding

Name: 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));
ParametroTipoDescrizioneOptionalDefaultValue
Parametro
excludingEntity
Tipo
MCEntity?
Descrizione
No Description Provided
Optional
no
DefaultValue
Parametro
predicate
Tipo
Predicate<MCEntity>
Descrizione
No Description Provided
Optional
no
DefaultValue
Parametro
pos1
Tipo
BlockPos
Descrizione
No Description Provided
Optional
no
DefaultValue
Parametro
pos2
Tipo
BlockPos
Descrizione
No Description Provided
Optional
DefaultValue

Link to getEntitiesInAreaExcluding

Name: 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());
ParametroTipoDescrizione
Parametro
excludingEntity
Tipo
MCEntity?
Descrizione
No Description Provided
Parametro
x1
Tipo
double
Descrizione
No Description Provided
Parametro
y1
Tipo
double
Descrizione
No Description Provided
Parametro
z1
Tipo
double
Descrizione
No Description Provided
Parametro
x2
Tipo
double
Descrizione
No Description Provided
Parametro
y2
Tipo
double
Descrizione
No Description Provided
Parametro
z2
Tipo
double
Descrizione
No Description Provided
Parametro
predicate
Tipo
Predicate<MCEntity>
Descrizione
the entity filter

Link to getRedstonePower

Name: 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>);
ParametroTipoDescrizione
Parametro
pos
Tipo
BlockPos
Descrizione
The position to check.
Parametro
direction
Tipo
Direction
Descrizione
The direction to query.

Link to getRedstonePowerFromNeighbors

Name: 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));
ParametroTipoDescrizione
Parametro
pos
Tipo
BlockPos
Descrizione
The position to check.

Name: 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));
ParametroTipoDescrizione
Parametro
pos
Tipo
BlockPos
Descrizione
The position to check.

Name: 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));
ParametroTipoDescrizione
Parametro
pos
Tipo
BlockPos
Descrizione
The position of the tile entity.

Name: getTileEntity

Return Type: MCTileEntity?

ZenScript
Copy
MCWorld.getTileEntity(pos as BlockPos) as MCTileEntity?
ParametroTipoDescrizione
Parametro
pos
Tipo
BlockPos
Descrizione
No Description Provided

Name: 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));
ParametroTipoDescrizione
Parametro
pos
Tipo
BlockPos
Descrizione
The position to look up.

Name: 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));
ParametroTipoDescrizione
Parametro
pos
Tipo
BlockPos
Descrizione
The position to check.

Name: 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));
ParametroTipoDescrizione
Parametro
pos
Tipo
BlockPos
Descrizione
The position to look up.

Name: 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));
ParametroTipoDescrizione
Parametro
pos
Tipo
BlockPos
Descrizione
The position to check.

Name: 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();

Name: 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);
ParametroTipoDescrizione
Parametro
eventId
Tipo
int
Descrizione
The ID of the event to play.
Parametro
pos
Tipo
BlockPos
Descrizione
The position of the event.
Parametro
data
Tipo
int
Descrizione
Four bytes of additional data encoded as an integer. This
is generally unused.

Name: 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);
ParametroTipoDescrizione
Parametro
excluded
Tipo
MCPlayerEntity
Descrizione
An excluded player who will not receive the event.
Parametro
eventId
Tipo
int
Descrizione
The ID of the event to play.
Parametro
pos
Tipo
BlockPos
Descrizione
The position of the event.
Parametro
data
Tipo
int
Descrizione
Four bytes of additional data encoded as an integer. This
is generally unused.

Name: rayTraceBlocks

Creates a ray trace from one vector to the other vector, which will stop at a block or a fluid.

Returns: a BlockRayTraceResult holding the result, the position and facing the ray stops.
Return Type: BlockRayTraceResult

ZenScript
Copy
// MCWorld.rayTraceBlocks(startVec as MCVector3d, endVec as MCVector3d, blockMode as RayTraceBlockMode, fluidMode as RayTraceFluidMode, entity as MCEntity) as BlockRayTraceResult

world.rayTraceBlocks(new MCVector3d(0.0, 0.0, 0.0), new MCVector3d(1.1, 4.5, 1.4), RayTraceBlockMode.OUTLINE, RayTraceFluidMode.NONE, entity);
ParametroTipoDescrizioneOptionalDefaultValue
Parametro
startVec
Tipo
MCVector3d
Descrizione
a vector which describes the starting point
Optional
no
DefaultValue
Parametro
endVec
Tipo
MCVector3d
Descrizione
a vector which describes the direction and length we are searching in
Optional
no
DefaultValue
Parametro
blockMode
Tipo
RayTraceBlockMode
Descrizione
the type of block that the ray trace would stop at.
Optional
no
DefaultValue
Parametro
fluidMode
Tipo
RayTraceFluidMode
Descrizione
the type of fluid that the ray trace would stop at.
Optional
no
DefaultValue
Parametro
entity
Tipo
MCEntity
Descrizione
the entity for selection context
Optional
DefaultValue

Name: 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>);
ParametroTipoDescrizione
Parametro
pos
Tipo
BlockPos
Descrizione
The position to set the block at.
Parametro
state
Tipo
MCBlockState
Descrizione
The new state of the block.
NomeTipoHa GetterHa SetterDescrizione
Nome
dayTime
Tipo
boolean
Ha Getter
Ha Setter
no
Descrizione
Checks if it is day time in the world. Different dimensions will have
different logic for how this is determined.
Nome
difficulty
Tipo
string
Ha Getter
Ha Setter
no
Descrizione
Gets the difficulty setting for the world.
Nome
difficultyLocked
Tipo
boolean
Ha Getter
Ha Setter
no
Descrizione
Checks if the difficulty of the world has been locked.
Nome
dimension
Tipo
string
Ha Getter
Ha Setter
no
Descrizione
Gets the registry name of the dimension this world represents.
Nome
gameTime
Tipo
long
Ha Getter
Ha Setter
no
Descrizione
Gets the current game time in ticks.
Nome
hardcore
Tipo
boolean
Ha Getter
Ha Setter
no
Descrizione
Checks if hardcore mode is enabled.
Nome
nightTime
Tipo
boolean
Ha Getter
Ha Setter
no
Descrizione
Checks if it is night time in the world. Different dimensions will have
different logic for how this is determined.
Nome
raining
Tipo
boolean
Ha Getter
Ha Setter
no
Descrizione
Checks if it is raining.
Nome
random
Tipo
Random
Ha Getter
Ha Setter
no
Descrizione
No Description Provided
Nome
remote
Tipo
boolean
Ha Getter
Ha Setter
no
Descrizione
Checks if the world is remote. This is always true on the rendering
thread.
Nome
seaLevel
Tipo
int
Ha Getter
Ha Setter
no
Descrizione
Gets the height of the sea level.
Nome
thundering
Tipo
boolean
Ha Getter
Ha Setter
no
Descrizione
Checks if there is a thunder storm.
Nome
timeOfDay
Tipo
long
Ha Getter
Ha Setter
no
Descrizione
Gets the current time of the day in ticks.