Stats

Description

Supported Script Types: Interface Scripts • Client Entity Scripts • Avatar Scripts • Server Entity Scripts • Assignment Client Scripts

The Stats API provides statistics on Interface and domain operation, per the statistics overlay.

Note: This API is primarily an internal diagnostics tool and is provided "as is".

Properties

Name Type Summary
expanded boolean

true if the statistics overlay should be in expanded form when the overlay is displayed, false if it shouldn't be expanded.

timingExpanded boolean

true if timing details should be displayed when the statistics overlay is displayed in expanded form, false if timing details should not be displayed. Set by the menu item, Developer > Timing > Performance Timer > Display Timing Details. Read-only.

monospaceFont string

The name of the monospace font used in the statistics overlay. Read-only.

serverCount number

The number of servers that Interface is connected to. Read-only.

renderrate number

The rate at which new GPU frames are being created, in Hz. Read-only.

presentrate number

The rate at which the display plugin is presenting to the display device, in Hz. Read-only.

stutterrate number

The rate at which the display plugin is reprojecting old GPU frames, in Hz. Read-only.

appdropped number

The number of times a frame has not been provided to the display device in time. Read-only.

longsubmits number

The number of times the display device has taken longer than 11ms to return after being given a frame. Read-only.

longrenders number

The number of times it has taken longer than 11ms to submit a new frame to the display device. Read-only.

longframes number

The number of times longsubmits + longrenders has taken longer than 15ms. Read-only.

presentnewrate number

The rate at which the display plugin is presenting new GPU frames, in Hz. Read-only.

presentdroprate number

The rate at which the display plugin is dropping GPU frames, in Hz. Read-only.

gameLoopRate number

The rate at which the game loop is running, in Hz. Read-only.

refreshRateTarget number

The current target refresh rate, in Hz, per the current refreshRateMode and refreshRateRegime if in desktop mode; a higher rate if in VR mode. Read-only.

refreshRateMode RefreshRateProfileName

The current refresh rate profile. Read-only.

refreshRateRegime RefreshRateRegimeName

The current refresh rate regime. Read-only.

uxMode UXModeName

The user experience (UX) mode that Interface is running in. Read-only.

avatarCount number

The number of avatars in the domain other than the client's. Read-only.

heroAvatarCount number

The number avatars in a "hero" zone in the domain, other than the client's. Read-only.

physicsObjectCount number

The number of objects that have collisions enabled. Read-only.

updatedAvatarCount number

The number of avatars in the domain, other than the client's, that were updated in the most recent game loop. Read-only.

updatedHeroAvatarCount number

The number of avatars in a "hero" zone in the domain, other than the client's, that were updated in the most recent game loop. Read-only.

notUpdatedAvatarCount number

The number of avatars in the domain, other than the client's, that weren't able to be updated in the most recent game loop because there wasn't enough time to. Read-only.

packetInCount number

The number of packets being received from the domain server, in packets per second. Read-only.

packetOutCount number

The number of packets being sent to the domain server, in packets per second. Read-only.

mbpsIn number

The amount of data being received from the domain server, in megabits per second. Read-only.

mbpsOut number

The amount of data being sent to the domain server, in megabits per second. Read-only.

assetMbpsIn number

The amount of data being received from the asset server, in megabits per second. 0.0 if not connected to an avatar mixer. Read-only.

assetMbpsOut number

The amount of data being sent to the asset server, in megabits per second. 0.0 if not connected to an avatar mixer. Read-only.

audioPing number

The ping time to the audio mixer, in ms. -1 if not connected to an audio mixer. Read-only.

avatarPing number

The ping time to the avatar mixer, in ms. -1 if not connected to an avatar mixer. Read-only.

entitiesPing number

The average ping time to the entity servers, in ms. -1 if not connected to an entity server. Read-only.

assetPing number

The ping time to the asset server, in ms. -1 if not connected to an asset server. Read-only.

messagePing number

The ping time to the message mixer, in ms. -1 if not connected to a message mixer. Read-only.

position Vec3

The position of the user's avatar. Read-only.

Note: Property not available in the API.

speed number

The speed of the user's avatar, in m/s. Read-only.

yaw number

The yaw of the user's avatar body, in degrees. Read-only.

avatarMixerInKbps number

The amount of data being received from the avatar mixer, in kilobits per second. -1 if not connected to an avatar mixer. Read-only.

avatarMixerInPps number

The number of packets being received from the avatar mixer, in packets per second. -1 if not connected to an avatar mixer. Read-only.

avatarMixerOutKbps number

The amount of data being sent to the avatar mixer, in kilobits per second. -1 if not connected to an avatar mixer. Read-only.

avatarMixerOutPps number

The number of packets being sent to the avatar mixer, in packets per second. -1 if not connected to an avatar mixer. Read-only.

myAvatarSendRate number

The number of avatar packets being sent by the user's avatar, in packets per second. Read-only.

audioMixerInKbps number

The amount of data being received from the audio mixer, in kilobits per second. -1 if not connected to an audio mixer. Read-only.

audioMixerInPps number

The number of packets being received from the audio mixer, in packets per second. -1 if not connected to an audio mixer. Read-only.

audioMixerOutKbps number

The amount of data being sent to the audio mixer, in kilobits per second. -1 if not connected to an audio mixer. Read-only.

audioMixerOutPps number

The number of packets being sent to the audio mixer, in packets per second. -1 if not connected to an audio mixer. Read-only.

audioMixerKbps number

The total amount of data being sent to and received from the audio mixer, in kilobits per second. -1 if not connected to an audio mixer. Read-only.

audioMixerPps number

The total number of packets being sent to and received from the audio mixer, in packets per second. -1 if not connected to an audio mixer. Read-only.

audioOutboundPPS number

The number of non-silent audio packets being sent by the user, in packets per second. -1 if not connected to an audio mixer. Read-only.

audioSilentOutboundPPS number

The number of silent audio packets being sent by the user, in packets per second. -1 if not connected to an audio mixer. Read-only.

audioInboundPPS number

The number of non-silent audio packets being received by the user, in packets per second. -1 if not connected to an audio mixer. Read-only.

audioAudioInboundPPS number

The number of non-silent audio packets being received by the user, in packets per second. -1 if not connected to an audio mixer. Read-only.

Deprecated: This property is deprecated and will be removed. Use audioInboundPPS instead.

audioSilentInboundPPS number

