vgui_movie_display

From Source Entities
Jump to navigation Jump to search

Code classes:

vgui_movie_display is a point entity present in all games since Asw.pngAlien Swarm. It's a computer-like screen that shows a video. Used in P2.png for elevator videos. If the video has audio in it, it will play with no volume falloff over distance, and in stereo. Does not work in Asw.pngCsgo-small.png.

Note: Disabled by default. Send the Enable input to see it.

Bug: P2.pngvideos restart when the game is paused and unpaused.

Bug: Audio stops noticeably late when disabling the entity.

Keyvalues[edit | edit source]

Display Text (displaytext) <string>
No effect.
Movie Filename (moviefilename) <string>
The BIK video file to show. Stock videos are in Portal 2/portal2/media/.
Group Name (groupname) <string>
Screens in the same group will synchronize their display with the first-created non-slave screen in their group. Slave screens show nothing if the master screen hasn't been on since the given screen was enabled. Slave screens will also show the last frame shown by the master screen if it was disabled.
Note: Screens showing the same bik are always synchronized regardless of this or any other setting.
Panel width (width) <integer>
How wide the panel is in world units.
Panel height (height) <integer>
How tall the panel is in world units.
Loop Movie (looping) <boolean>
Loops the movie indefinitely.
Stretch to Fill (stretch) <boolean> (available in all games since P2.png)
Stretches the movie to fit the set width and height. (Prevents black bars.)
Forced slave (forcedslave) <boolean> (available in all games since P2.png)
Does not allow this screen to be the one in its Group that other screens synchronize themselves with.
Force precache (forceprecache) <boolean> (available in all games since P2.png)
Precaches the movie when the entity spawns. To do: Realistically, is this ever worth doing or not doing?

Inputs[edit | edit source]

SetDisplayText
Sets Display Text.
Enable
Makes the entity active.
Disable
Makes the entity inactive.
SetMovie <string> (available in all games since P2.png)
No effect seen.
SetUseCustomUVs <boolean> (available in all games since P2.png)
Tells the video to crop itself according to values sent to it by the U/V Min/Max inputs.
SetUMin <float> (available in all games since P2.png)
If SetUseCustomUVs has been sent with the parameter 1, crops the left side of the video to this decimal percent of its width. 0.0 is fully left, 1.0 is fully right.
SetUMax <float> (available in all games since P2.png)
Crops the right side of the video.
SetVMin <float> (available in all games since P2.png)
Crops the top side of the video. 0.0 is all the way up, 1.0 is all the way down.
SetVMax <float> (available in all games since P2.png)
Crops the bottom side of the video.
TakeOverAsMaster  (available in all games since P2.png)
Makes this screen the one in its Group that other screens synchronize themselves with.

See Also[edit | edit source]