class VobLightData (client-side)
Available since version: 0.3.3.4
This class represents vob light data.
Properties
zarray& rangeAniScaleList
Represents the array containing range ani scale values (unused by the game).
zarray& colorAniList
Represents the array containing range ani scale values (unused by the game).
int lensFlareFXNo
Represents the lens flare effect index.
Color& lightColor
Represents the light color (alpha channel isn't being used).
float range
Represents the current light range (can be changed by updated light range animation).
float rangeInv (read-only)
Represents the current light range inverse (1.0 / range).
float rangeBackup (read-only)
Represents the backup light range (set only once, unaffected by the light range animation).
float rangeAniActFrame
Represents the active range animation frame (unused by the game).
float rangeAniFPS
Represents the range animation fps ratio (unused by the game).
float colorAniActFrame
Represents the color animation active frame.
float colorAniFPS
Represents the color animation fps ratio.
float spotConeAngleDeg
Represents the spotlight cone angle for static lights in degrees.
bool isStatic
Represents true when light is static, meaning that the light itself is baked into ZEN.
bool rangeAniSmooth
Represents true when range animation linear interpolation is enabled (unused by the game).
bool rangeAniLoop
Represents true when range animation should be looped (unused by the game).
bool colorAniSmooth
Represents true when color animation linear interpolation is enabled.
bool colorAniLoop
Represents true when color animation should be looped.
bool isTurnedOn
Represents true if light is turned on (trigger/untrigger events can change turned on state of the light).
int lightQuality
Represents the light quality. For more information see VobLight quality constants.
int lightType
Represents the light type. For more information see VobLight type constants.
bool canMove
Represents true if light can be moved (unused by the game).
Methods
static isRangeAnimated
This method checks if range animation is being currently played (unused by the game).
bool isRangeAnimated()
Returns bool:
static isColorAnimated
This method checks if color animation is being currently played (unused by the game).
bool isColorAnimated()
Returns bool:
static setLensFlareFXName
This method sets the used lens flare effect name.
bool setLensFlareFXName(string lensFlareFX)
Parameters:
stringlensFlareFX: the name of the lens flare effect.
Returns bool:
true if the lens flare fx was set successfully, otherwise false.
static getLensFlareFXName
This method gets the used lens flare effect name.
string getLensFlareFXName()
Returns string:
Callbacks
No callbacks.