Logic playmovie: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Updated with data from the official portal2.fgd)
m (Re-arranged some fields)
Line 5: Line 5:


==Keyvalues==
==Keyvalues==
{{KV Targetname}}
{{KV|Movie to play|string|Filename of the movie to play}}
{{KV|Movie to play|string|Filename of the movie to play}}
{{KV|Allow User to Skip|boolean|Whether or not the user may skip the video with common keys}}
{{KV|Allow User to Skip|boolean|Whether or not the user may skip the video with common keys}}
{{KV|Loop Video|boolean|If set to true, the movie will loop forever}}
{{KV|Loop Video|boolean|If set to true, the movie will loop forever}}
{{KV|Fade In Time|float|Time it takes for the video to fade in}}
{{KV|Fade In Time|float|Time it takes for the video to fade in}}
{{KV Targetname}}


==Inputs==
==Inputs==
{{I Targetname}}
{{IO|PlayMovie|Play the movie.}}
{{IO|PlayMovie|Play the movie.}}
{{IO|PlayMovieForAllPlayers|Play the movie for all connected players.}}
{{IO|PlayMovieForAllPlayers|Play the movie for all connected players.}}
{{IO|PlayLevelTransitionMovie|Plays a movie with specific settings used for level transitions.  Pass the name of the movie in the parameters.  To be fired at the end of a level.|param=string}}
{{IO|PlayLevelTransitionMovie|Plays a movie with specific settings used for level transitions.  Pass the name of the movie in the parameters.  To be fired at the end of a level.|param=string}}
{{IO|FadeAllMovies|Fade movies out for all players connected.}}
{{IO|FadeAllMovies|Fade movies out for all players connected.}}
{{I Targetname}}


==Outputs==
==Outputs==
{{IO|OnPlaybackFinished|Fired when the movie has completed playing back or was skipped by the user.}}
{{O Targetname}}
{{O Targetname}}
{{IO|OnPlaybackFinished|Fired when the movie has completed playing back or was skipped by the user.}}

Revision as of 01:13, 13 May 2011

Template:Portal2 point

Entity description

Plays a movie and allows for various playback options.

Keyvalues

Movie to play ([todo internal name (i)]) <string>
Filename of the movie to play
Allow User to Skip ([todo internal name (i)]) <boolean>
Whether or not the user may skip the video with common keys
Loop Video ([todo internal name (i)]) <boolean>
If set to true, the movie will loop forever
Fade In Time ([todo internal name (i)]) <float>
Time it takes for the video to fade in
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

Inputs

PlayMovie
Play the movie.
PlayMovieForAllPlayers
Play the movie for all connected players.
PlayLevelTransitionMovie <stringRedirectInput/string>
Plays a movie with specific settings used for level transitions. Pass the name of the movie in the parameters. To be fired at the end of a level.
FadeAllMovies
Fade movies out for all players connected.


Outputs

OnPlaybackFinished
Fired when the movie has completed playing back or was skipped by the user.