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

ButtonHoverEventArgs Class

Extends EventArgs
 Modifiers: final
Event arguments for hover events.
ButtonHoverEventArgs is used to pass information about hover interactions through the event system. It indicates whether a hover interaction is starting or ending via the ButtonHoverEventArgs.isStart property.
This class is typically used when registering event listeners for hover events on entities, allowing components to respond when a controller begins or ends hovering over an object.
Example usage: 
// Register a hover event listener on an entity
entity.registerEventListener<ButtonHoverEventArgs>(ButtonHoverEventArgs.EVENT_NAME) { entity, eventArgs ->
    // Handle the hover event
    if (eventArgs.isStart) {
        // Controller has started hovering over this entity
    } else {
        // Controller has stopped hovering over this entity
    }
}

Signature

class ButtonHoverEventArgs(val isStart: Boolean, val dataModel: DataModel) : EventArgs

Constructors

ButtonHoverEventArgs ( isStart , dataModel )
Signature 
constructor(isStart: Boolean, dataModel: DataModel)
Parameters
isStart: Boolean
  True if the hover is starting, false if it's ending
dataModel: DataModel
  The data model associated with this event
Returns

Properties

dataModel : DataModel
[Get]
Signature 
val dataModel: DataModel
eventName : String
[Get]
Signature 
val eventName: String
handled : Boolean
[Get][Set]
Signature 
var handled: Boolean
isStart : Boolean
[Get]
True if the hover is starting, false if it's ending
Signature 
val isStart: Boolean
throttleTime : Int?
[Get][Set]
Signature 
var throttleTime: Int?

Companion Object

Companion Object Properties

EVENT_NAME : String
[Get]
The name of the hover event, used when registering event listeners.
Signature 
const val EVENT_NAME: String

Companion Object Functions

fromHitInfo ( isStart , dataModel )
Creates a ButtonHoverEventArgs instance.
This factory method provides a convenient way to create ButtonHoverEventArgs instances when sending events.
Signature 
fun fromHitInfo(isStart: Boolean, dataModel: DataModel): ButtonHoverEventArgs
Parameters
isStart: Boolean
  True if the hover is starting, false if it's ending
dataModel: DataModel
  The data model associated with this event
Returns
  A new ButtonHoverEventArgs instance
Did you find this page helpful?
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta