API reference
ButtonHoverEventArgs
class ButtonHoverEventArgs(val isStart: Boolean, val dataModel: DataModel) : EventArgs
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 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
}
}
Constructors
| Name | Summary |
|---|---|
ButtonHoverEventArgs | constructor(isStart: Boolean, dataModel: DataModel) |
Types
| Name | Summary |
|---|---|
Companion | object Companion |
Properties
| Name | Summary |
|---|---|
dataModel | val dataModel: DataModel |
eventName | val eventName: String |
handled | var handled: Boolean |
isStart | val isStart: Boolean True if the hover is starting, false if it’s ending |
throttleTime | var throttleTime: Int? |
Companion
object Companion
Properties
| Name | Summary |
|---|---|
EVENT_NAME | const val EVENT_NAME: String The name of the hover event, used when registering event listeners. |
Functions
| Name | Summary |
|---|---|
fromHitInfo | fun fromHitInfo(isStart: Boolean, dataModel: DataModel): ButtonHoverEventArgs Creates a ButtonHoverEventArgs instance. |
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2026 Meta