Class PhysicsBody

Typed, fluent wrapper around a Phaser Arcade physics body. Eliminates the as unknown as cast pattern and adds config validation.

Example

const body = new PhysicsBody(scene, sprite, { drag: 300, collideWorldBounds: true });
body.setVelocity(200, 0).setBounce(0.5);

Example

// Attach to an object that already has physics enabled
const body = PhysicsBody.from(existingSprite);
if (body) body.setVelocityX(100);

Constructors

constructor

new PhysicsBody(
    scene: Scene,
    obj: GameObject,
    config?: PhysicsBodyConfig,
): PhysicsBody
Parameters
- scene: Scene
- obj: GameObject
- config: PhysicsBodyConfig = {}
Returns PhysicsBody
- Defined in packages/clik-engine/src/physics/PhysicsBody.ts:48

Accessors

isOnCeiling

get isOnCeiling(): boolean
True when the body is pressed against a ceiling

Returns boolean
- Defined in packages/clik-engine/src/physics/PhysicsBody.ts:234

isOnFloor

get isOnFloor(): boolean
True when the body is resting on a floor

Returns boolean
- Defined in packages/clik-engine/src/physics/PhysicsBody.ts:229

isOnLeftWall

get isOnLeftWall(): boolean
True when the body is against a wall on the left

Returns boolean
- Defined in packages/clik-engine/src/physics/PhysicsBody.ts:239

isOnRightWall

get isOnRightWall(): boolean
True when the body is against a wall on the right

Returns boolean
- Defined in packages/clik-engine/src/physics/PhysicsBody.ts:244

isStatic

get isStatic(): boolean
Whether this body was created as static

Returns boolean
- Defined in packages/clik-engine/src/physics/PhysicsBody.ts:131

raw

get raw(): Body
The underlying Phaser Arcade body — escape hatch for advanced use

Returns Body
- Defined in packages/clik-engine/src/physics/PhysicsBody.ts:126

velocity

get velocity(): Phaser.Math.Vector2
Returns Phaser.Math.Vector2
- Defined in packages/clik-engine/src/physics/PhysicsBody.ts:163

Methods

impulse

impulse(x: number, y: number): this
Add an instant velocity delta (impulse)
Parameters
- x: number
- y: number
Returns this
- Defined in packages/clik-engine/src/physics/PhysicsBody.ts:220

setAllowGravity

setAllowGravity(allow: boolean): this
Parameters
- allow: boolean
Returns this
- Defined in packages/clik-engine/src/physics/PhysicsBody.ts:189

setBodySize

setBodySize(
    width: number,
    height: number,
    offsetX?: number,
    offsetY?: number,
): this
Parameters
- width: number
- height: number
- offsetX: number = 0
- offsetY: number = 0
Returns this
- Defined in packages/clik-engine/src/physics/PhysicsBody.ts:206

setBounce

setBounce(x: number, y?: number): this
Parameters
- x: number
- y: number = x
Returns this
- Defined in packages/clik-engine/src/physics/PhysicsBody.ts:174

setCircle

setCircle(radius: number, offsetX?: number, offsetY?: number): this
Parameters
- radius: number
- offsetX: number = 0
- offsetY: number = 0
Returns this
- Defined in packages/clik-engine/src/physics/PhysicsBody.ts:212

setCollideWorldBounds

setCollideWorldBounds(collide?: boolean): this
Parameters
- collide: boolean = true
Returns this
- Defined in packages/clik-engine/src/physics/PhysicsBody.ts:199

setDrag

setDrag(x: number, y?: number): this
Parameters
- x: number
- y: number = x
Returns this
- Defined in packages/clik-engine/src/physics/PhysicsBody.ts:169

setFriction

setFriction(x: number, y?: number): this
Parameters
- x: number
- y: number = x
Returns this
- Defined in packages/clik-engine/src/physics/PhysicsBody.ts:179

setGravityY

setGravityY(gravity: number): this
Parameters
- gravity: number
Returns this
- Defined in packages/clik-engine/src/physics/PhysicsBody.ts:184

setImmovable

setImmovable(immovable?: boolean): this
Parameters
- immovable: boolean = true
Returns this
- Defined in packages/clik-engine/src/physics/PhysicsBody.ts:194

setMaxVelocity

setMaxVelocity(x: number, y?: number): this
Parameters
- x: number
- y: number = x
Returns this
- Defined in packages/clik-engine/src/physics/PhysicsBody.ts:158

setVelocity

setVelocity(x: number, y: number): this
Parameters
- x: number
- y: number
Returns this
- Defined in packages/clik-engine/src/physics/PhysicsBody.ts:137

setVelocityX

setVelocityX(x: number): this
Parameters
- x: number
Returns this
- Defined in packages/clik-engine/src/physics/PhysicsBody.ts:148

setVelocityY

setVelocityY(y: number): this
Parameters
- y: number
Returns this
- Defined in packages/clik-engine/src/physics/PhysicsBody.ts:153

`Static`from

from(obj: GameObject): PhysicsBody | null
Wrap the physics body of a game object that already has physics enabled. Returns null if the object has no body yet.
Parameters
- obj: GameObject
Returns PhysicsBody | null
- Defined in packages/clik-engine/src/physics/PhysicsBody.ts:112

Class PhysicsBody

Example

Example

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns PhysicsBody

Accessors

isOnCeiling

Returns boolean

isOnFloor

Returns boolean

isOnLeftWall

Returns boolean

isOnRightWall

Returns boolean

isStatic

Returns boolean

raw

Returns Body

velocity

Returns Phaser.Math.Vector2

Methods

impulse

Parameters

Returns this

setAllowGravity

Parameters

Returns this

setBodySize

Parameters

Returns this

setBounce

Parameters

Returns this

setCircle

Parameters

Returns this

setCollideWorldBounds

Parameters

Returns this

setDrag

Parameters

Returns this

setFriction

Parameters

Returns this

setGravityY

Parameters

Returns this

setImmovable

Parameters

Returns this

setMaxVelocity

Parameters

Returns this

setVelocity

Parameters

Returns this

setVelocityX

Parameters

Returns this

setVelocityY

Parameters

Returns this

Staticfrom

Parameters

Returns PhysicsBody | null

Settings

On This Page

`Static`from