HeapProfilerService¶

Not yet Class Services NotCreatable Service

Generates and retrieves Luau heap memory profiles from the client and server Luau virtual machines for memory debugging.

Not implemented yet

This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.

0 Nova members · 9 modern Roblox members not implemented yet

Description¶

HeapProfilerService captures snapshots of the Luau heap so that memory-profiling tools can analyze script memory usage. Requesting a profile runs a full garbage-collection cycle and then walks the heap of the target Luau virtual machine, producing a JSON report that breaks memory down by value type, memory category, and userdata class, together with an aggregated ownership graph and a list of unique and unparented instance references.

Profiles can be requested for either the server or a specific client. HeapProfilerService.ServerRequestDataAsync() returns the server's profile and HeapProfilerService.ClientRequestDataAsync() returns a given player's client profile. When the profiled machine differs from the caller, the data is generated remotely, compressed, and replicated back through the HeapProfilerService.OnNewData event before the yielding call resolves.

Inheritance¶

Object → Instance → HeapProfilerService

Methods¶

Member	Signature	Summary
`ClientRequestDataAsync`	`HeapProfilerService:ClientRequestDataAsync(player: Player): string`	Yields until the Luau heap profile of the specified player's client is available, then returns it as a JSON string.
`ServerRequestDataAsync`	`HeapProfilerService:ServerRequestDataAsync(): string`	Yields until the server's Luau heap profile is available, then returns it as a JSON string.

Events¶

Member	Signature	Summary
`OnNewData`	`OnNewData(player: Player, jsonString: buffer, id: int, compressedLength: int, uncompressedLength: int)`	Fires on the requesting machine with the compressed Luau heap profile produced for an earlier request.
`RequestData`	`RequestData(id: int)`	—

Roblox reference: HeapProfilerService

Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.