PcoWSkbVqDnWTu_dm2ix
We use cookies on this site to enhance your user experience
Collapse Sidebar

Stats

Show deprecated

Stats

Show deprecated

Stats is a service that provides real-time performance information about the current running game instance. Its primary purpose is to provide developers with 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, which can have their values read by plugins.


Properties

int

ContactsCount

[ReadOnly] [NotReplicated]

A measurement of how many parts are currently in contact with one another.

float

DataReceiveKbps

[ReadOnly] [NotReplicated]

In a networked game, this describes roughly how many kilobytes of data are being received by the current instance, per second.

float

DataSendKbps

[ReadOnly] [NotReplicated]

In a networked game, this describes roughly how many kilobytes of data are being sent by the current instance, per second.

float

HeartbeatTimeMs

[ReadOnly] [NotReplicated]

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.

int

InstanceCount

[ReadOnly] [NotReplicated]

A measurement of how many Instance are currently in memory.

int

MovingPrimitivesCount

[ReadOnly] [NotReplicated]

A measurement of how many physically simulated components are currently moving in the game world.

float

PhysicsReceiveKbps

[ReadOnly] [NotReplicated]

In a networked game, this describes roughly how many kilobytes of physics data are being received by the current instance, per second.

float

PhysicsSendKbps

[ReadOnly] [NotReplicated]

In a networked game, this describes roughly how many kilobytes of physics data are being sent by the current instance, per second.

float

PhysicsStepTimeMs

[ReadOnly] [NotReplicated]

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 stress from the physics simulations taking place.

int

PrimitivesCount

[ReadOnly] [NotReplicated]

A measurement of how many physically simulated components currently exist in the game world.

Functions

float

GetMemoryUsageMbForTag ( DeveloperMemoryTag tag )

Returns the number of megabytes that are being consumed in the specified DeveloperMemoryTag category.

float

GetTotalMemoryUsageMb ( )

Returns the total amount of memory being consumed by the current game session, in megabytes.

Events