Logic playmovie: Difference between revisions
		
		
		
		
		
		Jump to navigation
		Jump to search
		
				
		
 
		
	
|  (Added OnSkip output from The Stanley Parable) | m (Substituted IO templates) | ||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| {{LanguageBar}} | |||
| {{CD|CLogicPlayMovie|file1=1}} | |||
| {{this is a|point entity|name=logic_playmovie|since=Alien Swarm}} It plays a movie of .bik or .ivf format and allows for various playback options. It is not supported in {{csgo|4}} | {{this is a|point entity|name=logic_playmovie|since=Alien Swarm}} It plays a movie of .bik or .ivf format and allows for various playback options. It is not supported in {{csgo|4}} | ||
| ==Keyvalues== | ==Keyvalues== | ||
| {{KV Targetname}} | {{KV Targetname}} | ||
| {{KV|Movie to play|intn=MovieFilename|string|Filename of the movie to play.}} | |||
| {{KV|Allow User to Skip|intn=allowskip|boolean|Whether or not the user may skip the video with common keys.}} | |||
| {{KV|Loop Video|intn=loopvideo|boolean|If set to true, the movie will loop forever, until told to stop.|since=p2}} | |||
| {{KV|Fade In Time|intn=fadeintime|float|Time it takes for the video to fade in.|since=p2}} | |||
| ==Inputs== | ==Inputs== | ||
| {{ | {{I|PlayMovie|Play the movie.}} | ||
| {{ | {{I|PlayMovieForAllPlayers|Play the movie for all connected players.|since=p2}} | ||
| {{ | {{I|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}} | ||
| {{ | {{I|FadeAllMovies|Fade movies out for all players connected.|since=p2}} | ||
| {{I  | {{I|__MovieFinished|nofgd=1|Triggers OnPlaybackFinished output. (set up internally to be fired when movie finishes or is stopped) }} | ||
| ==Outputs== | ==Outputs== | ||
| {{ | {{O|OnPlaybackFinished|Fired when the movie has completed playing back or was skipped by the user.}} | ||
| {{ | {{O|OnSkip|only={{tsp}}|Fired when the movie was skipped by the user.}} | ||
Latest revision as of 23:06, 20 April 2025

 
|  Class hierarchy | 
|---|
| CLogicPlayMovie | 
|  logic_playmovie.cpp | 
logic_playmovie  is a   point entity  available in all  Source games since
 Source games since  Alien Swarm. It plays a movie of .bik or .ivf format and allows for various playback options. It is not supported in
 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>[ Edit ]
- The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentnameortarget).
 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  ) )
- If set to true, the movie will loop forever, until told to stop.
Inputs
- PlayMovie
- Play the movie.
- PlayMovieForAllPlayers   (in all games since  ) )
- Play the movie for all connected players.
- PlayLevelTransitionMovie  <string> (in all games since  ) )
- 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  ) )
- 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.

























