World¶

Overview¶

The World table contains access to a variety of information about the current game world.

Enumerations¶

HeightOffsetType¶

Used with World.GetGroundHeight() to apply additional offsets to the ground height, depending on the type of LocEntity placed at the sampled position.

Functions¶

IsAvailable¶

function World.IsAvailable() -> Boolean

Returns whether the world data can currently be accessed.

if World.IsAvailable() then
    local coord = CoordGrid._0_50_50_32_32
    local coordPos = coord:ToFine(true).position
    local height = World.GetGroundHeight(coord.level, coordPos.x, coordPos.z)
end

IsMembers¶

function World.IsMembers() -> Boolean

Returns whether the currently connected world is a Member's world.

if World.IsMembers() then
    -- Do something with the value
end

GetPing¶

function World.GetPing() -> Integer

Returns the ping value to the current game world.

This function will return -1 if there is no active connection to a game world.

local ping = World.GetPing()
-- Do something with the value

GetRebootTimer¶

function World.GetRebootTimer() -> Integer

Returns the number of logic ticks (50 per second) until the currently connected server reboots.

local rebootTicksRemaining = World.GetRebootTimer()
if rebootTicksRemaining > 0 then
    -- Do something with the value
end

IsRegion¶

function World.IsRegion() -> Boolean

Returns whether the current game world is a region or not.

if World.IsRegion() then
    -- Do something
end

GetRegionSourceForCoordGrid¶

function World.GetRegionSourceForCoordGrid(coord : CoordGrid) -> CoordGrid?

Returns the source coordinate for a given region CoordGrid.

if World.IsRegion() then
    local sourceCoord = World.GetRegionSourceForCoordGrid(Player.GetEntity().coordGrid)
end

GetMapSquareBounds¶

function World.GetMapSquareBounds() -> Rect?

Returns the map square bounds for the currently loaded game world.

log(tostring(World.GetMapSquareBounds()))
-- { x = 107, y = 1, w = 2, h = 2 }

-- Get the bounds of the game world
local bounds = World.GetMapSquareBounds()
if bounds ~= nil then
    -- Use the config
end
...

GetGroundHeight¶

function World.GetGroundHeight(level : Integer, x : Integer, z : Integer, heightOffsetType? : HeightOffsetType) -> Integer,Boolean

Returns the height for the given level and position values, along with whether the height was available for that position.

All positional values are in fine units, where a tile dimension is 512 fine units.

local coord = CoordGrid._0_50_50_32_32
local coordPos = coord:ToFine(true).position
-- Store both the height and whether it was successfully accessed
local height,success = World.GetGroundHeight(coord.level, coordPos.x, coordPos.z)
if success then
    -- Do something with the valid height
end

RemoveRoof¶

Overview¶

The Remove Roof system allows the client to hide upper levels of the game world in order to provide a clearer view to players.
Portions of the game world, such as the upper floors of a building, are grouped together and hidden as a whole when the system is told to 'reveal' a coordinate on a level underneath the group.

Some coordinates are marked in this way by default, such as:

• The Player Character's current coordinate, and
• All coordinates between the camera position and its focal target position.

The functions below allow plugins to add individual coordinates, and coordinate ranges, to further extend which parts of the game world should be hidden by this system.

Functions¶

Add(name, coord)¶

function World.RemoveRoof.Add(name : String, coord : CoordGrid)

Adds the given coordinate to the Remove Roof system, registering it by the given name.

If the name has already been registered then the existing coordinate, or coordinate range, is updated with the new coordinate.

-- Add the mouse coord, and clear it if we couldn't get a mouse coord
local coordGrid = ScreenConvert.ScreenToCoordGrid(Mouse.GetPosition())
if coordGrid ~= nil then
    World.RemoveRoof.Add("cursorTile", coordGrid)
else
    World.RemoveRoof.Remove("cursorTile")
end

Add(name, coordRangeMin, coordRangeMax)¶

function World.RemoveRoof.Add(name : String, coordRangeMin : CoordGrid, coordRangeMax : CoordGrid)

Adds the given coordinate range to the Remove Roof system, registering it by the given name.

If the name has already been registered then the existing coordinate, or coordinate range, is updated with the new coordinate range.

for (level = coordRangeMin.level; level <= coordRangeMax.level; level++)
    for (x = coordRangeMin.x; x <= coordRangeMax.x; x++)
        for (z = coordRangeMin.z; z <= coordRangeMax.z; z++)
            ApplyCoordinate(level, x, z)

-- Add the mouse coord, with a 1-tile buffer around it
local coordGrid = ScreenConvert.ScreenToCoordGrid(Mouse.GetPosition())
if coordGrid ~= nil then
    local coordGridMin = CoordGrid.new(coordGrid)
    local coordGridMax = CoordGrid.new(coordGrid)

    coordGridMin.x = coordGridMin.x - 1
    coordGridMin.z = coordGridMin.z - 1

    coordGridMax.x = coordGridMax.x + 1
    coordGridMax.z = coordGridMax.z + 1

    World.RemoveRoof.Add("cursorTile", coordGridMin, coordGridMax)
end

Remove¶

Removes the coordinate, or coordinate range, registered by the given name from the Remove Roof system.

-- Add the mouse coord, and clear it if we couldn't get a mouse coord
local coordGrid = ScreenConvert.ScreenToCoordGrid(Mouse.GetPosition())
if coordGrid ~= nil then
    World.RemoveRoof.Add("cursorTile", coordGrid)
else
    World.RemoveRoof.Remove("cursorTile")
end

Clear¶

Removes all Remove Roof coordinates registered by the current plugin.

-- Clean up registered Remove Roof coordinates not holding shift
if Keyboard.IsShiftDown() then
    -- Do various Remove Roof things
else
    World.RemoveRoof.Clear()
end