Reference API Roblox

Engine API

Website

Related

Reference API Roblox

MicroProfilerService

A service that connects the engine's MicroProfiler to the data model, feeding context into profile dumps and letting privileged scripts capture them to disk.

This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
Memory categoryInstances
Tags: [NotCreatable, Service, NotReplicated]

Member index 6

HistoryMember
686ContextLabel: string
697DumpToFileAsync(secondsToDelay: int, framesToDump: int): string
723GetDataInRange(slotId: int, offset: int, size: int, destBuffer: buffer, destBufferOffset: int): int
723GetDataSize(slotId: int): int
723ProcessCommand(cmdBuf: buffer, cmdOffset: int, cmdSize: int, respBuf: buffer, respOffset: int, respSize: int): int
723DataChanged(slotId: int, flags: int)
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
723IsInSandbox: bool
553Name: string
553Parent: Instance
702PredictionMode: PredictionMode
670Sandboxed: bool
680UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

History 7

Members 6

ContextLabel

TypeDefault
string
SecurityRobloxScriptSecurity
Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 1

DataChanged

Parameters (2)
slotIdint
flagsint

This event is not intended for direct use. Instead, use LibMP, which consumes it internally and provides a richer, higher-level Luau API for accessing MicroProfiler data.

Thread safetyUnsafe

History 1

DumpToFileAsync

Parameters (2)
secondsToDelayint
framesToDumpint
Returns (1)
string
This function yields. It will block the calling thread until completion.
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

Tags: [Yields]

GetDataInRange

Parameters (5)
slotIdint
offsetint
sizeint
destBufferbuffer
destBufferOffsetint
Returns (1)
int

This method is not intended for direct use. Instead, use LibMP, which calls it internally and provides a richer, higher-level Luau API for accessing MicroProfiler data.

This function has a custom internal state. It may behave in a non-standard way.
Thread safetyUnsafe

History 1

Tags: [CustomLuaState]

GetDataSize

Parameters (1)
slotIdint
Returns (1)
int

This method is not intended for direct use. Instead, use LibMP, which calls it internally and provides a richer, higher-level Luau API for accessing MicroProfiler data.

Thread safetyUnsafe

History 1

ProcessCommand

Parameters (6)
cmdBufbuffer
cmdOffsetint
cmdSizeint
respBufbuffer
respOffsetint
respSizeint
Returns (1)
int

This method is not intended for direct use. Instead, use LibMP, which calls it internally and provides a richer, higher-level Luau API for accessing MicroProfiler data.

This function has a custom internal state. It may behave in a non-standard way.
Thread safetyUnsafe

History 1

Tags: [CustomLuaState]

Settings