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

Physics

Physics

class Physics(shape: String = "box", linearVelocity: Vector3 = Vector3(0.0f), angularVelocity: Vector3 = Vector3(0.0f), dimensions: Vector3 = Vector3(0.5f), density: Float = 1.0f, restitution: Float = 0.2f, friction: FrictionObject = FrictionObject(0.5f, 0f, 0f), state: PhysicsState = PhysicsState.DYNAMIC, applyForce: Vector3 = Vector3(0.0f)) : ComponentBase

Constructors

NameSummary
Physics
constructor(shape: String = "box", linearVelocity: Vector3 = Vector3(0.0f), angularVelocity: Vector3 = Vector3(0.0f), dimensions: Vector3 = Vector3(0.5f), density: Float = 1.0f, restitution: Float = 0.2f, friction: FrictionObject = FrictionObject(0.5f, 0f, 0f), state: PhysicsState = PhysicsState.DYNAMIC, applyForce: Vector3 = Vector3(0.0f))

Types

NameSummary
Companion
object Companion : ComponentCompanion

Properties

NameSummary
angularVelocity
var angularVelocity: Vector3
applyForce
var applyForce: Vector3
cachable
val cachable: Boolean = false
creationTime
var creationTime: Long
density
var density: Float
densityInternal
var densityInternal: Float
dimensions
var dimensions: Vector3
friction
var friction: FrictionObject
frictionInternal
var frictionInternal: Vector3
isDirty
var isDirty: Boolean
linearVelocity
var linearVelocity: Vector3
recycled
var recycled: Boolean
restitution
var restitution: Float
shape
var shape: String
state
var state: PhysicsState

Functions

NameSummary
applyMaterial
fun applyMaterial(material: PhysicsMaterial): Physics
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

NameSummary
createDefaultInstance
open override val createDefaultInstance: () -> Physics
id
open override val id: <Error class: unknown class>

Functions

NameSummary
dependents
open fun dependents(): IntArray
Did you find this page helpful?
Thumbs up icon
Thumbs down icon
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2025 Meta