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

EventArgs Class

Modifiers: open
Base class for event arguments passed through the Spatial SDK event system.
Carries the event name, associated data model, throttle configuration, and a handled flag to control event propagation.

Signature

open class EventArgs(val eventName: String, val dataModel: DataModel, var handled: Boolean = false, var throttleTime: Int? = null)

Constructors

EventArgs ( eventName , dataModel , handled , throttleTime )
Signature 
constructor(eventName: String, dataModel: DataModel, handled: Boolean = false, throttleTime: Int? = null)
Parameters
eventName: String
dataModel: DataModel  Data model.
handled: Boolean
throttleTime: Int?
Returns
EventArgs

Properties

dataModel : DataModel
[Get]
Data model.
Signature 
val dataModel: DataModel
eventName : String
[Get]
The string identifier for this event type, used to match registered Entity event listeners. Each EventArgs subclass defines its own event name constant for dispatch routing.
Signature 
val eventName: String
handled : Boolean
[Get][Set]
Flag indicating whether this event has been consumed by a listener. Set to true in an event handler to prevent further propagation to other listeners registered for the same event.
Signature 
var handled: Boolean
throttleTime : Int?
[Get][Set]
Minimum interval in milliseconds between consecutive dispatches of this event type. Events fired more frequently than this interval are silently dropped to prevent listener overload.
Signature 
var throttleTime: Int?
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta