Reference API Roblox

Engine API

Website

Related

Reference API Roblox

StopWatchReporter

A service that times named tasks and reports their durations, classified by device platform and country code. Not available to creator scripts.

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 3

HistoryMember
583FinishTask(taskId: int): null
583SendReport(reportName: string): null
583StartTask(reportName: string, taskName: string): 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

Not available to creator scripts. StopWatchReporter is used by the Roblox app to measure the duration of logic flows. Each measurement is classified by device platform and country code.

The service groups timing measurements into named reports. Starting a task begins timing a named task within a report and returns an integer task ID; finishing a task stops that task's timer; and sending a report finalizes it, submitting the elapsed time of each finished task and preventing any further tasks from being added to that report.

Timing is only collected on the Android and iOS clients; on other platforms these methods do nothing and starting a task returns -1.

History 12

Members 3

FinishTask

Parameters (1)
taskIdint
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 4

SendReport

Parameters (1)
reportNamestring
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 4

StartTask

Parameters (2)
reportNamestring
taskNamestring
Returns (1)
int
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 4

Settings