Skip to main content

Client

Client

Client Only

This class is only available on client

Methods​

integer GetID()​

Guid GetUserID()​

string UIItemUpdate(integer actionID, UIItem item, userdata value)​

nil OpenKeyboardShortcutInput(string keyActionID)​

nil ToggleUICreatorWindow()​

nil ToggleUIVisibility()​

nil ToggleMainMenuVisibility()​

nil SetToClientUI()​

nil SetShowWindows(boolean)​

boolean GetShowWindows()​

boolean GetUICapturesMouseOrKeyboard()​

boolean GetUICapturesMouse()​

boolean GetUICapturesKeyboard()​

boolean GetUICapturesTextInput()​

boolean GetUIIsInEditMode()​

nil OpenUIWindow(string windowID)​

nil CloseUIWindow(string windowID)​

nil SetUIWindowOpen(string windowID, boolean open)​

nil ToggleUIWindow(string windowID)​

boolean IsWindowOpen(string windowID)​

nil SetWindowPos(string windowID, Vec2 position)​

nil OpenUI()​

nil CloseUI()​

boolean IsUIOpen()​

nil SetUIPose(Quat, Vec3)​

Quat, Vec3 GetUIPose()​

nil OpenScriptFile(string)​

nil OpenScriptFile(string, integer)​

string GetScript(string)​

nil SetUIScale(number scale)​

number GetUIScale()​

boolean GetUIScaleAuto()​

nil SetUIScaleAuto(boolean autoScale)​

string GetUILayout()​

string GetMontageURL()​

string GetMontageURLBase()​

userdata GetMontageURLParameters()​

string GetMontageURLParametersRaw()​

string GetMontageURLWithParameters(userdata)​

nil CancelLoadMontageByURL()​

nil ConnectToMontage(string)​

string GetConnectionStatus()​

Unknown, Connecting, FailedToConnect, StatusMessage, ReadyToAcknowledge, Connected, Disconnected

string GetConnectionStatusDetailed()​

nil Disconnect()​

number GetPing()​

Time for a network message to travel from client to server and back

number GetLogValue(string)​

number GetLogValue(string, number)​

nil SetLogValue(string, number)​

nil SetStrLogValue(string, string)​

number GetLogIValue(integer)​

string GetLogIValueName(integer)​

string GetLogIValueOutputName(integer)​

boolean GetLogIsValue(integer)​

integer GetLogValuesCount()​

userdata GetLogValueForPlot(string)​

nil ResetTracy()​

string GetLogStrValue(string)​

string GetLogStrIValue(integer)​

string GetLogStrIValueName(integer)​

string GetLogStrIValueOutputName(integer)​

boolean GetLogStrIsValue(integer)​

integer GetLogStrValuesCount()​

number GetLogTime(string)​

table GetLogTimers(string)​

table GetMainDispatcherStats()​

number GetFPS()​

Config GetConfigInputActions()​

nil ConnectToServer()​

nil Disconnect(string)​

boolean OpenFolder(string folder)​

integer GetScriptsVersion()​

integer GetLoadedScriptsVersion()​

nil LuaOpenDebugger()​

nil LuaEnableDebugging(boolean enable)​

nil OnLuaLog()​

nil ScrollToLastestLuaLog()​

boolean IsContainerEnabledAndVisible(UIItem uiItem)​

nil Log(string)​

boolean IsClient()​

boolean IsServer()​

boolean DevMode()​

boolean GetNetworkThrottlingNow()​

nil SelectItemInUICreator(UIItem uiItem)​

UIItem GetUIItemByUIActionID(integer uiActionID)​

string GetUIActionType(integer uiActionID)​

string GetUIActionScript(integer uiActionID)​

integer GetCurrentUIActionID()​

nil SetIntersectionTint(Vec4)​

nil SetIntersectionBox(Vec3, Quat, Vec3)​

nil SetIntersectionSphere(Vec3, number)​

nil WriteToScreen(string, Vec2, Vec2, Vec4, integer, Vec4, number)​

nil WriteToScreen(string, Vec2, Vec2, Vec4, integer)​

nil WriteToScreen(string, Vec2, Vec2, Vec4, integer, Vec4)​

nil CloseApp()​

string GetEULA()​

Vec2 GetWindowSize()​

Vec2 GetViewportSize()​

CommandLine GetCommandLine()​

Returns CommandLine

Vec4 GetBGColor()​

nil SetBGColor(Vec4)​

boolean GetVREnabled()​

nil SetVREnabled(boolean, string)​

nil ToggleVREnabled(string)​

Vec3, Quat GetVREyeTransform(integer, Space)​

Vec3, Quat GetVRHeadsetTransform(Space)​

nil ApplyVRHapticFeedback(integer, number, number, number)​

boolean GetVREyeTrackingSupported()​

number SetVRUserScale(number)​

number GetVRUserScale()​

number GetVRUserScaleMin()​

number GetVRUserScaleMax()​

nil StartVRPassthrough()​

nil StopVRPassthrough()​

boolean IsVRPassthroughEnabled()​

boolean IsVRPassthroughSupported()​

boolean SendFile(File)​

boolean SendFiles(table)​

boolean IsUploadingFiles()​

boolean IsDownloadingFiles()​

nil Restart()​

nil ChooseImage()​

nil TriggerCrash()​

nil TriggerException()​

nil TriggerCriticalError()​

AssetManager GetResourceManScene()​

nil ToggleChannelRendering()​

integer GetRenderChannelsCount()​

number GetRenderChannelOpacity(integer)​

nil SetRenderChannelOpacity(integer, number)​

nil LoadEntityPath()​

nil SaveEntityPath()​

nil PlayEntityPath()​

nil ClearEntityPath()​

nil AddEntityPathWaypoint()​

nil TakeScreenshot(string, boolean)​

table GetVersion()​

System GetSystem()​

Device GetDevice()​

integer GetMemoryUsage()​

string GetCredits()​

string GetSystemConsole()​

string GetSystemOutput()​

table GetErrors()​

string GetDateTime()​

string GetLastSyncMessageRecv()​

string GetLastSyncMessageSent()​

boolean GetUpdateSyncMessageString()​

nil SetUpdateSyncMessageString(boolean)​

nil CopyToClipboard(string)​

string GetClipboardText()​

may not work on all platforms

nil OpenBrowserWithURL(string)​

nil ReloadPage(boolean)​

Metamethods​

string __tostring()​

table EnumerateTestRenderObjects()​

boolean IsTestRenderObjectEnabled(string)​

boolean SetTestRenderObjectEnabled(string, boolean)​

boolean ToggleTestRenderObjectEnabled(string)​

nil ResetPlayerLODPriorityBubble()​

nil AddPlayerLODPriorityBubbleShape(Vec3, Vec3, number, Vec3, number)​

LODs in this bubble are prioritized, should be placed around the player or camera params: capsuleStart, capsuleEnd, capsuleRadius, velocity, size

nil SetScreenColor(Vec4)​

nil SetScreenColor(Vec4, boolean)​

Tint the view for this frame or permanently

AudioSource PlaySound(string)​

AudioSource PlaySound(string, Vec3, number, boolean)​

Play sound with asset name, at position, with volume and loop. Only single channel audio. Returns AudioSource

AudioSource PlaySound(string, Vec3, number)​

AudioSource PlaySound(string, Vec3)​

AudioMusic PlayMusic(string)​

AudioMusic PlayMusic(string, number, boolean)​

Play sound with asset name, with volume and loop. This play stereo music without any position just like normal audio player. Returns AudioMusic

nil PauseAudio()​

Pause all playing sounds and music

nil ResumeAudio()​

Resume all paused sounds and music

nil StopAudio()​

Properties​

integer clientID​

Guid userID​

ClientMode mode​

boolean isMaker​

boolean EditMode​

string platform​

string sysInfo​

number MasterVolume​

Audio volume in range 0 - 1.

number SoundVolume​

Audio volume in range 0 - 1.

number MusicVolume​

Audio volume in range 0 - 1.