API reference
API reference
Select your platform
No SDKs available
No versions available

OVRMetricsSystem Class

Extends SystemBase
 Modifiers: final

Signature

class OVRMetricsSystem(metrics: List<OVRMetric> = emptyList(), overlayMessages: Map<String, () -> String> = emptyMap()) : SystemBase

Constructors

OVRMetricsSystem ( metrics , overlayMessages )
Signature 
constructor(metrics: List<OVRMetric> = emptyList(), overlayMessages: Map<String, () -> String> = emptyMap())
Parameters
metrics: List
overlayMessages: Map
Returns

Properties

defineIntervalInMillis : Long
[Get]
Signature 
val defineIntervalInMillis: Long = 5000
executeCount : Long
[Get]
The number of times the system has been executed.
Signature 
var executeCount: Long
isDisabled : Boolean
[Get][Set]
Signature 
var isDisabled: Boolean
isMetricsDefined : Boolean
[Get][Set]
Signature 
var isMetricsDefined: Boolean
lastTimeInMillis : Long
[Get][Set]
Signature 
var lastTimeInMillis: Long
overlayMessageKeys : Set
[Get]
Returns an immutable copy of the currently registered overlay message keys.
Signature 
val overlayMessageKeys: Set<String>
registeredMetrics : List
[Get]
Returns an immutable copy of the currently registered metrics.
Signature 
val registeredMetrics: List<OVRMetric>
submitIntervalInMillis : Long
[Get]
Signature 
val submitIntervalInMillis: Long = 1000
systemManager : SystemManager
[Get][Set]
The system manager that this system is associated with.
Signature 
lateinit var systemManager: SystemManager

Functions

associateSystemManager ( systemManager )
Associates this system with a system manager, used in the Spatial SDK.
Signature 
fun associateSystemManager(systemManager: SystemManager)
Parameters
systemManager: SystemManager
  The system manager to associate with.
delete ( entity )
System should do any housekeeping based on SystemBase.delete being removed from the scene
Signature 
open fun delete(entity: Entity)
Parameters
entity: Entity
destroy ()
System should clean up any and all resources for shutdown
Signature 
open fun destroy()
equals ( other )
Checks if this system is equal to another object.
Signature 
open operator override fun equals(other: Any?): Boolean
Parameters
other: Any?
  The object to compare with.
Returns
Boolean
  True if this system is equal to the other object, false otherwise.
execute ()
System should perform all the operations based on relevant entities.
Signature 
open override fun execute()
getDependencies ()
Returns the dependencies of this system.
Signature 
open fun getDependencies(): SystemDependencies?
Returns
  The dependencies of this system, or null if there are no dependencies.
getScene ()
Returns the scene that this system is associated with.
Signature 
fun getScene(): Scene
Returns
  The scene that this system is associated with.
hashCode ()
Returns the hash code of this system.
Signature 
open override fun hashCode(): Int
Returns
Int
  The hash code of this system.
registerMetric ( metric )
Registers a new metric at runtime. If metrics have already been defined with OVRMetricsTool, they will be redefined to include the new metric.
Signature 
fun registerMetric(metric: OVRMetric)
Parameters
metric: OVRMetric
  The metric to register
registerMetrics ( newMetrics )
Registers multiple metrics at runtime. If metrics have already been defined with OVRMetricsTool, they will be redefined to include the new metrics.
Signature 
fun registerMetrics(newMetrics: List<OVRMetric>)
Parameters
newMetrics: List
  The metrics to register
registerOverlayMessage ( key , message )
Registers a new overlay message at runtime with a unique key. The message will be displayed in subsequent overlay updates. If a message with the same key already exists, it will be replaced.
Signature 
fun registerOverlayMessage(key: String, message: () -> String)
Parameters
key: String
  A unique identifier for this overlay message
message: Function0
  A function that returns the message string to display
unregisterMetric ( name )
Unregisters a metric by its name at runtime. If metrics have already been defined with OVRMetricsTool, they will be redefined without the removed metric.
Signature 
fun unregisterMetric(name: String): Boolean
Parameters
name: String
  The name of the metric to unregister (matches OVRMetricDefinition.Name)
Returns
Boolean
  true if the metric was found and removed, false otherwise
unregisterOverlayMessage ( key )
Unregisters an overlay message by its key.
Signature 
fun unregisterOverlayMessage(key: String): Boolean
Parameters
key: String
  The key of the overlay message to unregister
Returns
Boolean
  true if the message was found and removed, false otherwise
Did you find this page helpful?
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta