S2ENGINE HD  1.4.6
Official manual about S2Engine HD editor and programming

base class: SceneObject

Light.jpg

Overview

This is the base light object. Light can be of two types: omni and spot. They can also project textures.

Parameters
Texture(texture filename) filename of the projection texture. Can be empty.
Projtype(enumerative) Light projection type. There are 2 projection types:
PerspectiveSpot light. In the case of projection texture, the texture is projected perspective along light z axis
CubeOmni light. In the case of projection texture, the texture is cubic.
Radius(float)This is the maximum range of influence of the light. In case of omni light this is the radius of the light, in the case of spot light, this is the length of the light cone.
fov(float) works only for spotlights. This is the field of view, i.e. the base size, of light cone.
Fallof(float) fallof attenuation. Bigger value means sharper light borders.
LightScale(float)Used to increase the brightness of light.
Flash(boolean)If true the light is a flashing light
Flashingrate(float)Rate of light flashing. Works if flash flag is true
RandomFlash(boolean)If true the flashing of light have a random rate. Works only if flash param is true.
RotateBox(boolean) unused.

Receiving Messages

Name Description Content parameters
Action Turns light on if the it is off and off if it is on. Transition of the on/off state is smoothed and transition velocity depends on flashrate param. message#0: 'open'(turn on) or 'close'(turn off)string

Sending Messages

none

See also
Messages