Skip to content

Class: MockPhysicsWorld

Mock of the X-Ray engine physics_world class for jest/node.

Implements

  • physics_world

Constructors

Constructor

ts
new MockPhysicsWorld(): MockPhysicsWorld;

Returns

MockPhysicsWorld

Methods

create()

ts
static create(gravity?: number): MockPhysicsWorld;

Parameters

ParameterTypeDefault value
gravitynumber9.81

Returns

MockPhysicsWorld


mock()

ts
static mock(gravity?: number): physics_world;

Parameters

ParameterTypeDefault value
gravitynumber9.81

Returns

physics_world

Properties

__name

ts
readonly __name: string = "physics_world";

add_call

ts
add_call: MockedFunction<(condition: CPHCondition, action: CPHAction) => void>;

Add a physics condition/action callback pair.

Remarks

This binding expects native CPHCondition and CPHAction objects; ordinary scripts usually use level.add_call instead.

Param

condition

Native physics condition object.

Param

action

Native physics action object.

Implementation of

ts
physics_world.add_call

gravity

ts
gravity: MockedFunction<() => number>;

Returns

Current world gravity.

Implementation of

ts
physics_world.gravity

gravityValue

ts
gravityValue: number = 9.81;

set_gravity

ts
set_gravity: MockedFunction<(value: number) => void>;

Set world gravity.

Param

value

Gravity value.

Implementation of

ts
physics_world.set_gravity