The number of silent audio packets being received by the user, in packets per second. -1 if not connected to an audio mixer. Read-only.

audioPacketLoss number

The number of audio packets being lost, sent to or received from the audio mixer, in %. -1 if not connected to an audio mixer. Read-only.

audioCodec string

The name of the audio codec. Read-only.

audioNoiseGate string

The status of the audio noise gate: "Open" or "Closed". Read-only.

audioInjectors Vec2

The number of audio injectors, local and non-local. Read-only.

Note: Property not available in the API.

entityPacketsInKbps number

The average amount of data being received from entity servers, in kilobits per second. (Multiply by the number of entity servers to get the total amount of data being received.) -1 if not connected to an entity server. Read-only.

downloads number

The number of downloads in progress. Read-only.

downloadLimit number

The maximum number of concurrent downloads. Read-only.

downloadsPending number

The number of downloads pending. Read-only.

downloadUrls Array.<string>

The download URLs. Read-only.

Note: Property not available in the API.

processing number

The number of completed downloads being processed. Read-only.

processingPending number

The number of completed downloads waiting to be processed. Read-only.

triangles number

The number of triangles in the rendered scene. Read-only.

drawcalls number

The number of draw calls made for the rendered scene. Read-only.

materialSwitches number

The number of material switches performed for the rendered scene. Read-only.

itemConsidered number

The number of item considerations made for rendering. Read-only.

itemOutOfView number

The number of items out of view. Read-only.

itemTooSmall number

The number of items too small to render. Read-only.

itemRendered number

The number of items rendered. Read-only.

shadowConsidered number

The number of shadow considerations made for rendering. Read-only.

shadowOutOfView number

The number of shadows out of view. Read-only.

shadowTooSmall number

The number of shadows too small to render. Read-only.

shadowRendered number

The number of shadows rendered. Read-only.

sendingMode string

Description of the octree sending mode. Read-only.

packetStats string

Description of the octree packet processing state. Read-only.

lodAngle number

The target LOD angle, in degrees. Read-only.

lodTargetFramerate number

The target LOD frame rate, in Hz. Read-only.

lodStatus string

Description of the current LOD. Read-only.

numEntityUpdates string

The number of entity updates that happened last frame. Read-only.

numNeededEntityUpdates string

The total number of entity updates scheduled for last frame. Read-only.

timingStats string

Details of the average time (ms) spent in and number of calls made to different parts of the code. Provided only if timingExpanded is true. Only the top 10 items are provided if Developer > Timing > Performance Timer > Only Display Top 10 is enabled. Read-only.

gameUpdateStats string

Details of the average time (ms) spent in different parts of the game loop. Read-only.

serverElements number

The total number of elements in the server octree. Read-only.

serverInternal number

The number of internal elements in the server octree. Read-only.

serverLeaves number

The number of leaf elements in the server octree. Read-only.

localElements number

The total number of elements in the client octree. Read-only.

localInternal number

The number of internal elements in the client octree. Read-only.

localLeaves number

The number of leaf elements in the client octree. Read-only.

rectifiedTextureCount number

The number of textures that have been resized so that their dimensions is a power of 2 if smaller than 128 pixels, or a multiple of 128 if greater than 128 pixels. Read-only.

decimatedTextureCount number

The number of textures that have been reduced in size because they were over the maximum allowed dimensions of 4096 pixels on desktop or 2048 pixels on mobile. Read-only.

gpuBuffers number

The number of OpenGL buffer objects managed by the GPU back-end. Read-only.

gpuBufferMemory number

The total memory size of the gpuBuffers, in MB. Read-only.

gpuTextures number

The number of OpenGL textures managed by the GPU back-end. This is the sum of the number of textures managed for gpuTextureResidentMemory, gpuTextureResourceMemory, and gpuTextureFramebufferMemory. Read-only.

gpuTextureMemory number

The total memory size of the gpuTextures, in MB. This is the sum of gpuTextureResidentMemory, gpuTextureResourceMemory, and gpuTextureFramebufferMemory. Read-only.

glContextSwapchainMemory number

The estimated memory used by the default OpenGL frame buffer, in MB. Read-only.

qmlTextureMemory number

The memory size of textures managed by the offscreen QML surface, in MB. Read-only.

texturePendingTransfers number

The memory size of textures pending transfer to the GPU, in MB. Read-only.

gpuTextureResidentMemory number

The memory size of the "strict" textures that always have their full resolution in GPU memory, in MB. Read-only.

gpuTextureFramebufferMemory number

The memory size of the frame buffer on the GPU, in MB. Read-only.

gpuTextureResourceMemory number

The amount of GPU memory that has been allocated for "variable" textures that don't necessarily always have their full resolution in GPU memory, in MB. Read-only.

gpuTextureResourceIdealMemory number

The amount of memory that "variable" textures would take up if they were all completely loaded, in MB. Read-only.

gpuTextureResourcePopulatedMemory number

How much of the GPU memory allocated has actually been populated, in MB. Read-only.

gpuTextureMemoryPressureState string

The stats of the texture transfer engine.

  • "Undersubscribed": There is texture data that can fit in memory but that isn't on the GPU, so more GPU texture memory should be allocated if possible.
  • "Transfer": More GPU texture memory has been allocated and texture data is being transferred.
  • "Idle": Either all texture data has been transferred to the GPU or there is nor more space available.
Read-only.
gpuFreeMemory number

The amount of GPU memory available after all allocations, in MB. Read-only.

Note: This is not a reliable number because OpenGL doesn't have an official method of getting this information.

gpuTextureExternalMemory number

The estimated amount of memory consumed by textures being used but that are not managed by the GPU library, in MB. Read-only.

gpuFrameSize Vec2

The dimensions of the frames being rendered, in pixels. Read-only.

Note: Property not available in the API.

gpuFrameTime number

The time the GPU is spending on a frame, in ms. Read-only.

gpuFrameTimePerPixel number

The time the GPU is spending on a pixel, in ns. Read-only.

batchFrameTime number

The time being spent batch processing each frame, in ms. Read-only.

engineFrameTime number

The time being spent in the render engine each frame, in ms. Read-only.

avatarSimulationTime number

The time being spent simulating avatars each frame, in ms. Read-only.

stylusPicksCount number

The number of stylus picks currently in effect. Read-only.

rayPicksCount number

The number of ray picks currently in effect. Read-only.

parabolaPicksCount number

