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

ButtonReleaseEventArgs

ButtonReleaseEventArgs

class ButtonReleaseEventArgs(val hitInfo: HitInfo, val button: ControllerButton, val dataModel: DataModel) : EventArgs
Event arguments for button release events.
ButtonReleaseEventArgs is used to pass information about a button release interaction through the event system. It contains a HitInfo object that provides details about the interaction, such as the hit point, normal, and distance, as well as the specific ControllerButton that was released.
This class is typically used when registering event listeners for button release events on entities, allowing components to respond to specific button release inputs.
Example usage:
// Register a button release event listener on an entity
entity.registerEventListener<ButtonReleaseEventArgs>(ButtonReleaseEventArgs.EVENT_NAME) { entity, eventArgs ->
    // Handle the button release event
    val hitPoint = eventArgs.hitInfo.hitPoint
    val button = eventArgs.button

    // Perform actions based on which button was released
    when (button) {
        ControllerButton.A -> handleAButtonRelease()
        ControllerButton.LeftTrigger -> handleLeftTriggerRelease()
        // Handle other buttons...
    }
}

Constructors

NameSummary
ButtonReleaseEventArgs
constructor(hitInfo: HitInfo, button: ControllerButton, dataModel: DataModel)

Types

NameSummary
Companion
object Companion

Properties

NameSummary
button
val button: ControllerButton

The specific controller button that was released
dataModel
val dataModel: DataModel
eventName
val eventName: String
handled
var handled: Boolean
hitInfo
val hitInfo: HitInfo

Information about the hit/interaction that triggered the button release
throttleTime
var throttleTime: Int?

Companion

object Companion

Properties

NameSummary
EVENT_NAME
const val EVENT_NAME: String

The name of the button release event, used when registering event listeners.

Functions

NameSummary
fromHitInfo
fun fromHitInfo(hitInfo: HitInfo, dataModel: DataModel, changed: Int): ButtonReleaseEventArgs

Creates a ButtonReleaseEventArgs instance from a HitInfo object, DataModel, and button identifier.
Did you find this page helpful?
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta