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

OVRMetricsTickTrackingSystem Class

Extends SystemBase
 Modifiers: final
System for tracking tick rate performance metrics.
This system measures ticks-per-second (TPS) and maximum tick time, which can be used for performance monitoring and debugging. The tick data is updated every tick in execute().

Signature

class OVRMetricsTickTrackingSystem : SystemBase

Constructors

OVRMetricsTickTrackingSystem ()
Signature 
constructor()
Returns

Properties

currentTPS : Int
[Get]
Current ticks per second as a rolling average, updated once per second.
Signature 
var currentTPS: Int
executeCount : Long
[Get]
The number of times the system has been executed.
Signature 
var executeCount: Long
maxTickTimeDurationSeconds : Int
[Get]
Duration in seconds over which max tick time is tracked. Default is 1 second.
Signature 
var maxTickTimeDurationSeconds: Int
maxTickTimeMs : Int
[Get]
Maximum tick time in milliseconds during the last measurement period.
Signature 
var maxTickTimeMs: Int
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.
setMaxTickTimeDuration ( durationSeconds )
Sets the duration in seconds over which max tick time is tracked.
Signature 
fun setMaxTickTimeDuration(durationSeconds: Int)
Parameters
durationSeconds: Int
  The number of seconds to track max tick time over (minimum 1)
setTPSSampleCount ( sampleCount )
Sets the number of samples to use for the TPS rolling average.
Signature 
fun setTPSSampleCount(sampleCount: Int)
Parameters
sampleCount: Int
  The number of samples to average over (minimum 1)
Did you find this page helpful?
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta