Importing the class

Link to importing-the-class

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.Level;

Implemented Interfaces

Link to implemented-interfaces

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

  • AutoCloseable

Name: addFreshEntity

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

Return Type: boolean

ZenScript
Copy
Level.addFreshEntity(entity as Entity) as boolean
ParameterTypeDescription
Parameter
entity
Type
Entity
Description
No Description Provided

Name: destroyBlock

Destroys a block within the world.

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

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

myLevel.destroyBlock(new BlockPos(0, 1, 2), true);
ParameterTypeDescription
Parameter
pos
Type
BlockPos
Description
The position of the block.
Parameter
doDrops
Type
boolean
Description
Whether the block drops itself and it's loot.

Name: destroyBlock

Destroys a block within the world.

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

ZenScript
Copy
// Level.destroyBlock(pos as BlockPos, doDrops as boolean, breaker as Entity) as boolean

myLevel.destroyBlock(new BlockPos(0, 1, 2), true, player);
ParameterTypeDescription
Parameter
pos
Type
BlockPos
Description
The position of the block.
Parameter
doDrops
Type
boolean
Description
Whether the block drops itself and it's loot.
Parameter
breaker
Type
Entity
Description
The entity to break the block.

Link to getBestNeighborSignal

Name: getBestNeighborSignal

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
// Level.getBestNeighborSignal(pos as BlockPos) as int

myLevel.getBestNeighborSignal(new BlockPos(0, 1, 2));
ParameterTypeDescription
Parameter
pos
Type
BlockPos
Description
The position to check.

Name: getBiome

Gets the biome at a given position.

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

ZenScript
Copy
// Level.getBiome(pos as BlockPos) as Biome

myLevel.getBiome(new BlockPos(0, 1, 2));
ParameterTypeDescription
Parameter
pos
Type
BlockPos
Description
The position to look up.

Name: getBlockEntity

Return Type: BlockEntity

ZenScript
Copy
Level.getBlockEntity(pos as BlockPos) as BlockEntity
ParameterTypeDescription
Parameter
pos
Type
BlockPos
Description
No Description Provided

Link to getBlockEntityData

Name: getBlockEntityData

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

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

ZenScript
Copy
// Level.getBlockEntityData(pos as BlockPos) as MapData

myLevel.getBlockEntityData(new BlockPos(0, 1, 2));
ParameterTypeDescription
Parameter
pos
Type
BlockPos
Description
The position of the tile entity.

Name: getBlockState

Gets the block state at a given position.

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

ZenScript
Copy
// Level.getBlockState(pos as BlockPos) as BlockState

myLevel.getBlockState(new BlockPos(0, 1, 2));
ParameterTypeDescription
Parameter
pos
Type
BlockPos
Description
The position to look up.

Name: getDayTime

Return Type: long

ZenScript
Copy
// Level.getDayTime() as long

myLevel.getDayTime();

Link to getDirectSignalTo

Name: getDirectSignalTo

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
// Level.getDirectSignalTo(pos as BlockPos) as int

myLevel.getDirectSignalTo(new BlockPos(0, 1, 2));
ParameterTypeDescription
Parameter
pos
Type
BlockPos
Description
The position to check.

Name: getEntities

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

Return Type: stdlib.List<Entity>

ZenScript
Copy
// Level.getEntities(excludingEntity as Entity, x1 as double, y1 as double, z1 as double, x2 as double, y2 as double, z2 as double, predicate as Predicate<Entity>) as stdlib.List<Entity>

myLevel.getEntities(entity, 1.0, 1.0, 1.0, 11.4, 11.4, 11.4, (entityIn) => entityIn.isInWater());
ParameterTypeDescription
Parameter
excludingEntity
Type
Entity
Description
No Description Provided
Parameter
x1
Type
double
Description
No Description Provided
Parameter
y1
Type
double
Description
No Description Provided
Parameter
z1
Type
double
Description
No Description Provided
Parameter
x2
Type
double
Description
No Description Provided
Parameter
y2
Type
double
Description
No Description Provided
Parameter
z2
Type
double
Description
No Description Provided
Parameter
predicate
Type
Predicate<Entity>
Description
the entity filter

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<T>

ZenScript
Copy
Level.getEntitiesInArea<T : Entity>(pos1 as BlockPos, pos2 as BlockPos) as stdlib.List<T>
ParameterTypeDescriptionOptionalDefaultValue
Parameter
pos1
Type
BlockPos
Description
No Description Provided
Optional
false
DefaultValue
Parameter
pos2
Type
BlockPos
Description
No Description Provided
Optional
true
DefaultValue
Parameter
T
Type
Entity
Description
No Description Provided
Optional
N/A
DefaultValue
N/A

