Description
Supported Script Types: Interface Scripts • Client Entity Scripts • Avatar Scripts • Server Entity Scripts • Assignment Client Scripts
TheStats
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 |
|
timingExpanded | boolean |
|
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 |
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 | 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.
|
assetMbpsOut | number |
The amount of data being sent to the asset server, in megabits per second.
|
audioPing | number |
The ping time to the audio mixer, in ms.
|
avatarPing | number |
The ping time to the avatar mixer, in ms.
|
entitiesPing | number |
The average ping time to the entity servers, in ms.
|
assetPing | number |
The ping time to the asset server, in ms.
|
messagePing | number |
The ping time to the message mixer, in ms.
|
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.
|
avatarMixerInPps | number |
The number of packets being received from the avatar mixer, in packets per second.
|
avatarMixerOutKbps | number |
The amount of data being sent to the avatar mixer, in kilobits per second.
|
avatarMixerOutPps | number |
The number of packets being sent to the avatar mixer, in packets per second.
|
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.
|
audioMixerInPps | number |
The number of packets being received from the audio mixer, in packets per second.
|
audioMixerOutKbps | number |
The amount of data being sent to the audio mixer, in kilobits per second.
|
audioMixerOutPps | number |
The number of packets being sent to the audio mixer, in packets per second.
|
audioMixerKbps | number |
The total amount of data being sent to and received from the audio mixer, in kilobits
per second.
|
audioMixerPps | number |
The total number of packets being sent to and received from the audio mixer, in packets
per second.
|
audioOutboundPPS | number |
The number of non-silent audio packets being sent by the user, in packets per second.
|
audioSilentOutboundPPS | number |
The number of silent audio packets being sent by the user, in packets per
second.
|
audioInboundPPS | number |
The number of non-silent audio packets being received by the user, in packets per
second.
|
audioAudioInboundPPS | number |
The number of non-silent audio packets being received by the user, in packets per
second.
Deprecated: This property is deprecated and will be removed. Use |
audioSilentInboundPPS | number |
The number of silent audio packets being received by the user, in packets per
second.
|
audioPacketLoss | number |
The number of audio packets being lost, sent to or received from the audio mixer, in %.
|
audioCodec | string |
The name of the audio codec. Read-only. |
audioNoiseGate | string |
The status of the audio noise gate: |
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.)
|
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. |
downloadProgresses | Array.<number> |
The download progresses. Read-only. |
downloadPriorities | Array.<number> |
The download priorities. Read-only. |
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 | number |
The number of entity updates that happened last frame. Read-only. |
numNeededEntityUpdates | number |
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 |
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 8192 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 |
gpuTextures | number |
The number of OpenGL textures managed by the GPU back-end. This is the sum of the number of
textures managed for |
gpuTextureMemory | number |
The total memory size of the |
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.
|
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:
Note: Property not available in the API. |
rayPicksUpdated | Vec3 |
The number of ray pick intersections that were found in the most recent game loop:
Note: Property not available in the API. |
parabolaPicksUpdated | Vec3 |
The number of parabola pick intersections that were found in the most recent game loop:
Note: Property not available in the API. |
collisionPicksUpdated | Vec3 |
The number of collision pick intersections that were found in the most recent game loop:
Note: Property not available in the API. |
eventQueueDebuggingOn | boolean |
|
mainThreadQueueDepth | number |
The number of events in the main thread's event queue.
Only provided if |
nodeListThreadQueueDepth | number |
The number of events in the node list thread's event queue.
Only provided if |
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 Deprecated: This signal is deprecated and will be removed. |
activeFocusOnTabChanged
|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. |
antialiasingChanged
|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. |
appdroppedChanged
|
Triggered when the value of the |
assetMbpsInChanged
|
Triggered when the value of the |
assetMbpsOutChanged
|
Triggered when the value of the |
assetPingChanged
|
Triggered when the value of the |
audioAudioInboundPPSChanged
|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. Use audioInboundPPSChanged instead. |
audioCodecChanged
|
Triggered when the value of the |
audioInboundPPSChanged
|
Triggered when the value of the |
audioInjectorsChanged
|
Triggered when the value of the |
audioMixerInKbpsChanged
|
Triggered when the value of the |
audioMixerInPpsChanged
|
Triggered when the value of the |
audioMixerKbpsChanged
|
Triggered when the value of the |
audioMixerOutKbpsChanged
|
Triggered when the value of the |
audioMixerOutPpsChanged
|
Triggered when the value of the |
audioMixerPpsChanged
|
Triggered when the value of the |
audioNoiseGateChanged
|
Triggered when the value of the |
audioOutboundPPSChanged
|
Triggered when the value of the |
audioPacketLossChanged
|
Triggered when the value of the |
audioPingChanged
|
Triggered when the value of the |
audioSilentInboundPPSChanged
|
Triggered when the value of the |
audioSilentOutboundPPSChanged
|
Triggered when the value of the |
avatarCountChanged
|
Triggered when the value of the |
avatarMixerInKbpsChanged
|
Triggered when the value of the |
avatarMixerInPpsChanged
|
Triggered when the value of the |
avatarMixerOutKbpsChanged
|
Triggered when the value of the |
avatarMixerOutPpsChanged
|
Triggered when the value of the |
avatarPingChanged
|
Triggered when the value of the |
avatarSimulationTimeChanged
|
Triggered when the value of the |
baselineOffsetChanged
|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. |
batchFrameTimeChanged
|
Triggered when the value of the |
bgColorChanged
|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. |
childrenChanged
|
Triggered when the value of the 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 Deprecated: This signal is deprecated and will be removed. |
collisionPicksCountChanged
|
Triggered when the value of the |
collisionPicksUpdatedChanged
|
Triggered when the value of the |
containmentMaskChanged
|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. |
decimatedTextureCountChanged
|
Triggered when the value of the |
downloadLimitChanged
|
Triggered when the value of the |
downloadPrioritiesChanged
|
Triggered when the value of the |
downloadProgressesChanged
|
Triggered when the value of the |
downloadUrlsChanged
|
Triggered when the value of the |
downloadsChanged
|
Triggered when the value of the |
downloadsPendingChanged
|
Triggered when the value of the |
drawcallsChanged
|
Triggered when the value of the |
enabledChanged
|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. |
engineFrameTimeChanged
|
Triggered when the value of the |
entitiesPingChanged
|
Triggered when the value of the |
entityPacketsInKbpsChanged
|
Triggered when the value of the |
eventQueueDebuggingOnChanged
|
Triggered when the value of the |
expandedChanged
|
Triggered when the value of the |
focusChanged
|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. |
gameLoopRateChanged
|
Triggered when the value of the |
gameUpdateStatsChanged
|
Triggered when the value of the |
glContextSwapchainMemoryChanged
|
Triggered when the value of the |
gpuBufferMemoryChanged
|
Triggered when the value of the |
gpuBuffersChanged
|
Triggered when the value of the |
gpuFrameSizeChanged
|
Triggered when the value of the |
gpuFrameTimeChanged
|
Triggered when the value of the |
gpuFrameTimePerPixelChanged
|
Triggered when the value of the |
gpuFreeMemoryChanged
|
Triggered when the value of the |
gpuTextureExternalMemoryChanged
|
Triggered when the value of the |
gpuTextureFramebufferMemoryChanged
|
Triggered when the value of the |
gpuTextureMemoryChanged
|
Triggered when the value of the |
gpuTextureMemoryPressureStateChanged
|
Triggered when the value of the |
gpuTextureResidentMemoryChanged
|
Triggered when the value of the |
gpuTextureResourceIdealMemoryChanged
|
Triggered when the value of the |
gpuTextureResourceMemoryChanged
|
Triggered when the value of the |
gpuTextureResourcePopulatedMemoryChanged
|
Triggered when the value of the |
gpuTexturesChanged
|
Triggered when the value of the |
heightChanged
|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. |
heroAvatarCountChanged
|
Triggered when the value of the |
implicitHeightChanged
|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. |
implicitWidthChanged
|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. |
itemConsideredChanged
|
Triggered when the value of the |
itemOutOfViewChanged
|
Triggered when the value of the |
itemRenderedChanged
|
Triggered when the value of the |
itemTooSmallChanged
|
Triggered when the value of the |
localElementsChanged
|
Triggered when the value of the |
localInternalChanged
|
Triggered when the value of the |
localLeavesChanged
|
Triggered when the value of the |
lodAngleChanged
|
Triggered when the value of the |
lodStatusChanged
|
Triggered when the value of the |
lodTargetFramerateChanged
|
Triggered when the value of the |
longframesChanged
|
Triggered when the value of the |
longrendersChanged
|
Triggered when the value of the |
longsubmitsChanged
|
Triggered when the value of the |
mainThreadQueueDepthChanged
|
Triggered when the value of the |
materialSwitchesChanged
|
Triggered when the value of the |
mbpsInChanged
|
Triggered when the value of the |
mbpsOutChanged
|
Triggered when the value of the |
messagePingChanged
|
Triggered when the value of the |
myAvatarSendRateChanged
|
Triggered when the value of the |
nodeListThreadQueueDepth
|
Triggered when the value of the |
notUpdatedAvatarCountChanged
|
Triggered when the value of the |
numEntityUpdatesChanged
|
Triggered when the value of the |
numNeededEntityUpdatesChanged
|
Triggered when the value of the |
opacityChanged
|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. |
packetInCountChanged
|
Triggered when the value of the |
packetOutCountChanged
|
Triggered when the value of the |
packetStatsChanged
|
Triggered when the value of the |
parabolaPicksCountChanged
|
Triggered when the value of the |
parabolaPicksUpdatedChanged
|
Triggered when the value of the |
parentChanged
|
Triggered when the parent item changes. Deprecated: This signal is deprecated and will be removed. |
physicsObjectCountChanged
|
Triggered when the value of the |
positionChanged
|
Triggered when the value of the |
presentdroprateChanged
|
Triggered when the value of the |
presentnewrateChanged
|
Triggered when the value of the |
presentrateChanged
|
Triggered when the value of the |
processingChanged
|
Triggered when the value of the |
processingPendingChanged
|
Triggered when the value of the |
qmlTextureMemoryChanged
|
Triggered when the value of the |
rayPicksCountChanged
|
Triggered when the value of the |
rayPicksUpdatedChanged
|
Triggered when the value of the |
rectifiedTextureCountChanged
|
Triggered when the value of the |
refreshRateModeChanged
|
Triggered when the value of the |
refreshRateRegimeChanged
|
Triggered when the value of the |
refreshRateTargetChanged
|
Triggered when the value of the |
renderrateChanged
|
Triggered when the value of the |
rotationChanged
|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. |
scaleChanged
|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. |
sendingModeChanged
|
Triggered when the value of the |
serverCountChanged
|
Triggered when the value of the |
serverElementsChanged
|
Triggered when the value of the |
serverInternalChanged
|
Triggered when the value of the |
serverLeavesChanged
|
Triggered when the value of the |
shadowConsideredChanged
|
Triggered when the value of the |
shadowOutOfViewChanged
|
Triggered when the value of the |
shadowRenderedChanged
|
Triggered when the value of the |
shadowTooSmallChanged
|
Triggered when the value of the |
smoothChanged
|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. |
speedChanged
|
Triggered when the value of the |
stateChanged
|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. |
stutterrateChanged
|
Triggered when the value of the |
stylusPicksCountChanged
|
Triggered when the value of the |
stylusPicksUpdatedChanged
|
Triggered when the value of the |
texturePendingTransfersChanged
|
Triggered when the value of the |
timingExpandedChanged
|
Triggered when the value of the |
timingStatsChanged
|
Triggered when the value of the |
transformOriginChanged
|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. |
trianglesChanged
|
Triggered when the value of the |
updatedAvatarCountChanged
|
Triggered when the value of the |
updatedHeroAvatarCountChanged
|
Triggered when the value of the |
uxModeChanged
|
Triggered when the value of the |
visibleChanged
|
Triggered when the value of the 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 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 Deprecated: This signal is deprecated and will be removed. |
yChanged
|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. |
yawChanged
|
Triggered when the value of the |
zChanged
|
Triggered when the value of the 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
|
(static) contains( point ) → {boolean}
Returns: boolean |
||||||
---|---|---|---|---|---|---|
Deprecated: This method is deprecated and will be removed. Parameters
|
(static) forceActiveFocus( reasonopt ) | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Deprecated: This method is deprecated and will be removed. Parameters
|
(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
|
(static) grabToImage( callback, targetSizeopt ) → {boolean}
Returns: boolean |
|||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Deprecated: This method is deprecated and will be removed. Parameters
|
(static) mapFromGlobal( global ) | ||||||
---|---|---|---|---|---|---|
Deprecated: This method is deprecated and will be removed. Parameters
|
(static) mapFromItem( item ) | ||||||
---|---|---|---|---|---|---|
Deprecated: This method is deprecated and will be removed. Parameters
|
(static) mapToGlobal( global ) | ||||||
---|---|---|---|---|---|---|
Deprecated: This method is deprecated and will be removed. Parameters
|
(static) mapToItem( item ) | ||||||
---|---|---|---|---|---|---|
Deprecated: This method is deprecated and will be removed. Parameters
|
(static) nextItemInFocusChain( forwardopt ) → {object}
Returns: object |
||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Deprecated: This method is deprecated and will be removed. Parameters
|
(static) update( ) |
---|
Deprecated: This method is deprecated and will be removed. |
Signal Details
activeFocusChanged(
activeFocus
)
Returns: Signal |
||||||
---|---|---|---|---|---|---|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. Parameters
|
activeFocusOnTabChanged(
activeFocusOnTab
)
Returns: Signal |
||||||
---|---|---|---|---|---|---|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. Parameters
|
antialiasingChanged(
antialiasing
)
Returns: Signal |
||||||
---|---|---|---|---|---|---|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. Parameters
|
appdroppedChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
assetMbpsInChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
assetMbpsOutChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
assetPingChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
audioAudioInboundPPSChanged(
)
Returns: Signal |
---|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. Use audioInboundPPSChanged instead. |
audioCodecChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
audioInboundPPSChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
audioInjectorsChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
audioMixerInKbpsChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
audioMixerInPpsChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
audioMixerKbpsChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
audioMixerOutKbpsChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
audioMixerOutPpsChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
audioMixerPpsChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
audioNoiseGateChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
audioOutboundPPSChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
audioPacketLossChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
audioPingChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
audioSilentInboundPPSChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
audioSilentOutboundPPSChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
avatarCountChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
avatarMixerInKbpsChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
avatarMixerInPpsChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
avatarMixerOutKbpsChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
avatarMixerOutPpsChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
avatarPingChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
avatarSimulationTimeChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
baselineOffsetChanged(
baselineOffset
)
Returns: Signal |
||||||
---|---|---|---|---|---|---|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. Parameters
|
batchFrameTimeChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
bgColorChanged(
)
Returns: Signal |
---|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. |
childrenChanged(
)
Returns: Signal |
---|
Triggered when the value of the 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
|
clipChanged(
clip
)
Returns: Signal |
||||||
---|---|---|---|---|---|---|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. Parameters
|
collisionPicksCountChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
collisionPicksUpdatedChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
containmentMaskChanged(
)
Returns: Signal |
---|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. |
decimatedTextureCountChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
downloadLimitChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
downloadPrioritiesChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
downloadProgressesChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
downloadUrlsChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
downloadsChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
downloadsPendingChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
drawcallsChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
enabledChanged(
)
Returns: Signal |
---|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. |
engineFrameTimeChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
entitiesPingChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
entityPacketsInKbpsChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
eventQueueDebuggingOnChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
expandedChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
focusChanged(
focus
)
Returns: Signal |
||||||
---|---|---|---|---|---|---|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. Parameters
|
gameLoopRateChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
gameUpdateStatsChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
glContextSwapchainMemoryChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
gpuBufferMemoryChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
gpuBuffersChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
gpuFrameSizeChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
gpuFrameTimeChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
gpuFrameTimePerPixelChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
gpuFreeMemoryChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
gpuTextureExternalMemoryChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
gpuTextureFramebufferMemoryChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
gpuTextureMemoryChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
gpuTextureMemoryPressureStateChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
gpuTextureResidentMemoryChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
gpuTextureResourceIdealMemoryChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
gpuTextureResourceMemoryChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
gpuTextureResourcePopulatedMemoryChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
gpuTexturesChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
heightChanged(
)
Returns: Signal |
---|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. |
heroAvatarCountChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
implicitHeightChanged(
)
Returns: Signal |
---|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. |
implicitWidthChanged(
)
Returns: Signal |
---|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. |
itemConsideredChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
itemOutOfViewChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
itemRenderedChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
itemTooSmallChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
localElementsChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
localInternalChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
localLeavesChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
lodAngleChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
lodStatusChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
lodTargetFramerateChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
longframesChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
longrendersChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
longsubmitsChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
mainThreadQueueDepthChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
materialSwitchesChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
mbpsInChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
mbpsOutChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
messagePingChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
myAvatarSendRateChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
nodeListThreadQueueDepth(
)
Returns: Signal |
---|
Triggered when the value of the |
notUpdatedAvatarCountChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
numEntityUpdatesChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
numNeededEntityUpdatesChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
opacityChanged(
)
Returns: Signal |
---|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. |
packetInCountChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
packetOutCountChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
packetStatsChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
parabolaPicksCountChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
parabolaPicksUpdatedChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
parentChanged(
parent
)
Returns: Signal |
||||||
---|---|---|---|---|---|---|
Triggered when the parent item changes. Deprecated: This signal is deprecated and will be removed. Parameters
|
physicsObjectCountChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
positionChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
presentdroprateChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
presentnewrateChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
presentrateChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
processingChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
processingPendingChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
qmlTextureMemoryChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
rayPicksCountChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
rayPicksUpdatedChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
rectifiedTextureCountChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
refreshRateModeChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
refreshRateRegimeChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
refreshRateTargetChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
renderrateChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
rotationChanged(
)
Returns: Signal |
---|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. |
scaleChanged(
)
Returns: Signal |
---|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. |
sendingModeChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
serverCountChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
serverElementsChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
serverInternalChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
serverLeavesChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
shadowConsideredChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
shadowOutOfViewChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
shadowRenderedChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
shadowTooSmallChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
smoothChanged(
smooth
)
Returns: Signal |
||||||
---|---|---|---|---|---|---|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. Parameters
|
speedChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
stateChanged(
)
Returns: Signal |
---|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. |
stutterrateChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
stylusPicksCountChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
stylusPicksUpdatedChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
texturePendingTransfersChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
timingExpandedChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
timingStatsChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
transformOriginChanged(
transformOrigin
)
Returns: Signal |
||||||
---|---|---|---|---|---|---|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. Parameters
|
trianglesChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
updatedAvatarCountChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
updatedHeroAvatarCountChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
uxModeChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
visibleChanged(
)
Returns: Signal |
---|
Triggered when the value of the 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 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
|
xChanged(
)
Returns: Signal |
---|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. |
yChanged(
)
Returns: Signal |
---|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. |
yawChanged(
)
Returns: Signal |
---|
Triggered when the value of the |
zChanged(
)
Returns: Signal |
---|
Triggered when the value of the Deprecated: This signal is deprecated and will be removed. |