World
Getters
string: world:getname
world:getname()
Returns the worlds's name.
boolean: world:getspawn
world:getspawn()
world:getspawn(Vector: position, Angle: rotation)
Returns or writes the world's spawn into position and rotation.
int: world:getoffset
world:getoffset(Short Vector: ShortVector)
Return's the 1D location of the block at ShortVector.
Equation: (((ShortVector.y) * World.Length + (ShortVector.z)) * World.Width + (ShortVector.x))
boolean: world:getdimensions
Short Vector: world:getdimensions
world:getdimensions(Vector: dimensions)
world:getdimensions()
Returns or writes the world's dimensions into dimensions.
int: world:getblock
world:getblock(Vector: pos)
Returns the block at pos.
boolean: world:getenvcolor
Color3: world:getenvcolor
world:getenvcolor(EColor: colorType, Color3: color)
world:getenvcolor(EColor: colorType)
Returns or writes the world's colorType into color.
| Index | Name |
|---|---|
| 0 | WORLD_COLOR_SKY |
| 1 | WORLD_COLOR_CLOUD |
| 2 | WORLD_COLOR_FOG |
| 3 | WORLD_COLOR_AMBIENT |
| 4 | WORLD_COLOR_DIFFUSE |
int: world:getenvprop
world:getenvprop(EProp: property)
Returns the value of a world's EnvProp.
| Index | Name |
|---|---|
| 0 | WORLD_PROP_SIDEBLOCK |
| 1 | WORLD_PROP_EDGEBLOCK |
| 2 | WORLD_PROP_EDGELEVEL |
| 3 | WORLD_PROP_CLOUDSLEVEL |
| 4 | WORLD_PROP_FOGDIST |
| 5 | WORLD_PROP_SPDCLOUDS |
| 6 | WORLD_PROP_SPDWEATHER |
| 7 | WORLD_PROP_FADEWEATHER |
| 8 | WORLD_PROP_EXPFOG |
| 9 | WORLD_PROP_SIDEOFFSET |
int world:getweather
world:getweather()
Returns the world's weather.
| Index | Name |
|---|---|
| 0 | WORLD_WEATHER_SUN |
| 1 | WORLD_WEATHER_RAIN |
| 2 | WORLD_WEATHER_SNOW |
string: world:gettexpack
world:gettexpack()
Returns the world's texture pack.
lightuserdata, int: world:getaddr
world:getaddr()
Returns the world's block array and its size. This function can be used to directly access an block array via LuaJIT's ffi.
int: world:getseed
world:getseed()
Returns the world's seed.
int: world:getplayercount
world:getplayercount()
Returns the world's playercount.
bool world:isready
world:isready()
Returns whether or not is world is ready to be played on.
bool world:isinmemory
world:isinmemory()
Returns whether or not is world is "inmemory". If true, :load() and :save() calls will be ignored
bool world:ismodified
world:ismodified()
Returns whether or not the world has been modified since loading.
boolean: world:haserror
world:haserror()
Retruns whether or not the world has encountered an error.
EWorldError, EWorldExtra: world:poperror
world:poperror()
Retruns more information about the error the world has encountered.
EWorldError:
| Index | Description |
|---|---|
| 0 | WORLD_ERROR_SUCCESS |
| 1 | WORLD_ERROR_IOFAIL |
| 2 | WORLD_ERROR_COMPR |
| 3 | WORLD_ERROR_INFOREAD |
| 4 | WORLD_ERROR_DATAREAD |
| 5 | WORLD_ERROR_INMEMORY |
EWorldExtra:
| Index | Description |
|---|---|
| 0 | WORLD_EXTRA_NOINFO |
| 1 | WORLD_EXTRA_UNKNOWN_DATA_TYPE |
| 2 | WORLD_EXTRA_IO_OPEN |
| 3 | WORLD_EXTRA_IO_WRITE |
| 4 | WORLD_EXTRA_IO_RENAME |
| 5 | WORLD_EXTRA_COMPR_INIT |
| 6 | WORLD_EXTRA_COMPR_PROC |
Setters
world:setspawn
world:setspawn(Vector: pos, Angle: rot)
Sets the world's spawn.
world:setblock
world:setblock(Short Vector: pos, int: blockId)
Sets a block in the world.
Warning
This only sets the block server-side.
Use setblocknat to set and network the new block.
world:setblocknat
world:setblocknat(Short Vector: pos, int: blockId)
Sets a block in the world and networks it.
world:setenvcolor
world:setenvcolor(EColor: colorType, Color3: color)
Sets a world's env color. For more information, please look at CPE EnvSetColor
| Index | Name |
|---|---|
| 0 | WORLD_COLOR_SKY |
| 1 | WORLD_COLOR_CLOUD |
| 2 | WORLD_COLOR_FOG |
| 3 | WORLD_COLOR_AMBIENT |
| 4 | WORLD_COLOR_DIFFUSE |
world:setenvprop
world:setenvprop(EProp: property, int: value)
Sets a world's EnvProp. For more information, please look at CPE SetMapEnvProp
| Index | Name |
|---|---|
| 0 | WORLD_PROP_SIDEBLOCK |
| 1 | WORLD_PROP_EDGEBLOCK |
| 2 | WORLD_PROP_EDGELEVEL |
| 3 | WORLD_PROP_CLOUDSLEVEL |
| 4 | WORLD_PROP_FOGDIST |
| 5 | WORLD_PROP_SPDCLOUDS |
| 6 | WORLD_PROP_SPDWEATHER |
| 7 | WORLD_PROP_FADEWEATHER |
| 8 | WORLD_PROP_EXPFOG |
| 9 | WORLD_PROP_SIDEOFFSET |
world:setweather
world:setweather(EWeather: weather)
Sets the world's weather.
| Index | Name |
|---|---|
| 0 | WORLD_WEATHER_SUN |
| 1 | WORLD_WEATHER_RAIN |
| 2 | WORLD_WEATHER_SNOW |
world:settexpack
world:settexpack(string: texPackLink)
Sets the world's default texture pack.
world:setinmemory
world:setinmemory(boolean: inMemory)
Sets the world's "inmemory" flag. If true, :load() and :save() calls will be ignored
world:setignoremod
world:setignoremod(boolean: ignoreMod)
If true, prevents the WORLD_FLAG_MODIFIED flag from being set. This means that :save() calls will be ignored.
Functions
boolean: world:update
world:update()
Updates the world for every client playing on it.
world:generate
world:generate(string: generatorName)
world:generate(string: generatorName, int seed)
(Re)generates the world.
world:iterplayers
world:iterplayers(func: ITERATE_FUNCTION(Client client))
Iterates through the clients of a world, passing them to ITERATE_FUNCTION
world:remove
world:remove()
Removes the world from the worlds list.
world:unload
world:unload()
Unloads the world from memory.
world:save
world:save()
Saves the world to disk.
world:load
world:load()
Loads the world disk.