Class: MockEffector

Mock of a generic X-Ray engine effector class for jest/node.

Implements

• effector

Constructors

Constructor

new MockEffector(type: number, time: number): MockEffector;

Parameters

Parameter	Type
type	number
time	number

Returns

MockEffector

Methods

create()

static create(type: number, time: number): MockEffector;

Parameters

Parameter	Type
type	number
time	number

Returns

MockEffector

---

mock()

static mock(type: number, time: number): effector;

Parameters

Parameter	Type
type	number
time	number

Returns

effector

Properties

__name

__name: string = "effector";

LuaBind instance constructor name.

Implementation of

effector.__name

---

finish

finish: Mock<UnknownFunction>;

Remove the effector from the actor camera stack.

Remarks

Removes by effector type, so sharing a type id with another active effector can remove the wrong effect.

Implementation of

effector.finish

---

process

process: Mock<(params: effector_params) => boolean>;

Update post-process parameters for the current frame.

Remarks

Override this in script. Mutate params for the current frame and return false to stop the effector.

Param

params

Mutable post-process parameters.

Returns

Whether the effector should continue running.

Implementation of

effector.process

---

start

start: Mock<UnknownFunction>;

Add the effector to the actor camera stack.

Remarks

Requires an active actor. This is intended for in-game actor post-processing, not menu/editor code.

Implementation of

effector.start

---

time

time: number;

---

type

type: number;