vgui_slideshow_display
 Class hierarchy
|
|---|
| CSlideshowDisplay |
slideshow_display.cpp
|
vgui_slideshow_display is a point entity available in all 
Source games. It is a VGUI screen that displays images in a slideshow.
Creation Notes
- Place it in the lower left corner of where you want the screen and rotate it so that the red axis points which way you want the screen to face.
- You'll need to move it slightly away from the surface it sits on to avoid Z-fighting. 1 unit is enough.
- Images in sub directories will NOT be included.
Adding Slides to Slideshow
- Keywords are added in the vmt like so: "%keywords" "test1, test2, another_sample_keyword, cow, animal"
- AddSlides can be used up to 16 times in succession to add addition slides. So you can add "cow" slides and then add "chicken" slides if you want both cows and chickens to be in the shuffle.
- Slides are first shuffled by keyword. So if you have 400 "cow" slides and 10 "chicken" slides there's still a 1 out of 2 chance that you'll see a chicken. Then if "chicken" is selected for display there's a 1 out of 10 chance that you'll see any specific chicken.
- The same keyword can be added multiple times to weight which slides are more common. So you could add "cow", "cow", "cow", "chicken" and you'll be 3 times more likely to see a cow in the shuffle than a chicken.
- Setting the cycle type to forward will display all the added images in order by keyword (in the order that the keywords were added), then in alphabetical order for each slide in the keyword.
Keyvalues
- Name
(targetname)<string> - The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g.
parentnameortarget).
Also displayed in Hammer's 2D views and Entity Report.See also: Generic Keyvalues, Inputs and Outputs available to all entities
- Display Text
(displaytext)<string> - Text to display on top of the image.
- Image Directory (materials/vgui/...)
(directory)<string> - Directory where images are located (materials/vgui/[directory]).
- Min Slide Time
(minslidetime)<float> - Minimum amount of random time that a slide is displayed.
- Max Slide Time
(maxslidetime)<float> - Maximum amount of random time that a slide is displayed.
- Cycle Type
(cycletype)<choices> - Order that images are displayed.
- 0 : Random
- 1 : Forward
- 2 : Backward
- No List Repeat
(nolistrepeat)<choices> -
- 0 : Allow List Repeats
- 1 : No List Repeats
- Panel width
(width)<integer> - Width of the panel in units.
- Panel height
(height)<integer> - Height of the panel in units.
Inputs
Enable- Make slideshow visible.
Disable- Make slideshow invisible.
SetDisplayText<string>- Sets the display text.
RemoveAllSlides- Removes all slides from slideshow.
AddSlides<string>- Adds slides by keyword.
SetMinSlideTime<float>- Sets min random time between slides.
SetMaxSlideTime<float>- Sets max random time between slides.
SetCycleType<integer>- 0 - random, 1 - forward, 2 - backward
SetNoListRepeat<boolean>- Sets if lists can be randomly picked twice in a row.
