API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

I

interfaceAttachOptions

@codexo/exojs-physics / physics / stable

PhysicsWorld.attach convenience options: a body type plus a single collider, attached to a scene node in one call.

13
props
0
methods
0
events
Import
import { AttachOptions } from '@codexo/exojs-physics'

PhysicsWorld.attach convenience options: a body type plus a single collider, attached to a scene node in one call.

Properties13
angle?: number
Initial rotation (radians) of the body. Default the node's current WORLD rotation at attach time.
density?: number
Collider density (mass per px²). Default 1.
filter?: Partial<CollisionFilterPer-collider collision filter. A pair is considered for collision only when each collider's mask includes the other's category. A non-zero group overrides cate…>
Category/mask/group collision filter; partials merge over the defaults.
fixedRotation?: boolean
When true, the body never rotates under contacts. Default false.
friction?: number
Coulomb friction coefficient. Default 0.2.
gravityScale?: number
Per-body multiplier on world gravity. Default 1.
isSensor?: boolean
When true, the collider generates overlap events but no contact response. Default false.
offset?: Readonly<PointLikeStructural type for any object with a 2D `x`/`y` position.>
Body-local offset of the collider. Default (0, 0).
position?: Readonly<PointLikeStructural type for any object with a 2D `x`/`y` position.>
Initial world position of the body. Default the node's current WORLD position (SceneNode.getWorldTransform) at attach time.
restitution?: number
Restitution / bounciness in [0, 1]. Default 0.
rotation?: number
Body-local rotation of the collider (radians). Default 0.
shape: AnyShapeDiscriminated union of the concrete shape kinds. Narrow via the literal `shape.type` discriminant (`'circle'` → CircleShape, `'capsule'` → CapsuleShape, `'poly…
The collider geometry.
type?: BodyTypeSimulation role of a PhysicsBody. - `dynamic` - fully simulated (finite mass); moved by the solver once dynamics ship, and by `setTransform` meanwhile. - `stat…
Simulation role of the created body. Default 'dynamic'.
Source
packages/exojs-physics/src/PhysicsWorld.ts