VPX Documentation
Light
4min
variables variables are items in vpx you can set, adjust or call call detail example name(string) x(float) y(float) shape(shape) 0=circle, 1=custom falloff(float) falloffpower(float) state(lightstate) 0=off, 1=on, 2=blinking color(ole color) 'normal' color colorfull(ole color) full brightness color intensity(float) sets the lights brightness/emission intensityscale(float) sets the lights brightness/emission scale, so that one can fade in/out all affected lights with the same scaling factor transmissionscale(float) sets the light scale for transmission, f e through playfield plastics or transparent ramps that are placed above the bulb light 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) blinkpattern(string) off/on pattern for the light to use while the interval is going 1 is on, 0 is off, for example 111000111000101010101 blinkinterval(int) surface(string) uservalue(any) can store any user defined value for re use later on image(string) imagemode(bool) if true, passthrough image (as if it would be fully emissive), otherwise light image with global lighting using the attached surface material depthbias(float) fadespeedup(float) speed to fade into on state fadespeeddown(float) speed to fade into off state bulb(bool) showbulbmesh(bool) staticbulbmesh(bool) showreflectiononball(bool) in bulb mode, en/disable the reflection of the bulb on balls scalebulbmesh(float) bulbmodulatevsadd(float) blends between modulating and additive when bulb is enabled (0 1) bulbhaloheight(float) sets the halo height of a bulb light visible(bool) methods methods are procedures or actions that you can fire in vpx call detail example duration(int startstate, int durationtime, int endstate) starts a light in startstate and leaves it into that state for the amount of milliseconds defined by durationtime until the light switches to the endstate light1 duration 2, 1000, 1 (light starts to blink for 1000ms and then switches to on) events event detail example init timer dispinterface ilightevents { properties methods \[id(dispid gameevents init)] void init(); \[id(dispid timerevents timer)] void timer(); }