The number of parabola picks currently in effect. Read-only.

collisionPicksCount number

The number of collision picks currently in effect. Read-only.

stylusPicksUpdated Vec3

The number of stylus pick intersection that were found in the most recent game loop:

  • x = entity intersections.
  • y = avatar intersections.
  • z = HUD intersections.
Read-only.

Note: Property not available in the API.

rayPicksUpdated Vec3

The number of ray pick intersections that were found in the most recent game loop:

  • x = entity intersections.
  • y = avatar intersections.
  • z = HUD intersections.
Read-only.

Note: Property not available in the API.

parabolaPicksUpdated Vec3

The number of parabola pick intersections that were found in the most recent game loop:

  • x = entity intersections.
  • y = avatar intersections.
  • z = HUD intersections.
Read-only.

Note: Property not available in the API.

collisionPicksUpdated Vec3

The number of collision pick intersections that were found in the most recent game loop:

  • x = entity intersections.
  • y = avatar intersections.
  • z = HUD intersections.
Read-only.

Note: Property not available in the API.

eventQueueDebuggingOn boolean

true if event queue statistics are provided, false if they're not. Read-only.

mainThreadQueueDepth number

The number of events in the main thread's event queue. Only provided if eventQueueDebuggingOn is true. Read-only.

nodeListThreadQueueDepth number

The number of events in the node list thread's event queue. Only provided if eventQueueDebuggingOn is true. Read-only.

bgColor string

Read-only.

Deprecated: This property is deprecated and will be removed.

activeFocus boolean

Read-only.

Deprecated: This property is deprecated and will be removed.

activeFocusOnTab boolean

Deprecated: This property is deprecated and will be removed.

anchors object

Read-only.

Deprecated: This property is deprecated and will be removed.

antialiasing boolean

Deprecated: This property is deprecated and will be removed.

baselineOffset number

Deprecated: This property is deprecated and will be removed.

children Array.<object>

Read-only.

Note: Property not available in the API.

Deprecated: This property is deprecated and will be removed.

clip boolean

Deprecated: This property is deprecated and will be removed.

containmentMask object

Deprecated: This property is deprecated and will be removed.

enabled boolean

Deprecated: This property is deprecated and will be removed.

focus boolean

Deprecated: This property is deprecated and will be removed.

height number

Deprecated: This property is deprecated and will be removed.

implicitHeight number

Deprecated: This property is deprecated and will be removed.

implicitWidth number

Deprecated: This property is deprecated and will be removed.

layer object

Read-only.

Deprecated: This property is deprecated and will be removed.

opacity number

Deprecated: This property is deprecated and will be removed.

rotation number

Deprecated: This property is deprecated and will be removed.

scale number

Deprecated: This property is deprecated and will be removed.

smooth boolean

Deprecated: This property is deprecated and will be removed.

state string

Deprecated: This property is deprecated and will be removed.

transformOrigin number

Deprecated: This property is deprecated and will be removed.

visible boolean

Deprecated: This property is deprecated and will be removed.

width number

Deprecated: This property is deprecated and will be removed.

x number

Deprecated: This property is deprecated and will be removed.

y number

Deprecated: This property is deprecated and will be removed.

z number

Deprecated: This property is deprecated and will be removed.

Methods

Name Return Value Summary
childAt object

Deprecated: This method is deprecated and will be removed.

contains boolean

Deprecated: This method is deprecated and will be removed.

forceActiveFocus None

Deprecated: This method is deprecated and will be removed.

forceUpdateStats None

Updates statistics to make current values available to scripts even though the statistics overlay may not be displayed. (Many statistics values are normally updated only if the statistics overlay is displayed.)

Note: Not all statistics values are updated when the statistics overlay isn't displayed or expanded.

grabToImage boolean

Deprecated: This method is deprecated and will be removed.

mapFromGlobal None

Deprecated: This method is deprecated and will be removed.

mapFromItem None

Deprecated: This method is deprecated and will be removed.

mapToGlobal None

Deprecated: This method is deprecated and will be removed.

mapToItem None

Deprecated: This method is deprecated and will be removed.

nextItemInFocusChain object

Deprecated: This method is deprecated and will be removed.

update None

Deprecated: This method is deprecated and will be removed.

Signals

Name Summary
activeFocusChanged

Triggered when the value of the activeFocus property changes.

Deprecated: This signal is deprecated and will be removed.

activeFocusOnTabChanged

Triggered when the value of the activeFocusOnTab property changes.

Deprecated: This signal is deprecated and will be removed.

antialiasingChanged

Triggered when the value of the antialiasing property changes.

Deprecated: This signal is deprecated and will be removed.

appdroppedChanged

Triggered when the value of the appdropped property changes.

assetMbpsInChanged

Triggered when the value of the assetMbpsIn property changes.

assetMbpsOutChanged

Triggered when the value of the assetMbpsOut property changes.

assetPingChanged

Triggered when the value of the assetPing property changes.

audioAudioInboundPPSChanged

Triggered when the value of the audioAudioInboundPPS property changes.

Deprecated: This signal is deprecated and will be removed. Use audioInboundPPSChanged instead.

audioCodecChanged

Triggered when the value of the audioCodec property changes.

audioInboundPPSChanged

Triggered when the value of the audioInboundPPS property changes.

audioInjectorsChanged

Triggered when the value of the audioInjectors property changes.

audioMixerInKbpsChanged

Triggered when the value of the audioMixerInKbps property changes.

audioMixerInPpsChanged

Triggered when the value of the audioMixerInPps property changes.

audioMixerKbpsChanged

Triggered when the value of the audioMixerKbps property changes.

audioMixerOutKbpsChanged

Triggered when the value of the audioMixerOutKbps property changes.

audioMixerOutPpsChanged

Triggered when the value of the audioMixerOutPps property changes.

audioMixerPpsChanged

Triggered when the value of the audioMixerPps property changes.

audioNoiseGateChanged

Triggered when the value of the audioNoiseGate property changes.

audioOutboundPPSChanged

Triggered when the value of the audioOutboundPPS property changes.

audioPacketLossChanged

Triggered when the value of the audioPacketLoss property changes.

audioPingChanged

Triggered when the value of the audioPing property changes.

audioSilentInboundPPSChanged

Triggered when the value of the audioSilentInboundPPS property changes.

audioSilentOutboundPPSChanged

Triggered when the value of the audioSilentOutboundPPS property changes.

avatarCountChanged

