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

Stats

Deprecated

Stats

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.

Inherited from Instance: Show Hide

int

DataCost

[ReadOnly] [NotReplicated]
The cost of saving the instance using data persistence.
Instance

Parent

Determines the hierarchical parent of the `Instance`.
bool

RobloxLocked

If true, the `Instance` and its descendants cannot be indexed or edited by a `Script` or `LocalScript` and will throw an error if it is attempted.
string

ClassName

[ReadOnly] [NotReplicated]
A read-only string representing the class this `Instance` belongs to.
string

Name

A non-unique identifier of the `Instance`.
bool

Archivable

Determines if an `Instance` can be cloned using `/Instance/Clone` or saved to file.

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.

Inherited from Instance: Show Hide

Array

GetDescendants ( )

[CustomLuaState]
Returns an array containing all of the `Instance`'s descendants.
bool

IsAncestorOf ( Instance descendant )

Returns true if an `Instance` is an ancestor of the given descendant.
bool

IsDescendantOf ( Instance ancestor )

Returns true if an `Instance` is a descendant of the given ancestor.
Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the `Instance` for whom `Instance/IsA` returns true for the given className.
Instance

FindFirstChildOfClass ( string className )

Returns the first child of the `Instance` whose `Instance/ClassName|ClassName` is equal to the given className.
Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the `Instance` found with the given name.
Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the `Instance` for whom `Instance/IsA` returns true for the given className.
Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the `Instance` whose `Instance/ClassName` is equal to the given className.
Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the `Instance` whose `Instance/Name` is equal to the given name.
bool

IsA ( string className )

Returns true if an `Instance`'s class matches or inherits from a given class
Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]
Returns the child of the `Instance` with the given name. If the child does not exist, it will yield the current thread until it does.
RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.
string

GetFullName ( )

Returns a string showing the `Instance`'s ancestry.
string

GetDebugId ( int scopeLength )

[NotBrowsable]
Returns a coded string of the `Instance`s DebugId used internally by Roblox.
Objects

GetChildren ( )

Returns an array containing all of the `Instance`'s children.
void

Destroy ( )

Sets the `Instance/Parent` property to nil, locks the `Instance/Parent` property, disconnects all connections and calls Destroy on all children.
Instance

Clone ( )

Create a deep copy of a Roblox instance and descendants where `Archivable = true`.
void

ClearAllChildren ( )

This function destroys all of an `Instance`'s children.

Events

Inherited from Instance: Show Hide

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the `Instance/Parent` property of the object or one of its ancestors is changed.
RBXScriptSignal

ChildAdded ( Instance child )

Fires when an object is parented to this `Instance`.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires when a child is removed from this `Instance`.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the `Instance`.
RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the `Instance` is removed.
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.