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

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;

已实现的接口

Link to 已实现的接口

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

  • AutoCloseable
结果类型是否隐藏
结果类型
MCServerWorld
是否隐藏
false

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
参数类型描述
参数
entity
类型
MCEntity
描述
No Description Provided

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);
参数类型描述
参数
类型
BlockPos
描述
The position of the block.
参数
doDrops
类型
布尔值
描述
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);
参数类型描述
参数
类型
BlockPos
描述
The position of the block.
参数
doDrops
类型
布尔值
描述
Whether or not the block drops itself and it's loot.
参数
breaker
类型
MCEntity
描述
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));
参数类型描述
参数
类型
BlockPos
描述
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));
参数类型描述
参数
类型
BlockPos
描述
The position to look up.

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));
参数类型描述可选DefaultValue
参数
pos1
类型
BlockPos
描述
No Description Provided
可选
false
DefaultValue
参数
pos2
类型
BlockPos
描述
No Description Provided
可选
true
DefaultValue

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);
参数类型描述
参数
x1
类型
双精度
描述
No Description Provided
参数
y1
类型
双精度
描述
No Description Provided
参数
z1
类型
双精度
描述
No Description Provided
参数
x2
类型
双精度
描述
No Description Provided
参数
y2
类型
双精度
描述
No Description Provided
参数
z2
类型
双精度
描述
No Description Provided

Link to g-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));
参数类型描述可选DefaultValue
参数
excludingEntity
类型
MCEntity?
描述
No Description Provided
可选
false
DefaultValue
参数
predicate
类型
Predicate<MCEntity>
描述
No Description Provided
可选
false
DefaultValue
参数
pos1
类型
BlockPos
描述
No Description Provided
可选
false
DefaultValue
参数
pos2
类型
BlockPos
描述
No Description Provided
可选
true
DefaultValue

Link to g-getentitiesinareaexcluding-1

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());
参数类型描述
参数
excludingEntity
类型
MCEntity?
描述
No Description Provided
参数
x1
类型
双精度
描述
No Description Provided
参数
y1
类型
双精度
描述
No Description Provided
参数
z1
类型
双精度
描述
No Description Provided
参数
x2
类型
双精度
描述
No Description Provided
参数
y2
类型
双精度
描述
No Description Provided
参数
z2
类型
双精度
描述
No Description Provided
参数
predicate
类型
Predicate<MCEntity>
描述
the entity filter

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>);
参数类型描述
参数
类型
BlockPos
描述
The position to check.
参数
direction
类型
Direction
描述
The direction to query.

Link to g-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));
参数类型描述
参数
类型
BlockPos
描述
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));
参数类型描述
参数
类型
BlockPos
描述
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));
参数类型描述
参数
类型
BlockPos
描述
The position of the tile entity.

Name: getTileEntity

Return Type: MCTileEntity?

ZenScript
Copy
MCWorld.getTileEntity(pos as BlockPos) as MCTileEntity?
参数类型描述
参数
类型
BlockPos
描述
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));
参数类型描述
参数
类型
BlockPos
描述
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));
参数类型描述
参数
类型
BlockPos
描述
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));
参数类型描述
参数
类型
BlockPos
描述
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));
参数类型描述
参数
类型
BlockPos
描述
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);
参数类型描述
参数
eventId
类型
int
描述
The ID of the event to play.
参数
类型
BlockPos
描述
The position of the event.
参数
data
类型
int
描述
Four bytes of additional data encoded as an integer. This <br /> 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);
参数类型描述
参数
excluded
类型
MCPlayerEntity #MC玩家实体
描述
An excluded player who will not receive the event.
参数
eventId
类型
int
描述
The ID of the event to play.
参数
类型
BlockPos
描述
The position of the event.
参数
data
类型
int
描述
Four bytes of additional data encoded as an integer. This <br /> 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);
参数类型描述可选DefaultValue
参数
startVec
类型
MCVector3d
描述
a vector which describes the starting point
可选
false
DefaultValue
参数
endVec
类型
MCVector3d
描述
a vector which describes the direction and length we are searching in
可选
false
DefaultValue
参数
blockMode
类型
RayTraceBlockMode
描述
the type of block that the ray trace would stop at.
可选
false
DefaultValue
参数
fluidMode
类型
RayTraceFluidMode
描述
the type of fluid that the ray trace would stop at.
可选
false
DefaultValue
参数
entity
类型
MCEntity
描述
the entity for selection context
可选
true
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>);
参数类型描述
参数
类型
BlockPos
描述
The position to set the block at.
参数
state
类型
MCBlockState #MC方块状态
描述
The new state of the block.
名称类型可获得可设置描述
名称
dayTime
类型
布尔值
可获得
true
可设置
false
描述
Checks if it is day time in the world. Different dimensions will have <br /> different logic for how this is determined.
名称
difficulty
类型
string
可获得
true
可设置
false
描述
Gets the difficulty setting for the world.
名称
difficultyLocked
类型
布尔值
可获得
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
类型
布尔值
可获得
true
可设置
false
描述
Checks if hardcore mode is enabled.
名称
nightTime
类型
布尔值
可获得
true
可设置
false
描述
Checks if it is night time in the world. Different dimensions will have <br /> different logic for how this is determined.
名称
raining
类型
布尔值
可获得
true
可设置
false
描述
Checks if it is raining.
名称
random
类型
Random
可获得
true
可设置
false
描述
No Description Provided
名称
remote
类型
布尔值
可获得
true
可设置
false
描述
Checks if the world is remote. This is always true on the rendering <br /> thread.
名称
seaLevel
类型
int
可获得
true
可设置
false
描述
Gets the height of the sea level.
名称
thundering
类型
布尔值
可获得
true
可设置
false
描述
Checks if there is a thunder storm.
名称
timeOfDay
类型
long
可获得
true
可设置
false
描述
Gets the current time of the day in ticks.