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

SplatLoadEventArgs Class

Extends EventArgs
 Modifiers: final
Event arguments dispatched when a Gaussian Splat asset completes loading on an entity. Register an event listener on the entity to receive this callback and perform post-load setup (e.g., adjusting transforms, triggering animations). Extends EventArgs and is dispatched via the standard entity event system.

Signature

class SplatLoadEventArgs(val success: Boolean, val errorMessage: String? = null, val dataModel: DataModel) : EventArgs

Constructors

SplatLoadEventArgs ( success , errorMessage , dataModel )
Signature 
constructor(success: Boolean, errorMessage: String? = null, dataModel: DataModel)
Parameters
success: Boolean
errorMessage: String?
dataModel: DataModel
Returns
SplatLoadEventArgs

Properties

dataModel : DataModel
[Get]
Data model.
Signature 
val dataModel: DataModel
errorMessage : String?
[Get]
Human-readable description of why the Gaussian Splat asset failed to load, or null if loading succeeded. Check the success flag before reading this value to determine if an error occurred.
Signature 
val errorMessage: String? = null
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
success : Boolean
[Get]
Indicates whether the Gaussian Splat asset loaded successfully. When false, check errorMessage for details about the failure. Always verify this flag before using the loaded splat data.
Signature 
val success: 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?

Companion Object

Properties

EVENT_NAME : String
[Get]
Signature 
const val EVENT_NAME: String

Methods

failure ( errorMessage , dataModel )
Signature 
fun failure(errorMessage: String, dataModel: DataModel): SplatLoadEventArgs
Parameters
errorMessage: String
dataModel: DataModel
Returns
SplatLoadEventArgs
success ( dataModel )
Signature 
fun success(dataModel: DataModel): SplatLoadEventArgs
Parameters
dataModel: DataModel
Returns
SplatLoadEventArgs
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta