textmode.js / Textmodifier / pointLight

Method: pointLight()

Call Signature

pointLight(
   v1, 
   v2, 
   v3, 
   x, 
   y, 
   z): void;

Add a point light using RGB components and explicit XYZ position.

Point lights are frame-scoped and reset each layer draw callback. Up to five point lights are supported per frame. Additional calls are ignored.

Parameters

Parameter	Type	Description
v1	number	Red component (0-255)
v2	number	Green component (0-255)
v3	number	Blue component (0-255)
x	number	World-space X position
y	number	World-space Y position
z	number	World-space Z position

Returns

void

Example

Call Signature

pointLight(
   v1, 
   v2, 
   v3, 
   position): void;

Add a point light using RGB components and an object position.

Parameters

Parameter	Type	Description
v1	number	Red component (0-255)
v2	number	Green component (0-255)
v3	number	Blue component (0-255)
position	{ x: number; y: number; z: number; }	World-space position
position.x	number	World-space X position
position.y	number	World-space Y position
position.z	number	World-space Z position

Returns

void

Call Signature

pointLight(
   color, 
   x, 
   y, 
   z): void;

Add a point light using a color value and explicit XYZ position.

Lighting uses RGB only, so any provided alpha value is ignored.

Parameters

Parameter	Type	Description
color	| string | [number, number, number] | [number, number, number, number] | TextmodeColor	Color value (CSS string, TextmodeColor, or RGB(A) array)
x	number	World-space X position
y	number	World-space Y position
z	number	World-space Z position

Returns

void

Call Signature

pointLight(color, position): void;

Add a point light using a color value and an object position.

Parameters

Parameter	Type	Description
color	| string | [number, number, number] | [number, number, number, number] | TextmodeColor	Color value (CSS string, TextmodeColor, or RGB(A) array)
position	{ x: number; y: number; z: number; }	World-space position
position.x	number	World-space X position
position.y	number	World-space Y position
position.z	number	World-space Z position

Returns

void