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

Logic playmovie: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Changed parameters of {{this is a}} to comply with the updated version. This action was performed by a bot.)
(Added OnSkip output from The Stanley Parable)
Line 17: Line 17:
==Outputs==
==Outputs==
{{IO|OnPlaybackFinished|Fired when the movie has completed playing back or was skipped by the user.}}
{{IO|OnPlaybackFinished|Fired when the movie has completed playing back or was skipped by the user.}}
{{IO|OnSkip|only={{tsp}}|Fired when the movie was skipped by the user.}}
{{O Targetname}}
{{O Targetname}}

Revision as of 20:05, 30 May 2024

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

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.
OnSkip  (only in The Stanley Parable)
Fired when the movie was skipped by the user.