API reference
Controller
Controller
class Controller(buttonState: Int = 0, changedButtons: Int = 0, isActive: Boolean = false, type: Int = 0, directTouchEnabled: Boolean = false, directTouchButtonState: Int = 0, laserEnabled: Boolean = true) : ComponentBase
Represents Controller Data and properties that can be used to facilitate input.
Parameters
JVM
| Name | Summary |
|---|---|
buttonState | The current state of the buttons being pressed represented by integer bits |
changedButtons | Which buttons (represented by integer bits) have been changed (pressed or unpressed) |
isActive | Whether the controller is active or not |
type | What type of controller it is: 0->controller 1->hand |
directTouchEnabled | Whether direct touch is enabled or not |
directTouchButtonState | The state of the direct touch buttons |
laserEnabled | Whether the laser is enabled or not |
Constructors
| Name | Summary |
|---|---|
Controller | constructor(buttonState: Int = 0, changedButtons: Int = 0, isActive: Boolean = false, type: Int = 0, directTouchEnabled: Boolean = false, directTouchButtonState: Int = 0, laserEnabled: Boolean = true) |
Types
| Name | Summary |
|---|---|
Companion | object Companion : ComponentCompanion |
Properties
| Name | Summary |
|---|---|
buttonState | var buttonState: Int The current state of the buttons being pressed represented by integer bits |
cachable | val cachable: Boolean = false |
changedButtons | var changedButtons: Int Which buttons (represented by integer bits) have been changed (pressed or unpressed since the last frame) |
creationTime | var creationTime: Long |
directTouchButtonState | var directTouchButtonState: Int The state of the direct touch buttons |
directTouchEnabled | var directTouchEnabled: Boolean |
isActive | var isActive: Boolean |
isDirty | var isDirty: Boolean |
laserEnabled | var laserEnabled: Boolean |
recycled | var recycled: Boolean |
type | var type: Int What type of controller it is: 0->controller 1->hand 2->eye |
Functions
| Name | Summary |
|---|---|
getComponentDataAttributeType | fun getComponentDataAttributeType(key: Int): AttributeType? fun getComponentDataAttributeType(keyString: String): AttributeType? |
getComponentDataKey | fun getComponentDataKey(key: String): Int? |
getComponentDataValue | fun getComponentDataValue(key: Int): Any? fun getComponentDataValue(keyString: String): Any? |
getEnumClass | fun getEnumClass(key: String): Class<out Enum<*>>? |
hasComponentData | fun hasComponentData(key: Int): Boolean fun hasComponentData(keyString: String): Boolean |
read | fun read(e: Entity, cachable: Boolean) |
recycle | fun recycle() |
reset | open fun reset() |
setComponentDataValue | fun setComponentDataValue(key: Int, value: Any?): Boolean fun setComponentDataValue(keyString: String, value: Any?): Boolean |
setPool | fun setPool(pool: ComponentPool<*>) |
toString | open override fun toString(): String |
typeID | open override fun typeID(): Int |
write | fun write(e: Entity) |
Companion
object Companion : ComponentCompanion
Properties
| Name | Summary |
|---|---|
CONTROLLER_TYPE | val CONTROLLER_TYPE: Int = 0 |
createDefaultInstance | open override val createDefaultInstance: () -> Controller |
EYES_TYPE | val EYES_TYPE: Int = 2 |
HAND_TYPE | val HAND_TYPE: Int = 1 |
id | open override val id: Int |
Functions
| Name | Summary |
|---|---|
dependents | open fun dependents(): IntArray |
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)
© 2025 Meta