Server

Server

Server Only

This class is only available on server

Methods

integer[] GetClients()

table? GetAssetSyncStatus(integer clientID)

Server-to-client asset sync state of a client (Dev Tools' Assets Sync window): { helloAnswered = boolean, assets = { {id, path, source, type, size, state, highPrio, position, progress, age}, ... } }. state is 'queued' (position = place in the send queue), 'sending' (progress 0..1), 'sent', 'registered' (the client confirmed registering it) or 'up to date' (offered at connect, the client already had it); age = seconds since a sent asset finished. nil for an unknown client.

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.

integer GetLuaResetsSkipped()

How many times a saved .lua change skipped the Lua reset because no changed script had run in the current Lua state.

integer GetSceneLoadCount()

How many scene loads this server has started: 1 after the boot load, plus one per Server:OpenScene, New Scene or scene reload. A script's Start runs again after both a scene load and a .lua hot reload; compare this with a value kept in Config temp storage to tell them apart.

number GetLuaResetSkippedAt()

Time.appTime of the last skipped Lua reset (0 when none).

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

Asset MakePrefab(Object fromObject)

boolean UpdatePrefab(Object obj)

table GetInsertPrefabStats()

nil PreloadVDRsForPrefab(Asset prefab, 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 AutoSaveScene()

boolean IsHierarchyDirty()

string ReportHierarchyDirty()

boolean SaveSceneAs(string name)

boolean SaveSceneAsFileExists(string name)

boolean SaveToPlayScene(boolean enterSession)

boolean NewScene(string name, Asset? terrain)

boolean OpenScene(Asset sceneAsset)

boolean DeleteMontageAsset(Asset asset)

Asset GetCurrentScene()

nil ReloadScene()

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

nil ResizeTerrain(integer potDelta)

nil ResetSceneToInitState(boolean? reloadTerrain)

nil BackupMontage()

integer GetMemoryUsage()

integer? GetMemoryLimit()

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)

nil TrackAnalytics(string name, table properties, integer? clientID)

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