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

ButtonHoverMoveEventArgs Class

Extends EventArgs
 Modifiers: final
Event arguments for hover movement events.
ButtonHoverMoveEventArgs is used to pass information about hover movement interactions through the event system. It contains a HitInfo object that provides details about the interaction, such as the hit point, normal, and distance.
This class is typically used when registering event listeners for hover movement events on entities, allowing components to respond to continuous hover movements over an object.
Example usage: 
// Register a hover movement event listener on an entity
entity.registerEventListener<ButtonHoverMoveEventArgs>(ButtonHoverMoveEventArgs.EVENT_NAME) { entity, eventArgs ->
    // Handle the hover movement event
    val hitPoint = eventArgs.hitInfo.hitPoint
    // Update UI elements based on hover position
    updateCursorPosition(hitPoint)
    // Or perform other hover-related interactions
    updateHoverFeedback(eventArgs.hitInfo)
}

Signature

class ButtonHoverMoveEventArgs(val hitInfo: HitInfo, val dataModel: DataModel) : EventArgs

Constructors

ButtonHoverMoveEventArgs ( hitInfo , dataModel )
Signature 
constructor(hitInfo: HitInfo, dataModel: DataModel)
Parameters
hitInfo: HitInfo  Information about the hit/interaction during the hover movement
dataModel: DataModel  The data model associated with this event
Returns
ButtonHoverMoveEventArgs

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
hitInfo : HitInfo
[Get]
Information about the hit/interaction during the hover movement
Signature 
val hitInfo: HitInfo
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]
The name of the hover movement event, used when registering event listeners.
Signature 
const val EVENT_NAME: String

Methods

fromHitInfo ( hitInfo , dataModel )
Creates a ButtonHoverMoveEventArgs instance from a HitInfo object and DataModel.
This factory method provides a convenient way to create ButtonHoverMoveEventArgs instances when sending events.
Signature 
fun fromHitInfo(hitInfo: HitInfo, dataModel: DataModel): ButtonHoverMoveEventArgs
Parameters
hitInfo: HitInfo  Information about the hit/interaction during the hover movement
dataModel: DataModel  The data model associated with this event
Returns
ButtonHoverMoveEventArgs  A new ButtonHoverMoveEventArgs instance
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta