Stats¶
Supported Class NotCreatable Service
Performance metrics for a game.
6 Nova members · 33 modern Roblox members not implemented yet
Description¶
Stats is a service that provides real-time performance information about the current running game instance. Its primary purpose is to provide an end point to measure where resources are being consumed, as well as how much memory is being consumed overall.
The service also stores a tree of StatsItem objects which can have their values read by plugins.
Inheritance¶
Nova inheritance: Instance → Stats
Properties¶
MinReportInterval Supported Property
No description available.
Security:
RobloxScriptSecurityReporterType Supported Property
Methods¶
Report Supported Function
No description available.
Security:
RobloxScriptSecurityReportJobsStepWindow Supported Function
No description available.
Security:
RobloxScriptSecurityReportTaskScheduler Supported Function
No description available.
Security:
RobloxScriptSecuritySetReportUrl Supported Function
No description available.
Security:
RobloxScriptSecurityInherited members¶
Inherited from Instance: 8 properties, 36 methods, 7 events. They are documented on the base class page.
33 modern Roblox member(s) are not implemented yet — expand to inspect
Members declared by Roblox's Stats class (or by a missing base class) that Nova does not expose. Use this list to scope a migration; the compatibility guide has the recommended workaround.
Properties¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
ContactsCount |
ContactsCount: int |
Not yet | A measurement of how many parts are currently in contact with one another. | ReadOnly, NotReplicated |
DataReceiveKbps |
DataReceiveKbps: float |
Not yet | In a networked game, this describes roughly how many kilobytes of data are being received by the current instance, per second. | ReadOnly, NotReplicated |
DataSendKbps |
DataSendKbps: float |
Not yet | In a networked game, this describes roughly how many kilobytes of data are being sent by the current instance, per second. | ReadOnly, NotReplicated |
FrameTime |
FrameTime: float |
Not yet | A measurement of how long it takes for the engine to process all tasks required to render a frame. | ReadOnly, NotReplicated |
HeartbeatTime |
HeartbeatTime: float |
Not yet | A measurement of the total amount of time it takes for the server to update its task scheduler jobs in seconds. | ReadOnly, NotReplicated |
HeartbeatTimeMs |
HeartbeatTimeMs: float |
Not yet | A measurement of the total amount of time it takes long it takes for Roblox to update all of its task scheduler jobs, in milliseconds. | ReadOnly, NotReplicated |
InstanceCount |
InstanceCount: int |
Not yet | A measurement of how many Instance are currently in memory. | ReadOnly, NotReplicated |
MemoryTrackingEnabled |
MemoryTrackingEnabled: bool |
Not yet | An indication of whether memory tracking is enabled. This is guaranteed to be unchanged until the next time the Client is started. | ReadOnly, NotReplicated |
MovingPrimitivesCount |
MovingPrimitivesCount: int |
Not yet | A measurement of how many physically simulated components are currently moving in the game world. | ReadOnly, NotReplicated |
PhysicsReceiveKbps |
PhysicsReceiveKbps: float |
Not yet | In a networked game, this describes roughly how many kilobytes of physics data are being received by the current instance, per second. | ReadOnly, NotReplicated |
PhysicsSendKbps |
PhysicsSendKbps: float |
Not yet | In a networked game, this describes roughly how many kilobytes of physics data are being sent by the current instance, per second. | ReadOnly, NotReplicated |
PhysicsStepTime |
PhysicsStepTime: float |
Not yet | A measurement of how long it takes for the physics engine to update its current state. | ReadOnly, NotReplicated |
PhysicsStepTimeMs |
PhysicsStepTimeMs: float |
Not yet | A measurement of how long it takes for the physics engine to update its current state, in milliseconds. If this value is high, then it means the game instance is under s… | ReadOnly, NotReplicated |
PrimitivesCount |
PrimitivesCount: int |
Not yet | A measurement of how many physically simulated components currently exist in the game world. | ReadOnly, NotReplicated |
RenderCPUFrameTime |
RenderCPUFrameTime: float |
Not yet | A measurement of how long it takes for the CPU to process all of its rendering tasks for a frame. | ReadOnly, NotReplicated |
RenderGPUFrameTime |
RenderGPUFrameTime: float |
Not yet | A measurement of how long it takes for the GPU to process all of its tasks required to render a frame. | ReadOnly, NotReplicated |
SceneDrawcallCount |
SceneDrawcallCount: int |
Not yet | A measurement of the number of draw calls made by the game's current scene. | ReadOnly, NotReplicated |
SceneTriangleCount |
SceneTriangleCount: int |
Not yet | A measurement of the number of triangles rendered by the game's current scene. | ReadOnly, NotReplicated |
ShadowsDrawcallCount |
ShadowsDrawcallCount: int |
Not yet | A measurement of the number of draw calls being made for shadows by the game's current scene. | ReadOnly, NotReplicated |
ShadowsTriangleCount |
ShadowsTriangleCount: int |
Not yet | A measurement of the number of triangles rendered as shadows in the game's current scene. | ReadOnly, NotReplicated |
UI2DDrawcallCount |
UI2DDrawcallCount: int |
Not yet | A measurement of the number of 2D draw calls made for UI elements in the game's current scene. | ReadOnly, NotReplicated |
UI2DTriangleCount |
UI2DTriangleCount: int |
Not yet | A measurement of the number of triangles that are being rendered for 2D UI elements in the game's current scene. | ReadOnly, NotReplicated |
UI3DDrawcallCount |
UI3DDrawcallCount: int |
Not yet | A measurement of the number of 3D draw calls made for UI elements in the game's current scene. | ReadOnly, NotReplicated |
UI3DTriangleCount |
UI3DTriangleCount: int |
Not yet | A measurement of the number of triangles being rendered for 3D UI elements in the game's current scene. | ReadOnly, NotReplicated |
Methods¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
GetBrowserTrackerId |
Stats:GetBrowserTrackerId(): string |
Not yet | — | RobloxScriptSecurity |
GetHarmonyQualityLevel |
Stats:GetHarmonyQualityLevel(): int |
Not yet | Internal-only. Returns the engine's current dynamic-quality level as a score normalized from 0 to 100. |
— |
GetMemoryCategoryNames |
Stats:GetMemoryCategoryNames(): Array |
Not yet | Internal-only. Returns an array of the names of every developer memory category the engine tracks. | — |
GetMemoryUsageMbAllCategories |
Stats:GetMemoryUsageMbAllCategories(): Array |
Not yet | Returns the number of megabytes that are being consumed by all available categories, or an empty array if MemoryTrackingEnabled is `fal… | — |
GetMemoryUsageMbForTag |
Stats:GetMemoryUsageMbForTag(tag: DeveloperMemoryTag): float |
Not yet | Returns the number of megabytes that are being consumed in the specified DeveloperMemoryTag category, or 0 if [MemoryTrackingEnabled]… |
— |
GetPaginatedMemoryByTexture |
Stats:GetPaginatedMemoryByTexture(queryType: TextureQueryType, pageIndex: int, pageSize: int): Dictionary |
Not yet | — | Yields, RobloxScriptSecurity |
GetTotalMemoryUsageMb |
Stats:GetTotalMemoryUsageMb(): float |
Not yet | Returns the total amount of memory being consumed by the current game session, in megabytes. | — |
ResetHarmonyMemoryTarget |
Stats:ResetHarmonyMemoryTarget(): null |
Not yet | Internal-only. Restores the performance-control system's memory budget to the values in effect before Stats.SetHarmonyMemoryTarget() w… | — |
SetHarmonyMemoryTarget |
Stats:SetHarmonyMemoryTarget(targetMB: int): null |
Not yet | Internal-only. Overrides the performance-control system's memory budget with a target value, in megabytes, for testing. | — |
Roblox reference: Stats
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.