Logic playmovie: Difference between revisions

Revision as of 01:55, 11 May 2011

Plays a movie and allows for various playback options.

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

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

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.

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

@@ Line 6: / Line 6: @@
 ==Keyvalues==
 {{KV Targetname}}
+{{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|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}}
 ==Inputs==
 {{I Targetname}}
 {{IO|PlayMovie|Play the movie.}}
+{{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|FadeAllMovies|Fade movies out for all players connected.}}
 ==Outputs==
 {{O Targetname}}
 {{IO|OnPlaybackFinished|Fired when the movie has completed playing back or was skipped by the user.}}