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

ButtonHoverMoveEventArgs

ButtonHoverMoveEventArgs

class ButtonHoverMoveEventArgs(val hitInfo: HitInfo, val dataModel: DataModel) : EventArgs
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)
}

Constructors

NameSummary
ButtonHoverMoveEventArgs
constructor(hitInfo: HitInfo, dataModel: DataModel)

Types

NameSummary
Companion
object Companion

Properties

NameSummary
dataModel
val dataModel: DataModel
eventName
val eventName: String
handled
var handled: Boolean
hitInfo
val hitInfo: HitInfo

Information about the hit/interaction during the hover movement
throttleTime
var throttleTime: Int?

Companion

object Companion

Properties

NameSummary
EVENT_NAME
const val EVENT_NAME: String

The name of the hover movement event, used when registering event listeners.

Functions

NameSummary
fromHitInfo
fun fromHitInfo(hitInfo: HitInfo, dataModel: DataModel): ButtonHoverMoveEventArgs

Creates a ButtonHoverMoveEventArgs instance from a HitInfo object and DataModel.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2025 Meta