Triggered when the value of the avatarCount property changes.

avatarMixerInKbpsChanged

Triggered when the value of the avatarMixerInKbps property changes.

avatarMixerInPpsChanged

Triggered when the value of the avatarMixerInPps property changes.

avatarMixerOutKbpsChanged

Triggered when the value of the avatarMixerOutKbps property changes.

avatarMixerOutPpsChanged

Triggered when the value of the avatarMixerOutPps property changes.

avatarPingChanged

Triggered when the value of the avatarPing property changes.

avatarSimulationTimeChanged

Triggered when the value of the avatarSimulationTime property changes.

baselineOffsetChanged

Triggered when the value of the baselineOffset property changes.

Deprecated: This signal is deprecated and will be removed.

batchFrameTimeChanged

Triggered when the value of the batchFrameTime property changes.

bgColorChanged

Triggered when the value of the bgColor property changes.

Deprecated: This signal is deprecated and will be removed.

childrenChanged

Triggered when the value of the children property changes.

Deprecated: This signal is deprecated and will be removed.

childrenRectChanged

Triggered when the position and size of the rectangle containing the children changes.

Deprecated: This signal is deprecated and will be removed.

clipChanged

Triggered when the value of the clip property changes.

Deprecated: This signal is deprecated and will be removed.

collisionPicksCountChanged

Triggered when the value of the collisionPicksCount property changes.

collisionPicksUpdatedChanged

Triggered when the value of the collisionPicksUpdated property changes.

containmentMaskChanged

Triggered when the value of the containmentMask property changes.

Deprecated: This signal is deprecated and will be removed.

decimatedTextureCountChanged

Triggered when the value of the decimatedTextureCount property changes.

downloadLimitChanged

Triggered when the value of the downloadLimit property changes.

downloadsChanged

Triggered when the value of the downloads property changes.

downloadsPendingChanged

Triggered when the value of the downloadsPending property changes.

downloadUrlsChanged

Triggered when the value of the downloadUrls property changes.

drawcallsChanged

Triggered when the value of the drawcalls property changes.

enabledChanged

Triggered when the value of the enabled property changes.

Deprecated: This signal is deprecated and will be removed.

engineFrameTimeChanged

Triggered when the value of the engineFrameTime property changes.

entitiesPingChanged

Triggered when the value of the entitiesPing property changes.

entityPacketsInKbpsChanged

Triggered when the value of the entityPacketsInKbps property changes.

eventQueueDebuggingOnChanged

Triggered when the value of the eventQueueDebuggingOn property changes.

expandedChanged

Triggered when the value of the expanded property changes.

focusChanged

Triggered when the value of the focus property changes.

Deprecated: This signal is deprecated and will be removed.

gameLoopRateChanged

Triggered when the value of the gameLoopRate property changes.

gameUpdateStatsChanged

Triggered when the value of the gameUpdateStats property changes.

glContextSwapchainMemoryChanged

Triggered when the value of the glContextSwapchainMemory property changes.

gpuBufferMemoryChanged

Triggered when the value of the gpuBufferMemory property changes.

gpuBuffersChanged

Triggered when the value of the gpuBuffers property changes.

gpuFrameSizeChanged

Triggered when the value of the gpuFrameSize property changes.

gpuFrameTimeChanged

Triggered when the value of the gpuFrameTime property changes.

gpuFrameTimePerPixelChanged

Triggered when the value of the gpuFrameTimePerPixel property changes.

gpuFreeMemoryChanged

Triggered when the value of the gpuFreeMemory property changes.

gpuTextureExternalMemoryChanged

Triggered when the value of the gpuTextureExternalMemory property changes.

gpuTextureFramebufferMemoryChanged

Triggered when the value of the gpuTextureFramebufferMemory property changes.

gpuTextureMemoryChanged

Triggered when the value of the gpuTextureMemory property changes.

gpuTextureMemoryPressureStateChanged

Triggered when the value of the gpuTextureMemoryPressureState property changes.

gpuTextureResidentMemoryChanged

Triggered when the value of the gpuTextureResidentMemory property changes.

gpuTextureResourceIdealMemoryChanged

Triggered when the value of the gpuTextureResourceIdealMemory property changes.

gpuTextureResourceMemoryChanged

Triggered when the value of the gpuTextureResourceMemory property changes.

gpuTextureResourcePopulatedMemoryChanged

Triggered when the value of the gpuTextureResourcePopulatedMemory property changes.

gpuTexturesChanged

Triggered when the value of the gpuTextures property changes.

heightChanged

Triggered when the value of the height property changes.

Deprecated: This signal is deprecated and will be removed.

heroAvatarCountChanged

Triggered when the value of the heroAvatarCount property changes.

implicitHeightChanged

Triggered when the value of the implicitHeight property changes.

Deprecated: This signal is deprecated and will be removed.

implicitWidthChanged

Triggered when the value of the implicitWidth property changes.

Deprecated: This signal is deprecated and will be removed.

itemConsideredChanged

Triggered when the value of the itemConsidered property changes.

itemOutOfViewChanged

Triggered when the value of the itemOutOfView property changes.

itemRenderedChanged

Triggered when the value of the itemRendered property changes.

itemTooSmallChanged

Triggered when the value of the itemTooSmall property changes.

localElementsChanged

Triggered when the value of the localElements property changes.

localInternalChanged

Triggered when the value of the localInternal property changes.

localLeavesChanged

Triggered when the value of the localLeaves property changes.

lodAngleChanged

Triggered when the value of the lodAngle property changes.

lodStatusChanged

Triggered when the value of the lodStatus property changes.

lodTargetFramerateChanged

Triggered when the value of the lodTargetFramerate property changes.

longframesChanged

Triggered when the value of the longframes property changes.

longrendersChanged

Triggered when the value of the longrenders property changes.

longsubmitsChanged

Triggered when the value of the longsubmits property changes.

mainThreadQueueDepthChanged

Triggered when the value of the mainThreadQueueDepth property changes.

materialSwitchesChanged

Triggered when the value of the materialSwitches property changes.

mbpsInChanged

Triggered when the value of the mbpsIn property changes.

mbpsOutChanged

Triggered when the value of the mbpsOut property changes.

messagePingChanged

Triggered when the value of the messagePing property changes.

myAvatarSendRateChanged

Triggered when the value of the myAvatarSendRate property changes.

nodeListThreadQueueDepth

Triggered when the value of the nodeListThreadQueueDepth property changes.

notUpdatedAvatarCountChanged

Triggered when the value of the notUpdatedAvatarCount property changes.

numEntityUpdatesChanged

Triggered when the value of the numEntityUpdates property changes.

numNeededEntityUpdatesChanged

Triggered when the value of the numNeededEntityUpdates property changes.

opacityChanged

Triggered when the value of the opacity property changes.

Deprecated: This signal is deprecated and will be removed.

packetInCountChanged

Triggered when the value of the packetInCount property changes.

packetOutCountChanged

Triggered when the value of the packetOutCount property changes.

packetStatsChanged

Triggered when the value of the packetStats property changes.

parabolaPicksCountChanged

Triggered when the value of the parabolaPicksCount property changes.

parabolaPicksUpdatedChanged

Triggered when the value of the parabolaPicksUpdated property changes.

parentChanged

Triggered when the parent item changes.

Deprecated: This signal is deprecated and will be removed.

physicsObjectCountChanged

Triggered when the value of the physicsObjectCount property changes.

positionChanged

Triggered when the value of the position property changes.

presentdroprateChanged

Triggered when the value of the presentdroprate property changes.

presentnewrateChanged

Triggered when the value of the presentnewrate property changes.

presentrateChanged

Triggered when the value of the presentrate property changes.

processingChanged

Triggered when the value of the processing property changes.

processingPendingChanged

Triggered when the value of the processingPending property changes.

qmlTextureMemoryChanged

Triggered when the value of the qmlTextureMemory property changes.

rayPicksCountChanged

Triggered when the value of the rayPicksCount property changes.

rayPicksUpdatedChanged

Triggered when the value of the rayPicksUpdated property changes.

rectifiedTextureCountChanged

Triggered when the value of the rectifiedTextureCount property changes.

refreshRateModeChanged

Triggered when the value of the refreshRateMode property changes.

refreshRateRegimeChanged

Triggered when the value of the refreshRateRegime property changes.

refreshRateTargetChanged

Triggered when the value of the refreshRateTarget property changes.

renderrateChanged

Triggered when the value of the renderrate property changes.

rotationChanged

Triggered when the value of the rotation property changes.

Deprecated: This signal is deprecated and will be removed.

scaleChanged

Triggered when the value of the scale property changes.

Deprecated: This signal is deprecated and will be removed.

sendingModeChanged

Triggered when the value of the sendingMode property changes.

serverCountChanged

Triggered when the value of the serverCount property changes.

serverElementsChanged

Triggered when the value of the serverElements property changes.

serverInternalChanged

Triggered when the value of the serverInternal property changes.

serverLeavesChanged

Triggered when the value of the serverLeaves property changes.

shadowConsideredChanged

Triggered when the value of the shadowConsidered property changes.

shadowOutOfViewChanged

Triggered when the value of the shadowOutOfView property changes.

shadowRenderedChanged

Triggered when the value of the shadowRendered property changes.

shadowTooSmallChanged

Triggered when the value of the shadowTooSmall property changes.

smoothChanged

Triggered when the value of the smooth property changes.

Deprecated: This signal is deprecated and will be removed.

speedChanged

Triggered when the value of the speed property changes.

stateChanged

Triggered when the value of the state property changes.

Deprecated: This signal is deprecated and will be removed.

stutterrateChanged

Triggered when the value of the stutterrate property changes.

stylusPicksCountChanged

Triggered when the value of the stylusPicksCount property changes.

stylusPicksUpdatedChanged

Triggered when the value of the stylusPicksUpdated property changes.

texturePendingTransfersChanged

Triggered when the value of the texturePendingTransfers property changes.

timingExpandedChanged

Triggered when the value of the timingExpanded property changes.

timingStatsChanged

Triggered when the value of the timingStats property changes.

transformOriginChanged

Triggered when the value of the transformOrigin property changes.

Deprecated: This signal is deprecated and will be removed.

trianglesChanged

Triggered when the value of the triangles property changes.

updatedAvatarCountChanged

Triggered when the value of the updatedAvatarCount property changes.

updatedHeroAvatarCountChanged

Triggered when the value of the updatedHeroAvatarCount property changes.

uxModeChanged

Triggered when the value of the uxMode property changes.

visibleChanged

Triggered when the value of the visibleChanged property changes.

Deprecated: This signal is deprecated and will be removed.

visibleChildrenChanged

Triggered when the list of visible children changes.

Deprecated: This signal is deprecated and will be removed.

widthChanged

Triggered when the value of the width property changes.

Deprecated: This signal is deprecated and will be removed.

windowChanged

Triggered when the stats window changes.

Deprecated: This signal is deprecated and will be removed.

xChanged

Triggered when the value of the x property changes.

Deprecated: This signal is deprecated and will be removed.

yawChanged

Triggered when the value of the yaw property changes.

yChanged

Triggered when the value of the y property changes.

Deprecated: This signal is deprecated and will be removed.

zChanged

Triggered when the value of the z property changes.

Deprecated: This signal is deprecated and will be removed.

Method Details

(static) childAt( x, y ) → {object}
Returns: object

Deprecated: This method is deprecated and will be removed.

Parameters

Name Type Description
x number

X.

y number

Y.

(static) contains( point ) → {boolean}
Returns: boolean

Deprecated: This method is deprecated and will be removed.

Parameters

Name Type Description
point Vec2

Point

(static) forceActiveFocus( reasonopt )

Deprecated: This method is deprecated and will be removed.

Parameters

Name Type Attributes Default Value Description
reason number <optional>
7

Reason

(static) forceUpdateStats( )

Updates statistics to make current values available to scripts even though the statistics overlay may not be displayed. (Many statistics values are normally updated only if the statistics overlay is displayed.)

Note: Not all statistics values are updated when the statistics overlay isn't displayed or expanded.

Example

Report avatar mixer data and packet rates.

// The statistics to report.
var stats = [
    "avatarMixerInKbps",
    "avatarMixerInPps",
    "avatarMixerOutKbps",
    "avatarMixerOutPps"
];

// Update the statistics for the script.
Stats.forceUpdateStats();

// Report the statistics.
for (var i = 0; i < stats.length; i++) {
    print(stats[i], "=", Stats[stats[i]]);
}
(static) grabToImage( callback, targetSizeopt ) → {boolean}
Returns: boolean

Deprecated: This method is deprecated and will be removed.

Parameters

Name Type Attributes Default Value Description
callback object

Callback.

targetSize Size <optional>
0,0

Target size.

(static) mapFromGlobal( global )

Deprecated: This method is deprecated and will be removed.

Parameters

Name Type Description
global object

Global.

(static) mapFromItem( item )

Deprecated: This method is deprecated and will be removed.

Parameters

Name Type Description
item object

Item.

(static) mapToGlobal( global )

Deprecated: This method is deprecated and will be removed.

Parameters

Name Type Description
global object

Global.

(static) mapToItem( item )

Deprecated: This method is deprecated and will be removed.

Parameters

Name Type Description
item object

Item

(static) nextItemInFocusChain( forwardopt ) → {object}
Returns: object

Deprecated: This method is deprecated and will be removed.

Parameters

Name Type Attributes Default Value Description
forward boolean <optional>
true

Forward.

(static) update( )

Deprecated: This method is deprecated and will be removed.

Signal Details

activeFocusChanged( activeFocus )
Returns: Signal

Triggered when the value of the activeFocus property changes.

Deprecated: This signal is deprecated and will be removed.

Parameters

Name Type Description
activeFocus boolean

Active focus.

activeFocusOnTabChanged( activeFocusOnTab )
Returns: Signal

Triggered when the value of the activeFocusOnTab property changes.

Deprecated: This signal is deprecated and will be removed.

Parameters

Name Type Description
activeFocusOnTab boolean

Active focus on tab.

antialiasingChanged( antialiasing )
Returns: Signal

Triggered when the value of the antialiasing property changes.

Deprecated: This signal is deprecated and will be removed.

Parameters

Name Type Description
antialiasing boolean

Antialiasing.

appdroppedChanged( )
Returns: Signal

Triggered when the value of the appdropped property changes.

assetMbpsInChanged( )
Returns: Signal

Triggered when the value of the assetMbpsIn property changes.

assetMbpsOutChanged( )
Returns: Signal

Triggered when the value of the assetMbpsOut property changes.

assetPingChanged( )
Returns: Signal

Triggered when the value of the assetPing property changes.

audioAudioInboundPPSChanged( )
Returns: Signal

Triggered when the value of the audioAudioInboundPPS property changes.

Deprecated: This signal is deprecated and will be removed. Use audioInboundPPSChanged instead.

audioCodecChanged( )
Returns: Signal

Triggered when the value of the audioCodec property changes.

audioInboundPPSChanged( )
Returns: Signal

Triggered when the value of the audioInboundPPS property changes.

audioInjectorsChanged( )
Returns: Signal

Triggered when the value of the audioInjectors property changes.

audioMixerInKbpsChanged( )
Returns: Signal

Triggered when the value of the audioMixerInKbps property changes.

audioMixerInPpsChanged( )
Returns: Signal

Triggered when the value of the audioMixerInPps property changes.

audioMixerKbpsChanged( )
Returns: Signal

Triggered when the value of the audioMixerKbps property changes.

audioMixerOutKbpsChanged( )
Returns: Signal

Triggered when the value of the audioMixerOutKbps property changes.

audioMixerOutPpsChanged( )
Returns: Signal

Triggered when the value of the audioMixerOutPps property changes.

audioMixerPpsChanged( )
Returns: Signal

Triggered when the value of the audioMixerPps property changes.

audioNoiseGateChanged( )
Returns: Signal

Triggered when the value of the audioNoiseGate property changes.

audioOutboundPPSChanged( )
Returns: Signal

Triggered when the value of the audioOutboundPPS property changes.

audioPacketLossChanged( )
Returns: Signal

Triggered when the value of the audioPacketLoss property changes.

audioPingChanged( )
Returns: Signal

Triggered when the value of the audioPing property changes.

audioSilentInboundPPSChanged( )
Returns: Signal

Triggered when the value of the audioSilentInboundPPS property changes.

audioSilentOutboundPPSChanged( )
Returns: Signal

Triggered when the value of the audioSilentOutboundPPS property changes.

avatarCountChanged( )
Returns: Signal

Triggered when the value of the avatarCount property changes.

avatarMixerInKbpsChanged( )
Returns: Signal

Triggered when the value of the avatarMixerInKbps property changes.

avatarMixerInPpsChanged( )
Returns: Signal

Triggered when the value of the avatarMixerInPps property changes.

avatarMixerOutKbpsChanged( )
Returns: Signal

Triggered when the value of the avatarMixerOutKbps property changes.

avatarMixerOutPpsChanged( )
Returns: Signal

Triggered when the value of the avatarMixerOutPps property changes.

avatarPingChanged( )
Returns: Signal

Triggered when the value of the avatarPing property changes.

avatarSimulationTimeChanged( )
Returns: Signal

Triggered when the value of the avatarSimulationTime property changes.

baselineOffsetChanged( baselineOffset )
Returns: Signal

Triggered when the value of the baselineOffset property changes.

Deprecated: This signal is deprecated and will be removed.

Parameters

Name Type Description
baselineOffset number

Baseline offset.

batchFrameTimeChanged( )
Returns: Signal

Triggered when the value of the batchFrameTime property changes.

bgColorChanged( )
Returns: Signal

Triggered when the value of the bgColor property changes.

Deprecated: This signal is deprecated and will be removed.

childrenChanged( )
Returns: Signal

Triggered when the value of the children property changes.

Deprecated: This signal is deprecated and will be removed.

childrenRectChanged( childrenRect )
Returns: Signal

Triggered when the position and size of the rectangle containing the children changes.

Deprecated: This signal is deprecated and will be removed.

Parameters

Name Type Description
childrenRect Rect

Children rect.

clipChanged( clip )
Returns: Signal

Triggered when the value of the clip property changes.

Deprecated: This signal is deprecated and will be removed.

Parameters

Name Type Description
clip boolean

Clip.

collisionPicksCountChanged( )
Returns: Signal

Triggered when the value of the collisionPicksCount property changes.

collisionPicksUpdatedChanged( )
Returns: Signal

Triggered when the value of the collisionPicksUpdated property changes.

containmentMaskChanged( )
Returns: Signal

Triggered when the value of the containmentMask property changes.

Deprecated: This signal is deprecated and will be removed.

decimatedTextureCountChanged( )
Returns: Signal

Triggered when the value of the decimatedTextureCount property changes.

downloadLimitChanged( )
Returns: Signal

Triggered when the value of the downloadLimit property changes.

downloadsChanged( )
Returns: Signal

Triggered when the value of the downloads property changes.

downloadsPendingChanged( )
Returns: Signal

Triggered when the value of the downloadsPending property changes.

downloadUrlsChanged( )
Returns: Signal

Triggered when the value of the downloadUrls property changes.

drawcallsChanged( )
Returns: Signal

Triggered when the value of the drawcalls property changes.

enabledChanged( )
Returns: Signal

Triggered when the value of the enabled property changes.

Deprecated: This signal is deprecated and will be removed.

engineFrameTimeChanged( )
Returns: Signal

Triggered when the value of the engineFrameTime property changes.

entitiesPingChanged( )
Returns: Signal

Triggered when the value of the entitiesPing property changes.

entityPacketsInKbpsChanged( )
Returns: Signal

Triggered when the value of the entityPacketsInKbps property changes.

eventQueueDebuggingOnChanged( )
Returns: Signal

Triggered when the value of the eventQueueDebuggingOn property changes.

expandedChanged( )
Returns: Signal

Triggered when the value of the expanded property changes.

focusChanged( focus )
Returns: Signal

Triggered when the value of the focus property changes.

Deprecated: This signal is deprecated and will be removed.

Parameters

Name Type Description
focus boolean

Focus.

gameLoopRateChanged( )
Returns: Signal

Triggered when the value of the gameLoopRate property changes.

gameUpdateStatsChanged( )
Returns: Signal

Triggered when the value of the gameUpdateStats property changes.

glContextSwapchainMemoryChanged( )
Returns: Signal

Triggered when the value of the glContextSwapchainMemory property changes.

gpuBufferMemoryChanged( )
Returns: Signal

Triggered when the value of the gpuBufferMemory property changes.

gpuBuffersChanged( )
Returns: Signal

Triggered when the value of the gpuBuffers property changes.

gpuFrameSizeChanged( )
Returns: Signal

Triggered when the value of the gpuFrameSize property changes.

gpuFrameTimeChanged( )
Returns: Signal

Triggered when the value of the gpuFrameTime property changes.

gpuFrameTimePerPixelChanged( )
Returns: Signal

Triggered when the value of the gpuFrameTimePerPixel property changes.

gpuFreeMemoryChanged( )
Returns: Signal

Triggered when the value of the gpuFreeMemory property changes.

gpuTextureExternalMemoryChanged( )
Returns: Signal

Triggered when the value of the gpuTextureExternalMemory property changes.

gpuTextureFramebufferMemoryChanged( )
Returns: Signal

Triggered when the value of the gpuTextureFramebufferMemory property changes.

gpuTextureMemoryChanged( )
Returns: Signal

Triggered when the value of the gpuTextureMemory property changes.

gpuTextureMemoryPressureStateChanged( )
Returns: Signal

Triggered when the value of the gpuTextureMemoryPressureState property changes.

gpuTextureResidentMemoryChanged( )
Returns: Signal

Triggered when the value of the gpuTextureResidentMemory property changes.

gpuTextureResourceIdealMemoryChanged( )
Returns: Signal

Triggered when the value of the gpuTextureResourceIdealMemory property changes.

gpuTextureResourceMemoryChanged( )
Returns: Signal

Triggered when the value of the gpuTextureResourceMemory property changes.

gpuTextureResourcePopulatedMemoryChanged( )
Returns: Signal

Triggered when the value of the gpuTextureResourcePopulatedMemory property changes.

gpuTexturesChanged( )
Returns: Signal

Triggered when the value of the gpuTextures property changes.

heightChanged( )
Returns: Signal

Triggered when the value of the height property changes.

Deprecated: This signal is deprecated and will be removed.

heroAvatarCountChanged( )
Returns: Signal

Triggered when the value of the heroAvatarCount property changes.

implicitHeightChanged( )
Returns: Signal

Triggered when the value of the implicitHeight property changes.

Deprecated: This signal is deprecated and will be removed.

implicitWidthChanged( )
Returns: Signal

Triggered when the value of the implicitWidth property changes.

Deprecated: This signal is deprecated and will be removed.

itemConsideredChanged( )
Returns: Signal

Triggered when the value of the itemConsidered property changes.

itemOutOfViewChanged( )
Returns: Signal

Triggered when the value of the itemOutOfView property changes.

itemRenderedChanged( )
Returns: Signal

Triggered when the value of the itemRendered property changes.

itemTooSmallChanged( )
Returns: Signal

Triggered when the value of the itemTooSmall property changes.

localElementsChanged( )
Returns: Signal

Triggered when the value of the localElements property changes.

localInternalChanged( )
Returns: Signal

Triggered when the value of the localInternal property changes.

localLeavesChanged( )
Returns: Signal

Triggered when the value of the localLeaves property changes.

lodAngleChanged( )
Returns: Signal

Triggered when the value of the lodAngle property changes.

lodStatusChanged( )
Returns: Signal

Triggered when the value of the lodStatus property changes.

lodTargetFramerateChanged( )
Returns: Signal

Triggered when the value of the lodTargetFramerate property changes.

longframesChanged( )
Returns: Signal

Triggered when the value of the longframes property changes.

longrendersChanged( )
Returns: Signal

Triggered when the value of the longrenders property changes.

longsubmitsChanged( )
Returns: Signal

Triggered when the value of the longsubmits property changes.

mainThreadQueueDepthChanged( )
Returns: Signal

Triggered when the value of the mainThreadQueueDepth property changes.

materialSwitchesChanged( )
Returns: Signal

Triggered when the value of the materialSwitches property changes.

mbpsInChanged( )
Returns: Signal

Triggered when the value of the mbpsIn property changes.

mbpsOutChanged( )
Returns: Signal

Triggered when the value of the mbpsOut property changes.

messagePingChanged( )
Returns: Signal

Triggered when the value of the messagePing property changes.

myAvatarSendRateChanged( )
Returns: Signal

Triggered when the value of the myAvatarSendRate property changes.

nodeListThreadQueueDepth( )
Returns: Signal

Triggered when the value of the nodeListThreadQueueDepth property changes.

notUpdatedAvatarCountChanged( )
Returns: Signal

Triggered when the value of the notUpdatedAvatarCount property changes.

numEntityUpdatesChanged( )
Returns: Signal

Triggered when the value of the numEntityUpdates property changes.

numNeededEntityUpdatesChanged( )
Returns: Signal

