Performance metrics for a game.
- Memory category
- Instances
- Own members
- 35
- Inherited members
- 75
- Subclasses
- 0
- Siblings
- 608
Properties47
Property categoryBehavior
- Determines if an
Instanceand its descendants can be cloned usingInstance:Clone(), and can be saved/published. - Deprecated: This deprecated property is a variant of
Instance.Archivablewhich should be used instead.Use Archivable instead.
Property categoryData
Property categoryPermissions
- The set of capabilities allowed to be used for scripts inside this container.
- Indicates whether the instance is inside a sandboxed container.
- When enabled, the instance can only access abilities in its
Capabilitieslist.
Defined byStats24
Property categoryData
Stats.ContactsCount: number A measurement of how many parts are currently in contact with one another.Stats.DataReceiveKbps: number In a networked game, this describes roughly how many kilobytes of data are being received by the current instance, per second.Stats.DataSendKbps: number In a networked game, this describes roughly how many kilobytes of data are being sent by the current instance, per second.Stats.FrameTime: number A measurement of how long it takes for the engine to process all tasks required to render a frame.Stats.HeartbeatTime: number A measurement of the total amount of time it takes for the server to update its task scheduler jobs in seconds.Stats.InstanceCount: number A measurement of how manyInstanceare currently in memory.Stats.MemoryTrackingEnabled: boolean An indication of whether memory tracking is enabled. This is guaranteed to be unchanged until the next time the Client is started.Stats.MovingPrimitivesCount: number A measurement of how many physically simulated components are currently moving in the game world.Stats.PhysicsReceiveKbps: number In a networked game, this describes roughly how many kilobytes of physics data are being received by the current instance, per second.Stats.PhysicsSendKbps: number In a networked game, this describes roughly how many kilobytes of physics data are being sent by the current instance, per second.Stats.PhysicsStepTime: number A measurement of how long it takes for the physics engine to update its current state.Stats.PrimitivesCount: number A measurement of how many physically simulated components currently exist in the game world.Stats.RenderCPUFrameTime: number A measurement of how long it takes for the CPU to process all of its rendering tasks for a frame.Stats.RenderGPUFrameTime: number A measurement of how long it takes for the GPU to process all of its tasks required to render a frame.Stats.SceneDrawcallCount: number A measurement of the number of draw calls made by the game's current scene.Stats.SceneTriangleCount: number A measurement of the number of triangles rendered by the game's current scene.Stats.ShadowsDrawcallCount: number A measurement of the number of draw calls being made for shadows by the game's current scene.Stats.ShadowsTriangleCount: number A measurement of the number of triangles rendered as shadows in the game's current scene.Stats.UI2DDrawcallCount: number A measurement of the number of 2D draw calls made for UI elements in the game's current scene.Stats.UI2DTriangleCount: number A measurement of the number of triangles that are being rendered for 2D UI elements in the game's current scene.Stats.UI3DDrawcallCount: number A measurement of the number of 3D draw calls made for UI elements in the game's current scene.Stats.UI3DTriangleCount: number A measurement of the number of triangles being rendered for 3D UI elements in the game's current scene.Stats.HeartbeatTimeMs: number Deprecated: UseStats.HeartbeatTimeinstead.
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.Stats.PhysicsStepTimeMs: number Deprecated: UseStats.PhysicsStepTimeinstead.
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.
No properties match the filters.
Methods53
Object:GetPropertyChangedSignal( property: string): RBXScriptSignal Get an event that fires when a given property of the object changes.Parameters Parameter Description property: stringThe property to connect to.Returns Type Description RBXScriptSignalA signal that fires whenever the property changes.- Returns true if an object's class matches or inherits from a given class.
Parameters Parameter Description className: stringThe class against which the Object's class will be checked. Case-sensitive.Returns Type Description booleanDescribes whether the Object's class matched or is a subclass of the given class. - Deprecated: This deprecated function is a variant of
Object:IsA()which should be used instead.Parameters Parameter className: stringReturns Type booleanUse IsA instead.
- Applies a tag to the instance.
Parameters Parameter Description tag: stringThe tag to apply to the instance. - This method destroys all of an instance's children.
- Create a copy of an instance and all its descendants, ignoring instances that are not
Archivable.Returns Type Description InstanceA copy of the instance, ornilif the instance is notArchivable. - Sets the
Instance.Parentproperty tonil, locks theInstance.Parentproperty, disconnects all connections, and callsDestroy()on all children. Instance:FindFirstAncestor( name: string): Instance Returns the first ancestor of theInstancewhoseInstance.Nameis equal to the given name.Parameters Parameter Description name: stringTheInstance.Nameto be looked for.Instance:FindFirstAncestorOfClass( className: string): Instance Returns the first ancestor of theInstancewhoseObject.ClassNameis equal to the given className.Parameters Parameter Description className: stringTheObject.ClassNameto be looked for.Instance:FindFirstAncestorWhichIsA( className: string): Instance Returns the first ancestor of theInstancefor whomObject:IsA()returns true for the given className.Parameters Parameter Description className: stringTheObject.ClassNameto be looked for.Instance:FindFirstChild( name: string, recursive: boolean? = false): Instance Returns the first child of theInstancefound with the given name.Parameters Parameter Description name: stringTheInstance.Nameto be searched for.recursive: boolean? = falseWhether or not the search should be conducted recursively.Instance:FindFirstChildOfClass( className: string): Instance Parameters Parameter Description className: stringTheObject.ClassNameto be looked for.Instance:FindFirstChildWhichIsA(className: string,recursive: boolean? = false,): Instance Returns the first child of theInstancefor whomObject:IsA()returns true for the given className.Parameters Parameter Description className: stringTheObject.ClassNameto be searched for.recursive: boolean? = falseWhether or not the search should be conducted recursively.Instance:FindFirstDescendant( name: string): Instance Returns the first descendant found with the givenInstance.Name.Parameters Parameter Description name: stringTheInstance.Nameto search for.- Returns the
Actorassociated with the Instance, if any. Instance:GetAttribute( attribute: string): any Returns the value which has been assigned to the given attribute name.Parameters Parameter Description attribute: stringThe name of the attribute being retrieved.Returns Type Description anyThe value which has been assigned to the given attribute name. If no attribute has been assigned,nilis returned.Instance:GetAttributeChangedSignal( attribute: string): RBXScriptSignal Returns an event that fires when the given attribute changes.Parameters Parameter Description attribute: stringThe name of the specified attribute for which the change signal is being returned.Returns Type Description RBXScriptSignalAn event that fires when the given attribute changes.- Returns a dictionary of the instance's attributes.
Returns Type Description { [string]: any }A dictionary of string → variant pairs for each attribute where the string is the name of the attribute and the variant is a non-nil value. - Returns an array containing all of the instance's children.
Returns Type Description { Instance }An array containing the instance's children. Instance:GetDebugId( scopeLength: number? = 4): string Returns a coded string of the debug ID used internally by Roblox.Parameters Parameter Description scopeLength: number? = 4The scope length.Returns Type Description stringThe Debug ID string.- Returns an array containing all of the descendants of the instance.
Returns Type Description { Instance }An array containing the instance's descendants. - Returns a string describing the instance's ancestry.
- Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Parameters Parameter Description name: stringName of the property to query.selector: string?Optional selector for the pseudo instance you are targeting on the instance.Returns Type Description anyThe styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified. Instance:GetStyledPropertyChangedSignal( property: string): RBXScriptSignal Returns an event that fires when the given style property changes on the instance.Parameters Parameter Description property: stringName of the style property for which to listen for changes.Returns Type Description RBXScriptSignalEvent that fires when the given style property changes.- Gets an array of all tags applied to the instance.
Returns Type Description { any }An array of strings, each representing a tag applied to the instance. - Check whether the instance has a given tag.
Parameters Parameter Description tag: stringThe tag to check for on the instance.Returns Type Description booleantrueif the instance has the given tag,falseotherwise. Instance:IsAncestorOf( descendant: Instance): boolean Returns true if anInstanceis an ancestor of the given descendant.Instance:IsDescendantOf( ancestor: Instance): boolean Returnstrueif anInstanceis a descendant of the given ancestor.Instance:IsPropertyModified( property: string): boolean Returnstrueif the value stored in the specified property is not equal to the code-instantiated default.Parameters Parameter Description property: stringName of the property to query.Returns Type Description booleanBoolean indicating whether the property is modified from its code‑instantiated default.Instance:QueryDescendants( selector: string): { Instance } Returns an array containing all descendants of the instance that match theselectorstring.Parameters Parameter Description selector: stringSelector string used to filter elements.Returns Type Description { Instance }An array of instances (empty if nothing matched the selector).- Removes a tag from the instance.
Parameters Parameter Description tag: stringThe tag to remove from the instance. Instance:ResetPropertyToDefault( property: string) Resets a property to its default value.Parameters Parameter Description property: stringName of the property to reset.Instance:SetAttribute( attribute: string, value: any) Sets the attribute with the given name to the given value.Instance:WaitForChild( childName: string, timeOut: number): Instance Returns the child of theInstancewith the given name. If the child does not exist, it will yield the current thread until it does.Parameters Parameter Description childName: stringTheInstance.Nameto be looked for.timeOut: numberAn optional time out parameter.- Deprecated: This item is deprecated in favor of
Instance:Destroy()andInstance:ClearAllChildren(). If you must remove an object from the game, and wish to use the object later, set itsParentproperty tonilinstead of using this method.
Sets the object'sParenttonil, and does the same for all its descendants. - Deprecated: This item has been superseded by
Instance:GetChildren()which should be used in all new work.
Returns an array of the object's children.Returns Type Description { Instance }Array of child objects/instances.Use GetChildren instead.
- Deprecated: This deprecated function is a variant of
Instance:Clone()which should be used instead.Returns Type InstanceUse Clone instead.
- Deprecated: This deprecated function is a variant of
Instance:Destroy()which should be used instead.Use Destroy instead.
Instance:findFirstChild( name: string, recursive: boolean? = false): Instance Deprecated: This deprecated function is a variant ofInstance:FindFirstChild()which should be used instead.Returns Type InstanceUse FindFirstChild instead.
- Deprecated: This deprecated function is a variant of
Instance:GetChildren()which should be used instead.Returns Type { Instance }Use GetChildren instead.
Instance:isDescendantOf( ancestor: Instance): boolean Deprecated: This deprecated function is a variant ofInstance:IsDescendantOf()which should be used instead.Parameters Parameter ancestor: InstanceReturns Type booleanUse IsDescendantOf instead.
- Deprecated: This deprecated function is a variant of
Instance:Remove()which has also been deprecated. Neither function should be used in new work.Use Remove instead.
Defined byStats11
Stats:GetBrowserTrackerId( ): string Returns Type stringStats:GetHarmonyQualityLevel( ): number Internal-only. Returns the engine's current dynamic-quality level as a score normalized from0to100.Returns Type Description numberThe current dynamic-quality level, normalized from0(lowest quality) to100(highest quality).Stats:GetMemoryCategoryNames( ): { any } Internal-only. Returns an array of the names of every developer memory category the engine tracks.Returns Type Description { any }An array of strings, one per tracked memory category, ordered to match the values returned byStats:GetMemoryUsageMbAllCategories().Stats:GetMemoryUsageMbAllCategories( ): { any } Returns the number of megabytes that are being consumed by all available categories, or an empty array ifMemoryTrackingEnabledisfalse.Returns Type Description { any }An array of numbers in which each entry is the memory, in megabytes, consumed by one memory category, ordered to match the categories returned byStats:GetMemoryCategoryNames(). Returns an empty array ifMemoryTrackingEnabledisfalse.Returns Type { any }Returns Type numberStats:GetMemoryUsageMbForTag( tag: Enum.DeveloperMemoryTag): number Returns the number of megabytes that are being consumed in the specifiedDeveloperMemoryTagcategory, or0ifMemoryTrackingEnabledisfalse.Parameters Parameter Description tag: Enum.DeveloperMemoryTagTheDeveloperMemoryTagmemory category to measure.Returns Type Description numberThe memory, in megabytes, consumed by the givenDeveloperMemoryTagcategory, or0ifMemoryTrackingEnabledisfalse.Stats:GetPaginatedMemoryByTexture(queryType: Enum.TextureQueryType,pageIndex: number,pageSize: number,): { [string]: any } Parameters Parameter queryType: Enum.TextureQueryTypepageIndex: numberpageSize: numberReturns Type { [string]: any }Stats:GetTotalMemoryUsageMb( ): number Returns the total amount of memory being consumed by the current game session, in megabytes.Returns Type Description numberThe total memory, in megabytes, used by the current game session, as reported by the operating system.- Internal-only. Restores the performance-control system's memory budget to the values in effect before
Stats:SetHarmonyMemoryTarget()was called. Stats:SetHarmonyMemoryTarget( targetMB: number) Internal-only. Overrides the performance-control system's memory budget with a target value, in megabytes, for testing.Parameters Parameter Description targetMB: numberThe memory budget to impose on the performance-control system, in megabytes.
No methods match the filters.
Events10
Object.Changed: RBXScriptSignal<( property: string)> Fires immediately after a property of the object changes, with some limitations.Parameters Parameter property: string
Instance.AncestryChanged: RBXScriptSignal<( child: Instance, parent: Instance)> Fires when theInstance.Parentproperty of this object or one of its ancestors is changed.Instance.AttributeChanged: RBXScriptSignal<( attribute: string)> Fires whenever an attribute is changed on theInstance.Parameters Parameter attribute: stringInstance.ChildAdded: RBXScriptSignal<( child: Instance)> Fires after an object is parented to thisInstance.Parameters Parameter child: InstanceInstance.ChildRemoved: RBXScriptSignal<( child: Instance)> Fires after a child is removed from thisInstance.Parameters Parameter child: InstanceInstance.DescendantAdded: RBXScriptSignal<( descendant: Instance)> Fires after a descendant is added to theInstance.Parameters Parameter descendant: InstanceInstance.DescendantRemoving: RBXScriptSignal<( descendant: Instance)> Fires immediately before a descendant of theInstanceis removed.Parameters Parameter descendant: Instance- Fires immediately before (or is deferred until after) the instance is destroyed via
Instance:Destroy(). - Fires whenever any style property is changed on the instance, including when a property is set to
nil. Instance.childAdded: RBXScriptSignal<( child: Instance)> Deprecated: This deprecated event is a variant ofInstance.ChildAddedwhich should be used instead.Parameters Parameter child: InstanceUse ChildAdded instead.
No events match the filters.