Link to getEntitiesInAreaExcluding

Name: getEntitiesInAreaExcluding

Return Type: stdlib.List<Entity>

ZenScript
Copy
// Level.getEntitiesInAreaExcluding(excludingEntity as Entity, predicate as Predicate<Entity>, pos1 as BlockPos, pos2 as BlockPos) as stdlib.List<Entity>

myLevel.getEntitiesInAreaExcluding(entity, (entityIn) => entityIn.isInWater(), new BlockPos(0, 1, 2), new BlockPos(3, 4, 5));
ParameterTypeDescriptionOptionalDefaultValue
Parameter
excludingEntity
Type
Entity
Description
No Description Provided
Optional
false
DefaultValue
Parameter
predicate
Type
Predicate<Entity>
Description
No Description Provided
Optional
false
DefaultValue
Parameter
pos1
Type
BlockPos
Description
No Description Provided
Optional
false
DefaultValue
Parameter
pos2
Type
BlockPos
Description
No Description Provided
Optional
true
DefaultValue

Link to getEntitiesOfClass

Name: getEntitiesOfClass

Gets all entities in given area.

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

ZenScript
Copy
Level.getEntitiesOfClass<T : Entity>(x1 as double, y1 as double, z1 as double, x2 as double, y2 as double, z2 as double) as stdlib.List<T>
ParameterTypeDescription
Parameter
x1
Type
double
Description
No Description Provided
Parameter
y1
Type
double
Description
No Description Provided
Parameter
z1
Type
double
Description
No Description Provided
Parameter
x2
Type
double
Description
No Description Provided
Parameter
y2
Type
double
Description
No Description Provided
Parameter
z2
Type
double
Description
No Description Provided
Parameter
T
Type
Entity
Description
No Description Provided

Name: getGametime

Return Type: long

ZenScript
Copy
// Level.getGametime() as long

myLevel.getGametime();

Name: getSignal

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
// Level.getSignal(pos as BlockPos, direction as Direction) as int

myLevel.getSignal(new BlockPos(0, 1, 2), <direction:north>);
ParameterTypeDescription
Parameter
pos
Type
BlockPos
Description
The position to check.
Parameter
direction
Type
Direction
Description
The direction to query.

Link to globalLevelEvent

Name: globalLevelEvent

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
// Level.globalLevelEvent(eventId as int, pos as BlockPos, data as int) as void

myLevel.globalLevelEvent(2005, new BlockPos(0, 1, 2), 0);
ParameterTypeDescription
Parameter
eventId
Type
int
Description
The ID of the event to play.
Parameter
pos
Type
BlockPos
Description
The position of the event.
Parameter
data
Type
int
Description
Four bytes of additional data encoded as an integer. This
is generally unused.

Link to hasNeighborSignal

Name: hasNeighborSignal

Checks if a given position is receiving a redstone signal.

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

ZenScript
Copy
// Level.hasNeighborSignal(pos as BlockPos) as boolean

myLevel.hasNeighborSignal(new BlockPos(0, 1, 2));
ParameterTypeDescription
Parameter
pos
Type
BlockPos
Description
The position to check.

Name: isClientSide

Return Type: boolean

ZenScript
Copy
// Level.isClientSide() as boolean

myLevel.isClientSide();

Name: isDay

Return Type: boolean

ZenScript
Copy
// Level.isDay() as boolean

myLevel.isDay();

Name: isEmptyBlock

Checks if the block at a given position is empty.

Returns: Whether the block is empty.
Return Type: boolean

ZenScript
Copy
// Level.isEmptyBlock(pos as BlockPos) as boolean

myLevel.isEmptyBlock(new BlockPos(0, 1, 2));
ParameterTypeDescription
Parameter
pos
Type
BlockPos
Description
The position to look up.

Name: isLoaded

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

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

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

myLevel.isLoaded(new BlockPos(0, 1, 2));
ParameterTypeDescription
Parameter
pos
Type
BlockPos
Description
The position to look up.

Name: isNight

Return Type: boolean

ZenScript
Copy
// Level.isNight() as boolean

myLevel.isNight();

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 it is raining at the current position.
Return Type: boolean

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

myLevel.isRainingAt(new BlockPos(0, 1, 2));
ParameterTypeDescription
Parameter
pos
Type
BlockPos
Description
The position to check.

Name: levelEvent

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
// Level.levelEvent(excluded as Player, eventId as int, pos as BlockPos, data as int) as void

