Vgui movie display: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (→‎Inputs: Added more inputs used in video_splitter.nut)
m (Implemented some templates)
Line 1: Line 1:
{{portal2 point|vgui_movie_display}}
{{portal2 point|vgui_movie_display}}


==Entity Description==
==Entity description==
This entity is used to display Bink videos on a wall.
This entity is used to display Bink videos on a wall.


Line 8: Line 8:
{{KV Parentname}}
{{KV Parentname}}
{{KV Angles}}
{{KV Angles}}
; Display Text <code><[[string]]></code>
{{KV|Display Text|string}}
: {{todo}}
{{KV|Movie Filename|string|Path to the Bink video file, located in "media/"}}
; Movie Filename <code><[[string]]></code>
{{KV|Group Name|string}}
: Path to the Bink video file, located in "media/"
{{KV|Loop Movie|boolean|If true, the movie will be played in an endless loop.}}
; Group Name <code><[[string]]></code>
{{KV|Panel width|integer|Width of the panel in units.}}
: {{todo}}
{{KV|Panel height|integer|Height of the panel in units.}}
; Loop Movie <code><[[boolean]]></code>
{{KV|Stretch|boolean}}
: If true, the movie will be played in an endless loop.
{{KV|Force precache|boolean}}
; Panel width <code><[[int]]></code>
{{KV|Forced slave|boolean}}
: Width of the panel in units.
; Panel height <code><[[int]]></code>
: Height of the panel in units.
; stretch <code><[[boolean]]></code>
: {{todo}}
; forceprecache <code><[[boolean]]></code>
: {{todo}}
; forcedslave <code><[[boolean]]></code>
: {{todo}}


==Inputs==
==Inputs==
Line 31: Line 22:
{{I Parentname}}
{{I Parentname}}
{{I EnableDisable}}
{{I EnableDisable}}
; <code>SetDisplayText <[[string]]></code>
{{IO|SetDisplayText|Sets the display text.|param=string}}
: Sets the display text.
{{IO|SetMovie|Sets the displayed movie.|param=string}}
; <code>SetMovie <[[string]]></code>
{{IO|SetUseCustomUVs|param=boolean}}
: Sets the displayed movie.
{{IO|SetUMin|param=float}}
; <code>SetUseCustomUVs <[[boolean]]></code>
{{IO|SetUMax|param=float}}
: {{todo}}
{{IO|SetVMin|param=float}}
; <code>SetUMin <[[float]]></code>
{{IO|SetVMax|param=float}}
: {{todo}}
; <code>SetUMax <[[float]]></code>
: {{todo}}
; <code>SetVMin <[[float]]></code>
: {{todo}}
; <code>SetVMax <[[float]]></code>
: {{todo}}


==Outputs==
==Outputs==
{{O Targetname}}
{{O Targetname}}

Revision as of 14:51, 3 May 2011

Template:Portal2 point

Entity description

This entity is used to display Bink videos on a wall.

Keyvalues

Name (targetname) <string>[ Edit ]
The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report.
See also:  Generic Keyvalues, Inputs and Outputs available to all entities

Parentname:
Parent (parentname) <targetname>
Specifies a movement parent. An entity will maintain its initial offset from its parent. An attachment point can be added to the end of the name, separated by a comma.
Pitch Yaw Roll (Y Z X) (angles) <QAngle>
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.
Display Text ([todo internal name (i)]) <string>
Movie Filename ([todo internal name (i)]) <string>
Path to the Bink video file, located in "media/"
Group Name ([todo internal name (i)]) <string>
Loop Movie ([todo internal name (i)]) <boolean>
If true, the movie will be played in an endless loop.
Panel width ([todo internal name (i)]) <integer>
Width of the panel in units.
Panel height ([todo internal name (i)]) <integer>
Height of the panel in units.
Stretch ([todo internal name (i)]) <boolean>
Force precache ([todo internal name (i)]) <boolean>
Forced slave ([todo internal name (i)]) <boolean>

Inputs

Parentname:
SetParent <stringRedirectInput/string>
Move with this entity. See Entity Hierarchy (parenting).
SetParentAttachment <stringRedirectInput/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 <stringRedirectInput/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.

EnableDisable:

Enable / Disable
Enable/disable this entity from performing its task. It might also disappear from view.
SetDisplayText <stringRedirectInput/string>
Sets the display text.
SetMovie <stringRedirectInput/string>
Sets the displayed movie.
SetUseCustomUVs <booleanRedirectInput/boolean>
SetUMin <floatRedirectInput/float>
SetUMax <floatRedirectInput/float>
SetVMin <floatRedirectInput/float>
SetVMax <floatRedirectInput/float>

Outputs

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Vgui_movie_display&oldid=149279"