Logic playmovie: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
m (Some of these keyvalues and inputs aren't available in Alien Swarm and below, and are only available in Portal 2 and above, so I added some (New with Portal 2) to some of them. I also made some minor changes to the descriptions.)
Line 2: Line 2:


==Keyvalues==
==Keyvalues==
{{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, until told to stop.|since=p2}}
{{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.|since=p2}}
{{KV Targetname}}
{{KV Targetname}}


==Inputs==
==Inputs==
{{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.|since=p2}}
{{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|since=p2}}
{{IO|FadeAllMovies|Fade movies out for all players connected.}}
{{IO|FadeAllMovies|Fade movies out for all players connected.|since=p2}}
{{I Targetname}}
{{I Targetname}}



Revision as of 14:38, 10 January 2017

Template:Base point It plays a movie and allows for various playback options. It is not supported in Counter Strike: Global Offensive.

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> (in all games since Portal 2)
If set to true, the movie will loop forever, until told to stop.
Fade In Time ([todo internal name (i)]) <float> (in all games since Portal 2)
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  (in all games since Portal 2)
Play the movie for all connected players.
PlayLevelTransitionMovie <stringRedirectInput/string> (in all games since Portal 2)
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  (in all games since Portal 2)
Fade movies out for all players connected.


Outputs

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