World

getBlock(x, y, z)

Gets information about a block by coordinates.

Parameters:

• x (number) - X cordinate.

• y (number) - Y cordinate.

• z (number) - Z cordinate.

Returns:

• (Block data) Return block information

Example Usage:

-- Example code showing how to use the function
local blockInfo = world.getBlock(1, 1, 1)

setBlock(x, y, z, id)

Sets the block to the desired coordinates.

Parameters:

• x (number) - X cordinate.

• y (number) - Y cordinate.

• z (number) - Z cordinate.

• id (number) - Raw block id.

Example Usage:

-- Example code showing how to use the function
world.setBlock(1, 1, 1, 1) -- Set stone to 1, 1, 1

isBlockLoaded(x, y, z)

Sets the block to the desired coordinates.

Parameters:

• x (number) - X cordinate.

• y (number) - Y cordinate.

• z (number) - Z cordinate.

Returns:

• (boolean)

Example Usage:

-- Example code showing how to use the function
local loaded = world.isBlockLoaded(1, 1, 1)

getOutlineBoxes(x, y, z, blockState)

Sets the block to the desired coordinates.

Parameters:

• x (number) - X cordinate.

• y (number) - Y cordinate.

• z (number) - Z cordinate.

• blockState (Block data)

Returns:

• table (boxes)

Example Usage:

-- Example code showing how to use the function
local blockState = world.getBlock(x, y, z)
if blockState then
    local collisions = world.getOutlineBoxes(x, y, z, blockState)
    if collisions then
        for i = 1, #collisions do
            local collision = collisions[i]
            
            local mixX = collision.minX
            local mixY = collision.minY
            local mixZ = collision.minZ
            
            local maxX = collision.maxX
            local maxY = collision.maxY
            local maxZ = collision.maxZ
        end
    end
end

getCollisionBoxes(x, y, z, blockState)

Sets the block to the desired coordinates.

Parameters:

• x (number) - X cordinate.

• y (number) - Y cordinate.

• z (number) - Z cordinate.

• blockState (Block data)

Returns:

• table (boxes)

Example Usage:

-- Example code showing how to use the function
local blockState = world.getBlock(x, y, z)
if blockState then
    local collisions = world.getCollisionBoxes(x, y, z, blockState)
    if collisions then
        for i = 1, #collisions do
            local collision = collisions[i]
            
            local mixX = collision.minX
            local mixY = collision.minY
            local mixZ = collision.minZ
            
            local maxX = collision.maxX
            local maxY = collision.maxY
            local maxZ = collision.maxZ
        end
    end
end

getEntities()

Returns a list of entities.

Returns:

• (List of entititesEntity) Return table (list) of entities

Example Usage:

-- Example code showing how to use the function
local entities = world.getEntities()

for index, entity in ipairs(entities) do
    if entity ~= nil then
        local entityName = entity.name
        local entityId = entity.id
        
        print(string.format("Entity %d: %s", 
              index, entityName))
    end
end

getEntitiesInBox(entity, box)

Returns a list of entities.

Parameters:

• entity (entity) - From entity.

• box (box) - Search box.

Returns:

• (List of entititesEntity) Return table (list) of entities

Example Usage:

-- Example code showing how to use the function
local function findArmorStandAboveEntity(entity)
    if not entity then return nil end
  
	local entities = world.getEntitiesInBox(entity, entity.box.expand(0, 2, 0))
	if entities then
		for _, ent in ipairs(entities) do
			if ent and ent.type == "entity.minecraft.armor_stand" then
				return ent
			end
		end
	end
    
    return nil
end

getLivingEntities()

Returns a list of entities.

Returns:

• (List of entititesEntity) Return table (list) of entities

Example Usage:

-- Example code showing how to use the function
local entities = world.getLivingEntities()

for index, entity in ipairs(entities) do
    if entity ~= nil then
        local entityName = entity.name
        local entityId = entity.id
        
        print(string.format("Entity %d: %s", 
              index, entityName))
    end
end

getEntityById(id)

Returns a list of entities.

Parameters:

• id (number) - Entity id.

Returns:

• (Entity) Return entity

Example Usage:

-- Example code showing how to use the function
local entity = world.getEntityById(0)
if entity then
    local entityName = entity.name
    local entityId = entity.id
        
    print(string.format("Entity %d: %s", 
          index, entityName))
end

getRotation(x, y, z)

Get yaw and pitch for 3d cordinates.

Parameters:

• x (number) - X cordinate.

• y (number) - Y cordinate.

• z (number) - Z cordinate.

Returns:

• (table) Return table (yaw, pitch)

Example Usage:

-- Example code showing how to use the function
local rotation = world.getRotation(1, 1, 1)
player.setRotation(rotation.yaw, rotation.pitch)

raycast(obj)

Return raycast result.

Parameters:

• obj (table).

Returns:

• (table) Return table

Example Usage:

-- Example code showing how to use the function
local eyePos = player.getEyePosition()
local targetX, targetY, targetZ = 0, 0, 0
local raycastResult = world.raycast({
    startX = eyePos.x,
    startY = eyePos.y, 
    startZ = eyePos.z,
    endX = targetX + 0.5,
    endY = targetY + 0.5,
    endZ = targetZ + 0.5
})

if raycastResult ~= nil then
    if raycastResult.type == "block" then
        local block = world.getBlock(raycastResult.blockPos.x, raycastResult.blockPos.y, raycastResult.blockPos.z)
        player.addMessage("Block: " .. raycastResult.blockPos.x .. ", " .. raycastResult.blockPos.y .. ", " .. raycastResult.blockPos.z .. " | " .. block.name)
    elseif raycastResult.type == "entity" then
        player.addMessage("Entity: " .. raycastResult.data.name)
    elseif raycastResult.type == "miss" then
        player.addMessage("Miss")
    end
end