PhysicsAPI
Defined in: packages/threeplay/src/plugins/physics/types.ts:193
API of the physics plugin.
Methods
Section titled “Methods”area()
Section titled “area()”area(
opts?):AreaComp
Defined in: packages/threeplay/src/plugins/physics/types.ts:196
Parameters
Section titled “Parameters”Returns
Section titled “Returns”body()
Section titled “body()”body(
opts?):BodyComp
Defined in: packages/threeplay/src/plugins/physics/types.ts:197
Parameters
Section titled “Parameters”Returns
Section titled “Returns”character()
Section titled “character()”character(
opts?):CharacterComp
Defined in: packages/threeplay/src/plugins/physics/types.ts:198
Parameters
Section titled “Parameters”Returns
Section titled “Returns”getGravity()
Section titled “getGravity()”getGravity():
Vector3
Defined in: packages/threeplay/src/plugins/physics/types.ts:201
Returns
Section titled “Returns”Vector3
onCollide()
Section titled “onCollide()”onCollide(
tagA,tagB,fn):EventController
Defined in: packages/threeplay/src/plugins/physics/types.ts:205
When an object with tagA starts touching one with tagB.
Parameters
Section titled “Parameters”string
string
(a, b, col) => void
Returns
Section titled “Returns”onCollideEnd()
Section titled “onCollideEnd()”onCollideEnd(
tagA,tagB,fn):EventController
Defined in: packages/threeplay/src/plugins/physics/types.ts:215
Parameters
Section titled “Parameters”string
string
(a, b) => void
Returns
Section titled “Returns”onCollideUpdate()
Section titled “onCollideUpdate()”onCollideUpdate(
tagA,tagB,fn):EventController
Defined in: packages/threeplay/src/plugins/physics/types.ts:210
Parameters
Section titled “Parameters”string
string
(a, b, col) => void
Returns
Section titled “Returns”raycast()
Section titled “raycast()”raycast(
origin,dir,maxDist?,opts?):RaycastHit|null
Defined in: packages/threeplay/src/plugins/physics/types.ts:203
First object hit by a ray.
Parameters
Section titled “Parameters”origin
Section titled “origin”maxDist?
Section titled “maxDist?”number
Returns
Section titled “Returns”RaycastHit | null
setGravity()
Section titled “setGravity()”setGravity(
g):void
Defined in: packages/threeplay/src/plugins/physics/types.ts:200
Gravity: a number pulls down (−Y) with that strength (default 20).
Parameters
Section titled “Parameters”number | Vec3Like
Returns
Section titled “Returns”void
Properties
Section titled “Properties”physics
Section titled “physics”
readonlyphysics:PhysicsBackend
Defined in: packages/threeplay/src/plugins/physics/types.ts:195
The physics backend (escape hatch: physics.world, physics.native).