Class: effector
Script-controlled post-process effector.
Source
C++ class effector
Custom Constructor
effector
Remarks
Subclass it from script and override process. The effector is tied to the actor camera stack.
Extends
Constructors
Constructor
new effector(type: number, time: number): effector;Parameters
| Parameter | Type | Description |
|---|---|---|
type | number | Unique post-process effector type id. |
time | number | Effector lifetime in seconds. |
Returns
effector
Remarks
Use a stable custom type id. finish removes the active effector by this type.
Overrides
Methods
finish()
finish(): void;Remove the effector from the actor camera stack.
Returns
void
Remarks
Removes by effector type, so sharing a type id with another active effector can remove the wrong effect.
process()
process(params: effector_params): boolean;Update post-process parameters for the current frame.
Parameters
| Parameter | Type | Description |
|---|---|---|
params | effector_params | Mutable post-process parameters. |
Returns
boolean
Whether the effector should continue running.
Remarks
Override this in script. Mutate params for the current frame and return false to stop the effector.
start()
start(): void;Add the effector to the actor camera stack.
Returns
void
Remarks
Requires an active actor. This is intended for in-game actor post-processing, not menu/editor code.
Properties
__name
readonly __name: string;LuaBind instance constructor name.
Inherited from
__name
readonly static __name: string;LuaBind class constructor name.