myLevel.levelEvent(player, 2005, new BlockPos(0, 1, 2), 0);
ParameterTypeDescription
Parameter
excluded
Type
Player
Description
An excluded player who will not receive the event.
Parameter
eventId
Type
int
Description
The ID of the event to play.
Parameter
pos
Type
BlockPos
Description
The position of the event.
Parameter
data
Type
int
Description
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 BlockHitResult holding the result, the position and facing the ray stops.
Return Type: BlockHitResult

ZenScript
Copy
// Level.rayTraceBlocks(startVec as Vec3, endVec as Vec3, blockMode as BlockClipContext, fluidMode as FluidClipContext, entity as Entity) as BlockHitResult

myLevel.rayTraceBlocks(new Vec3(0.0, 0.0, 0.0), new Vec3(1.1, 4.5, 1.4), RayTraceBlockMode.OUTLINE, RayTraceFluidMode.NONE, entity);
ParameterTypeDescriptionOptionalDefaultValue
Parameter
startVec
Type
Vec3
Description
a vector which describes the starting point
Optional
false
DefaultValue
Parameter
endVec
Type
Vec3
Description
a vector which describes the direction and length we are searching in
Optional
false
DefaultValue
Parameter
blockMode
Type
BlockClipContext
Description
the type of block that the ray trace would stop at.
Optional
false
DefaultValue
Parameter
fluidMode
Type
FluidClipContext
Description
the type of fluid that the ray trace would stop at.
Optional
false
DefaultValue
Parameter
entity
Type
Entity
Description
the entity for selection context
Optional
true
DefaultValue

Name: sequence

Creates a new SequenceBuilder<T,U> for this level.

SequenceBuilder<T,U>'s let you compose scripted events such as waiting 5 ticks, then setting the weather to rain.

Returns: A new SequenceBuilder<T,U> for this level.
Return Type: SequenceBuilder<Level,MapData>

ZenScript
Copy
// Level.sequence(data as MapData) as SequenceBuilder<Level,MapData>

myLevel.sequence({version: "1.0.0"});
ParameterTypeDescriptionOptionalDefaultValue
Parameter
data
Type
MapData
Description
No Description Provided
Optional
true
DefaultValue
new crafttweaker.api.data.MapData()

Name: sequence

Creates a new SequenceBuilder<T,U> for this level.

SequenceBuilder<T,U>'s let you compose scripted events such as waiting 5 ticks, then setting the weather to rain.

Returns: A new SequenceBuilder<T,U> for this level.
Return Type: SequenceBuilder<Level,T>

ZenScript
Copy
// Level.sequence<T : Object>(data as T) as SequenceBuilder<Level,T>

myLevel.sequence<crafttweaker.api.data.MapData>({version: "1.0.0"});
ParameterTypeDescription
Parameter
data
Type
T
Description
No Description Provided
Parameter
T
Type
Object
Description
No Description Provided

Link to setBlockAndUpdate

Name: setBlockAndUpdate

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

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

ZenScript
Copy
// Level.setBlockAndUpdate(pos as BlockPos, state as BlockState) as boolean

myLevel.setBlockAndUpdate(new BlockPos(0, 1, 2), <blockstate:minecraft:iron_block>);
ParameterTypeDescription
Parameter
pos
Type
BlockPos
Description
The position to set the block at.
Parameter
state
Type
BlockState
Description
The new state of the block.

Name: setRainingLevel

Sets the current rain level.

Return Type: void

ZenScript
Copy
// Level.setRainingLevel(level as float) as void

myLevel.setRainingLevel(0.5);
ParameterTypeDescription
Parameter
level
Type
float
Description
The new rain level between 0 and 1
NameTypeHas GetterHas SetterDescription
Name
daytime
Type
long
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
difficulty
Type
string
Has Getter
true
Has Setter
false
Description
Gets the difficulty setting for the world.
Name
difficultyLocked
Type
boolean
Has Getter
true
Has Setter
false
Description
Checks if the difficulty of the world has been locked.
Name
dimension
Type
ResourceLocation
Has Getter
true
Has Setter
false
Description
Gets the registry name of the dimension this world represents.
Name
gameTime
Type
long
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
hardcore
Type
boolean
Has Getter
true
Has Setter
false
Description
Checks if hardcore mode is enabled.
Name
isClientSide
Type
boolean
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
isDay
Type
boolean
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
isNight
Type
boolean
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
rainLevel
Type
Level
Has Getter
false
Has Setter
true
Description
Sets the current rain level.
Name
raining
Type
boolean
Has Getter
true
Has Setter
false
Description
Checks if it is raining.
Name
random
Type
Random
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
seaLevel
Type
int
Has Getter
true
Has Setter
false
Description
Gets the height of the sea level.
Name
thundering
Type
boolean
Has Getter
true
Has Setter
false
Description
Checks if there is a thunder storm.