Difference between revisions of "Vgui movie display"

From Valve Developer Community
Jump to: navigation, search
(General updates and P2CE info)
(webm and bik do not appear, seems broken)
Line 2: Line 2:
  
 
{{portal2 point|vgui_movie_display}} This entity is used to display videos in the world. Portal 2 uses the Bink format for videos, while {{game link|Portal 2: Community Edition}} uses the WebM format.
 
{{portal2 point|vgui_movie_display}} This entity is used to display videos in the world. Portal 2 uses the Bink format for videos, while {{game link|Portal 2: Community Edition}} uses the WebM format.
 
{{todo|This entity is also in CS:GO's FGD. Is it implemented in-game, and does it work? Test it with WebMs in csgo/panorama/videos}}
 
  
 
A movie screen is typically a brush face textured with elevator/elevator_screen or one of its variants. Make sure you click "Fit" in the Texture Application Tool.
 
A movie screen is typically a brush face textured with elevator/elevator_screen or one of its variants. Make sure you click "Fit" in the Texture Application Tool.
Line 10: Line 8:
 
{{bug|The video restarts when pausing and unpausing the game.}}
 
{{bug|The video restarts when pausing and unpausing the game.}}
 
{{bug|The movie display does not fade into [[fog]], and rarely is visible through walls.}}
 
{{bug|The movie display does not fade into [[fog]], and rarely is visible through walls.}}
 +
{{bug|Non-functional in {{csgo}}.}}
  
 
=== Stretching movies across multiple screens ===
 
=== Stretching movies across multiple screens ===

Revision as of 16:33, 21 November 2020

[Portal 2] vgui_movie_display is a point entity available in Portal 2. This entity is used to display videos in the world. Portal 2 uses the Bink format for videos, while Portal 2: Community Edition Portal 2: Community Edition uses the WebM format.

A movie screen is typically a brush face textured with elevator/elevator_screen or one of its variants. Make sure you click "Fit" in the Texture Application Tool.

Note.png Note: If the video has sound, it will be heard at full volume everywhere in the map.
Bug.png Bug: The video restarts when pausing and unpausing the game.
Bug.png Bug: The movie display does not fade into fog, and rarely is visible through walls.
Bug.png Bug: Non-functional in Counter-Strike: Global Offensive.

Stretching movies across multiple screens

The master/slave keyvalues and U/V inputs on the entity can be used to stretch a movie across multiple displays. The usual setup for this involves one vgui_movie_display with "_master" at the end of its targetname, which then controls a group of slave vgui_movie_displays that have "Forced Slave" enabled and the same "Group Name" as the master entity.

Place a slave vgui_movie_display for each screen at the lower-left corner of the face. Change the width and height to match each panel. The U/V inputs can be used to set which part of the image is displayed on each screen.

To start the movie, fire an "Enable" input at all vgui_movie_display entities; wildcards are useful for this.

Elevator videos

Valve includes a system for selecting elevator videos in custom maps. The arrival_departure_transition_ents instance includes a pair of instance parameters which can be used to set the arrival and departure videos respectively. The video_splitter.nut VScript will automatically handle setting the correct U/Vs.

To do: No longer works since the Perpetual Testing Initiative update. Are there any good community-made alternatives?

Property Name Value
Fix up Name
VMF Filename instances/transitions/arrival_departure_transition_ents.vmf
Replace $arrival_video media/faithplate.bik
Replace $departure_video media/animalking.bik

The video_splitter script also contains a list of all singleplayer campaign maps and which videos each map should play. For mods, it is recommended to add the mod's maps to this list. Single maps should continue to use the method above.

Keyvalues

Display Text <string>
Unknown use, appears non-functional.
Movie Filename <string>
Path to the video file, located in media/. Portal 2 uses Bink (.bik) videos, while P2CE uses WebM (.webm) videos. See List of Portal 2 Movies for a list of default videos in Portal 2 (P2CE also includes WebM versions of these).
Group Name <string>
What group of vgui_movie_display entities it belongs to.
Loop Movie <boolean>
If true, the movie will be played in an endless loop.
Stretch to Fill <boolean>
If true, will resize the movie to fill the screen.
Forced slave <boolean>
Whether this is a "slave" vgui_movie_display that takes command from the master.
Force precache <boolean>
Precache the movie referred to by Movie Filename on entity spawn.
Panel width <integer>
Width of the panel in units.
Panel height <integer>
Height of the panel in units.


Base:

Name (targetname) <string>
The name that other entities use to refer to this entity.
Parent (parentname) <targetname>
Maintain the same initial offset to this entity. An attachment point can also be used if separated by a comma at the end. (parentname [targetname],[attachment])
Tip.png Tip: Entities transition to the next map with their parents
Tip.png Tip: phys_constraintcan be used as a workaround if parenting fails.
Global Entity Name (globalname) <string>
When the player transitions to a new map, entities in the new map with matching globalnames will have their previous map's states copied over to it.
Origin (X Y Z) (origin) <coordinates>
The position of this entity's center in the world. Rotating entities typically rotate around their origin.
Note.png Note: Hammer does not move the entities accordingly only in the editor.
Pitch Yaw Roll (X Y Z) (angles) <angle>
This entity's orientation in the world. Pitch is rotation around the Y axis, yaw is the rotation around the Z axis, roll is the rotation around the X axis.
Note.png Note: This works on brush entities, although Hammer doesn't show the new angles.
Response Contexts (ResponseContext) <string>
Pre-defined response system contexts; Format is [key]:[value],[key]:[value],...and so on.
Tip.png Tip: Can also be filtered for or against!
Classname (classname) <string> !FGD
Determines the characteristics of the entity before it spawns.
Tip.png Tip: Changing classnames using theAddOutputinput can still influence the game's code, like making the classname match one element in the S_PreserveEnts list will make the entity persists on new rounds!
Flags (spawnflags) <integer> !FGD
Toggles exclusive features of an entity, its specific number is determined by the combination of flags added.
Effects (effects) <integer> !FGD
Combination of effect flags to use.
Hammer ID (hammerid) <integer> !FGD
The entity's unique Hammer ID that's auto-generated on map compiles. Mainly used by plugins or debugging commands (like theent_keyvaluecommand). Run-time spawned entities don't have a Hammer ID.
Entity Scripts (vscripts) <scriptlist> (in all games since <Left 4 Dead 2>)
Space delimited list of VScript files (without file extension) that are executed after all entities have spawned. The scripts are all executed in the same script scope, later ones overwriting any identical variables and functions.
Script think function (thinkfunction) <string> (in all games since <Left 4 Dead 2>)
Name of a function in this entity's script which will be called automatically every 100 milliseconds (ten times a second) for the duration of the script. It can be used to create timers or to simulate autonomous behavior. The return value (if present) will set the time until the next call. Try to avoid expensive operations in this function, as it may cause performance problems.
Lag Compensation (LagCompensate) <boolean> (in all games since <Left 4 Dead 2>) !FGD
Set to Yes to lag compensate this entity. Should be used very sparingly!
Disable for Xbox 360 (disableX360) <boolean> (in all games since <Left 4 Dead 2>) !FGD
If this entity should automatically be given the 'Disable' input on the Xbox 360 version of Source.


Inputs

Enable
Make movie visible.
Disable
Make movie invisible.
SetDisplayText <string>
Sets the display text. Appears non-functional.
SetMovie <string>
Sets the movie to display.
SetUseCustomUVs <boolean>
Use custom UVs.
TakeOverAsMaster
Start using this video as the master of it's group.
SetUMin <float>
Set the minimum U.
SetUMax <float>
Set the maximum U.
SetVMin <float>
Set the minimum V.
SetVMax <float>
Set the maximum V.

Base:

AddOutput <string>
Evaluates a keyvalue/output on this entity.
Format: <key> <value>
Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire, -1 means infinite>
Kill
Removes this entity and any entities parented to it from the world.
KillHierarchy
Functions the same as Kill, although this entity and any entities parented to it are killed on the same frame, being marginally faster thanKillinput.
SetParent <string>
Move with this entity. See Entity Hierarchy (parenting).
SetParentAttachment <string>
Change this entity to attach to a specific attachment point on its parent. The entity will teleport so that the position of its root bone matches that of the attachment. Entities must be parented before being sent this input.
SetParentAttachmentMaintainOffset <string>
As above, but without teleporting. The entity retains its position relative to the attachment at the time of the input being received.
ClearParent
Removes this entity from the the movement hierarchy, leaving it free to move independently.
FireUser1 to FireUser4
Fire the OnUser outputs; see User Inputs and Outputs.
AddContext <string>
Adds to the entity's list of response contexts. Format is <key>:<value>.
RemoveContext <string>
Remove a context from this entity's list. The name should match the key of an existing context.
ClearContext <string>
Removes all contexts from this entity's list.
DispatchEffect <string> !FGD
Dispatches a special effect from the entity's origin.
DispatchResponse <string> !FGD
Dispatches a response to the entity. See Response and Concept.
Use  !FGD
Same as a player invoking +use; may not do anything. Can also be invoked by creating an output that does not specify an input.
This input is not included in Valve's FGDs.
RunScriptFile <script> (in all games since <Left 4 Dead 2>)
Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.
RunScriptCode <string> (in all games since <Left 4 Dead 2>)
Execute a string of VScript source code in the scope of the entity receiving the input. String quotation may be needed when fired via console.
Bug.png Bug: In <Left 4 Dead 2>, the code is executed in the script scope of the entity that fires the output, not the one receiving the input.
Warning.png Warning: Never try to pass string parameters to a script function with this input. It will corrupt the VMF structure because of the nested quotation marks, which then must be removed manually with a text editor.
CallScriptFunction <string> (in all games since <Left 4 Dead 2>) !FGD
Execute a VScript function in the scope of the receiving entity.
SetLocalOrigin <coordinates> (in all games since <Alien Swarm>) !FGD
Send this entity to a spot in the map. If the entity is parented to something, it will be offset from the parent by this amount.
SetLocalAngles <angles> (in all games since <Alien Swarm>) !FGD
Set this entity's angles.
SetTeam  !FGD <Obsolete>
Deprecated. Doesn't do anything in <Left 4 Dead> <Left 4 Dead 2> or <Counter-Strike: Source>.
TeamNum  !FGD <Obsolete>
Deprecated. Doesn't do anything in <Left 4 Dead> <Left 4 Dead 2> or <Counter-Strike: Source>.


Outputs

Base:

OnUser1 to OnUser4
These outputs each fire in response to the firing of the like-numbered FireUser1 to FireUser4 Input; see User Inputs and Outputs.