API reference

PointerEvent Class

Data class representing a pointer event.

Signature

class PointerEvent(
    val source: Entity,
    val type: Int,
    val hitInfo: HitInfo,
    val scrollInfo: Vector2 = Vector2(),
    val semanticType: Int = SemanticType.Unknown.id,
    val pointerType: Int = 0,
    val eventId: Int = 0,
)

Constructors

PointerEvent ( source , type , hitInfo , scrollInfo , semanticType , pointerType , eventId )
Signature
constructor(
    source: Entity,
    type: Int,
    hitInfo: HitInfo,
    scrollInfo: Vector2 = Vector2(),
    semanticType: Int = SemanticType.Unknown.id,
    pointerType: Int = 0,
    eventId: Int = 0,
)
Parameters
source: Entity  The entity that received the pointer event.
type: Int  See PointerEventType enum
hitInfo: HitInfo  Hit information: 3D for 3D objects and 2D for panels.
scrollInfo: Vector2  Optional scroll amount (used for thumbstick scrolling).
semanticType: Int  See SemanticType enum.
pointerType: Int
eventId: Int
Returns
PointerEvent

Properties

eventId : Int
[Get]
Signature
val eventId: Int = 0
hitInfo : HitInfo
[Get]
Signature
val hitInfo: HitInfo
pointerType : Int
[Get]
Signature
val pointerType: Int = 0
scrollInfo : Vector2
[Get]
Signature
val scrollInfo: Vector2
semanticType : Int
[Get]
Signature
val semanticType: Int
source : Entity
[Get]
Signature
val source: Entity
type : Int
[Get]
Signature
val type: Int