This article's documentation is for anything that uses the Source engine. Click here for more information.

logic_playmovie

From Valve Developer Community
Jump to navigation Jump to search
English (en)Translate (Translate)
Class hierarchy
CLogicPlayMovie
CLogicalEntity
CServerOnlyEntity
CBaseEntity
logic_playmovie.cpp

logic_playmovie is a point entity available in all Source Source games since Alien Swarm Alien Swarm. It plays a movie of .bik or .ivf format and allows for various playback options. It is not supported in Counter-Strike: Global Offensive Counter-Strike: Global Offensive

Keyvalues

Name (targetname) <string>
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 (MovieFilename) <string>
Filename of the movie to play.
Allow User to Skip (allowskip) <boolean>
Whether or not the user may skip the video with common keys.
Loop Video (loopvideo) <boolean> (in all games since Portal 2)
If set to true, the movie will loop forever, until told to stop.
Fade In Time (fadeintime) <float> (in all games since Portal 2)
Time it takes for the video to fade in.

Inputs

PlayMovie
Play the movie.
PlayMovieForAllPlayers  (in all games since Portal 2)
Play the movie for all connected players.
PlayLevelTransitionMovie <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.
__MovieFinished  !FGD
Triggers OnPlaybackFinished output. (set up internally to be fired when movie finishes or is stopped)

Outputs

OnPlaybackFinished
Fired when the movie has completed playing back or was skipped by the user.
OnSkip  (only in The Stanley Parable)
Fired when the movie was skipped by the user.