Triggered when the value of the numNeededEntityUpdates property changes.

opacityChanged( )
Returns: Signal

Triggered when the value of the opacity property changes.

Deprecated: This signal is deprecated and will be removed.

packetInCountChanged( )
Returns: Signal

Triggered when the value of the packetInCount property changes.

packetOutCountChanged( )
Returns: Signal

Triggered when the value of the packetOutCount property changes.

packetStatsChanged( )
Returns: Signal

Triggered when the value of the packetStats property changes.

parabolaPicksCountChanged( )
Returns: Signal

Triggered when the value of the parabolaPicksCount property changes.

parabolaPicksUpdatedChanged( )
Returns: Signal

Triggered when the value of the parabolaPicksUpdated property changes.

parentChanged( parent )
Returns: Signal

Triggered when the parent item changes.

Deprecated: This signal is deprecated and will be removed.

Parameters

Name Type Description
parent object

Parent.

physicsObjectCountChanged( )
Returns: Signal

Triggered when the value of the physicsObjectCount property changes.

positionChanged( )
Returns: Signal

Triggered when the value of the position property changes.

presentdroprateChanged( )
Returns: Signal

Triggered when the value of the presentdroprate property changes.

presentnewrateChanged( )
Returns: Signal

Triggered when the value of the presentnewrate property changes.

presentrateChanged( )
Returns: Signal

Triggered when the value of the presentrate property changes.

processingChanged( )
Returns: Signal

Triggered when the value of the processing property changes.

processingPendingChanged( )
Returns: Signal

Triggered when the value of the processingPending property changes.

qmlTextureMemoryChanged( )
Returns: Signal

Triggered when the value of the qmlTextureMemory property changes.

rayPicksCountChanged( )
Returns: Signal

Triggered when the value of the rayPicksCount property changes.

rayPicksUpdatedChanged( )
Returns: Signal

Triggered when the value of the rayPicksUpdated property changes.

rectifiedTextureCountChanged( )
Returns: Signal

Triggered when the value of the rectifiedTextureCount property changes.

refreshRateModeChanged( )
Returns: Signal

Triggered when the value of the refreshRateMode property changes.

refreshRateRegimeChanged( )
Returns: Signal

Triggered when the value of the refreshRateRegime property changes.

refreshRateTargetChanged( )
Returns: Signal

Triggered when the value of the refreshRateTarget property changes.

renderrateChanged( )
Returns: Signal

Triggered when the value of the renderrate property changes.

rotationChanged( )
Returns: Signal

Triggered when the value of the rotation property changes.

Deprecated: This signal is deprecated and will be removed.

scaleChanged( )
Returns: Signal

Triggered when the value of the scale property changes.

Deprecated: This signal is deprecated and will be removed.

sendingModeChanged( )
Returns: Signal

Triggered when the value of the sendingMode property changes.

serverCountChanged( )
Returns: Signal

Triggered when the value of the serverCount property changes.

serverElementsChanged( )
Returns: Signal

Triggered when the value of the serverElements property changes.

serverInternalChanged( )
Returns: Signal

Triggered when the value of the serverInternal property changes.

serverLeavesChanged( )
Returns: Signal

Triggered when the value of the serverLeaves property changes.

shadowConsideredChanged( )
Returns: Signal

Triggered when the value of the shadowConsidered property changes.

shadowOutOfViewChanged( )
Returns: Signal

Triggered when the value of the shadowOutOfView property changes.

shadowRenderedChanged( )
Returns: Signal

Triggered when the value of the shadowRendered property changes.

shadowTooSmallChanged( )
Returns: Signal

Triggered when the value of the shadowTooSmall property changes.

smoothChanged( smooth )
Returns: Signal

Triggered when the value of the smooth property changes.

Deprecated: This signal is deprecated and will be removed.

Parameters

Name Type Description
smooth boolean

Smooth.

speedChanged( )
Returns: Signal

Triggered when the value of the speed property changes.

stateChanged( )
Returns: Signal

Triggered when the value of the state property changes.

Deprecated: This signal is deprecated and will be removed.

stutterrateChanged( )
Returns: Signal

Triggered when the value of the stutterrate property changes.

stylusPicksCountChanged( )
Returns: Signal

Triggered when the value of the stylusPicksCount property changes.

stylusPicksUpdatedChanged( )
Returns: Signal

Triggered when the value of the stylusPicksUpdated property changes.

texturePendingTransfersChanged( )
Returns: Signal

Triggered when the value of the texturePendingTransfers property changes.

timingExpandedChanged( )
Returns: Signal

Triggered when the value of the timingExpanded property changes.

timingStatsChanged( )
Returns: Signal

Triggered when the value of the timingStats property changes.

transformOriginChanged( transformOrigin )
Returns: Signal

Triggered when the value of the transformOrigin property changes.

Deprecated: This signal is deprecated and will be removed.

Parameters

Name Type Description
transformOrigin number

Transformm origin.

trianglesChanged( )
Returns: Signal

Triggered when the value of the triangles property changes.

updatedAvatarCountChanged( )
Returns: Signal

Triggered when the value of the updatedAvatarCount property changes.

updatedHeroAvatarCountChanged( )
Returns: Signal

Triggered when the value of the updatedHeroAvatarCount property changes.

uxModeChanged( )
Returns: Signal

Triggered when the value of the uxMode property changes.

visibleChanged( )
Returns: Signal

Triggered when the value of the visibleChanged property changes.

Deprecated: This signal is deprecated and will be removed.

visibleChildrenChanged( )
Returns: Signal

Triggered when the list of visible children changes.

Deprecated: This signal is deprecated and will be removed.

widthChanged( )
Returns: Signal

Triggered when the value of the width property changes.

Deprecated: This signal is deprecated and will be removed.

windowChanged( window )
Returns: Signal

Triggered when the stats window changes.

Deprecated: This signal is deprecated and will be removed.

Parameters

Name Type Description
window object

Window.

xChanged( )
Returns: Signal

Triggered when the value of the x property changes.

Deprecated: This signal is deprecated and will be removed.

yawChanged( )
Returns: Signal

Triggered when the value of the yaw property changes.

yChanged( )
Returns: Signal

Triggered when the value of the y property changes.

Deprecated: This signal is deprecated and will be removed.

zChanged( )
Returns: Signal

Triggered when the value of the z property changes.

Deprecated: This signal is deprecated and will be removed.