API reference
Grabbable
Grabbable
class Grabbable(enabled: Boolean = true, type: GrabbableType = GrabbableType.FACE, isGrabbed: Boolean = false, minHeight: Float = -Float.MAX_VALUE, maxHeight: Float = Float.MAX_VALUE) : ComponentBase
Grabbable is a component that allows an object to be grabbed by a controller. It requires the Mesh Component to be present.
Parameters
JVM
| Name | Summary |
|---|---|
enabled | Defines whether the object can be grabbed or not. |
type | The type of behavior an object has when grabbed (faces user, pivots on y axis, etc.) |
isGrabbed | Whether the object is currently grabbed or not |
minHeight | the minimum height an object can be held when grabbed |
maxHeight | the maximum height an object can be held when grabbed |
Constructors
| Name | Summary |
|---|---|
Grabbable | constructor(enabled: Boolean = true, type: GrabbableType = GrabbableType.FACE, isGrabbed: Boolean = false, minHeight: Float = -Float.MAX_VALUE, maxHeight: Float = Float.MAX_VALUE) |
Types
| Name | Summary |
|---|---|
Companion | object Companion : ComponentCompanion |
Properties
| Name | Summary |
|---|---|
cachable | open val cachable: Boolean = false |
creationTime | var creationTime: Long |
enabled | var enabled: Boolean Defines whether the object can be grabbed or not. |
isDirty | var isDirty: Boolean |
isGrabbed | var isGrabbed: Boolean Whether the object is currently grabbed or not |
maxHeight | var maxHeight: Float the maximum height an object can be held when grabbed |
minHeight | var minHeight: Float the minimum height an object can be held when grabbed |
recycled | var recycled: Boolean |
type | var type: GrabbableType The type of behavior an object has when grabbed (faces user, pivots on y axis, etc.) |
Functions
| Name | Summary |
|---|---|
getComponentDataAttributeType | fun getComponentDataAttributeType(key: Int): AttributePrimitive? fun getComponentDataAttributeType(keyString: String): AttributePrimitive? |
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 |
|---|---|
createDefaultInstance | open override val createDefaultInstance: () -> Grabbable |
enabledId | val enabledId: <Error class: unknown class> |
id | open override val id: <Error class: unknown class> |
isGrabbedId | val isGrabbedId: <Error class: unknown class> |
maxHeightId | val maxHeightId: <Error class: unknown class> |
minHeightId | val minHeightId: <Error class: unknown class> |
typeId | val typeId: <Error class: unknown class> |
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