Server

Server

Server Only

This class is only available on server

Methods

boolean IsInitMode()

True while the server is in Init mode (editing); false in Live mode (play).

nil EnterInitMode(boolean? reloadGeom)

Switch the server into Init mode (editing). If reloadGeom is true, voxel geometry is reloaded on the mode change.

nil EnterLiveMode(boolean? reloadGeom)

Switch the server into Live mode (play). If reloadGeom is true, voxel geometry is reloaded on the mode change.

integer[] GetClients()

boolean IsVRClient(integer clientID)

nil DisconnectClient(integer clientID)

nil LuaReset()

Re-runs all server Lua scripts from scratch. The entire Lua state is wiped — no tables, globals, or per-script self data survive — then every script reloads. Does not reload scene geometry.

Object InsertPrefab(Asset prefab, string? newName, boolean? setSave)

Asset MakePrefab(Object fromObject)

boolean UpdatePrefab(Object obj)

table GetInsertPrefabStats()

nil PreloadVDRsForPrefab(string name, integer count)

nil SaveScene()

Saves the whole scene to disk, including voxel geometry.

nil SaveSceneHierarchy()

Saves the object hierarchy and scripts only, without voxel geometry (much faster than SaveScene).

nil ReloadScene()

Full scene reload — reloads geometry and re-runs scripts. Heavier than LuaReset.

nil ResetSceneToInitState(boolean? reloadTerrain)

nil BackupMontage()

integer GetMemoryUsage()

table GetErrors()

integer GetMaxConnections()

nil HttpPost(string url, table headers, string data, fun(success:boolean, response:string, statusCode:integer) onResponse)

nil HttpGet(string url, table headers, fun(success:boolean, response:string, statusCode:integer) onResponse)

nil HttpDownload(string url, table headers, string destPathInMontage, fun(success:boolean, response:string, statusCode:integer, asset:Asset?) onResponse)

integer GetPing(integer clientID)

integer GetSceneSendQueueMax()

nil MakeUrlForAsset(Asset asset, fun(progress:number) eventUpdate, fun(success:boolean, url:string) eventFinish)

string CaptureObjectThumbnail(Object target, table? opts)

string MakeThumbnailForAsset(Asset asset, table? opts)

table GetStreamingStats()

table GetVolumeDbInfo()

table GetVolumeDbStats()

table GetMainDispatcherStats()

integer GetCollectionPreferredLoad(number collectionId)

nil SetCollectionPreferredLoad(number collectionId, integer preferredLoad)

nil GenTestVoxelScene()

nil GenTestVoxelScene2()

nil GenTestVoxelScene3()

nil MakeVoxelScene(integer maxZ, integer maxY, integer maxX, integer patternSize)

nil RebuildLODsBrightnessMethod(Vec3i? minPos, Vec3i? maxPos)

boolean RebuildLODsGradientMethod(Vec3i? minPos, Vec3i? maxPos)

boolean ShowAllNormalsPerVoxel(integer lodI)

boolean ShowAllNormalsPerBT(integer lodI)

nil PBRTranscodeToPBR0Ver1()

Properties

integer clientID

ServerSceneSettings settings