LogoLogo
  • Introduction
  • sdks
    • Feature Comparison
    • Unity
    • Godot
    • Defold
    • LÖVE
    • Unreal
  • Quick Start
    • Unity
    • Godot
    • Defold
    • LÖVE
    • Unreal
  • Server Side
    • Entities
    • Chunks
    • Dimensions
    • Events
    • Logging
    • Lua Environment
    • Git Primer
    • Physics
  • HTTP API
    • Authentication
    • Player API
  • Api Reference
    • Entity API
      • Create
      • Message
    • Client API
      • Message
    • Dimension API
      • Create
      • Delete
      • List
    • Events API
      • on_player_join
      • on_player_leave
    • Table API
      • Append
      • Remove
      • Join
    • Util API
      • Time
      • TimeMillis
    • HTTP Request API
      • Get
      • Post
      • Put
      • Delete
    • Physics API
      • NewBody
      • NewBoxShape
      • NewSphereShape
Powered by GitBook
On this page
  1. Api Reference
  2. Dimension API

Delete

api.dimension.Delete(dimension)

Deletes a dimension.

The default dimension cannot be deleted. It holds the ID of an empty string ("").

Parameters:

Name
Type
Description

dimension

string

The ID of the dimension to be deleted.

Example:

Delete a dimension, from the origin chunk of that dimension.

-- init.lua
function init()
    if not chunk.Generated then
        if chunk.X == 0 and chunk.Y == 0 then
        
            if chunk.Dimension == "Catland" then
                print("This chunk is in "..chunk.Dimension.." which will be deleted.")
                api.dimension.Delete("Catland")
            else
                api.dimension.Create("Catland")
            end
            
        end
    end
end

-- When the chunk at the origin of a dimension loads for the first time,
-- create a dimension called Catland.
-- When the chunk at the origin of Catland loads for the first time,
-- print a message, then delete the dimension.

-- Prints:
-- This chunk is in Catland which will be deleted.

PreviousCreateNextList

Last updated 3 months ago