VPX Documentation

Flasher

2min

Variables

Variables are items in vpx you can set, adjust or call.

Call

Detail

Example

Name(string)





TimerEnabled(bool)





TimerInterval(int)

set interval for triggering the timer (1 equals 1000 timer calls per second, 1000 equals 1 timer call per second, -1 makes it dependent on the FPS that a user can reach)



ImageA(string)

texture name for image A



ImageB(string)

texture name for image B



Filter(string)

use one of the following filters to blend ImageA > ImageB: 'None', 'Additive', 'Multiply', 'Overlay', 'Screen' (filter names are case sensitive!) this feature only works if you defined both images



Amount(int)

defines the filter amount how much of ImageB is filtered over ImageA in percent (0..100, can be set to >100 though)



Mode

0=ImageModeWorld, 1=ImageModeWrap



DisplayTexture(bool)





Opacity(int)

lets you define the blend amount 0..100% (you can use values >100% though to for example enhance the strength of flashers in additive alpha blending mode)



IntensityScale(float)

sets the flashers brightness/emission scale, so that one can fade in/out all affected flashers with the same scaling factor



Color

defines the color of the element in the editor. If you don't want to colorize the image set the color to blank white (RGB 255,255,255)



Visible(bool)

shows/hides the flasher



AddBlend(bool)

use additive alpha blending instead of classical alpha blending



ImageAlignment





ModulateVsAdd(float)

blends between modulating and additive when bulb is enabled (0..1)



DMD(bool)

enable DMD image via script connection



UserValue(any)

can store any user defined value for re-use later-on



Events

Event

Detail

Example

_Init





_Timer













Updated 25 Mar 2024
Doc contributor
Did this page help you?