Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:47:50Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Pregame}}
Starts playing the intro cinematic on the pregame screens.

<pre>
PregamePlayCinematic()
</pre>

== Arguments ==
None.

== Returns ==
Nothing.

== Details ==
* The call only works in the pregame state while the character select screen is set up. At any other time it does nothing.
* It also does nothing unless the conditions of [[API:CanPlayCinematic|CanPlayCinematic]] are met: the video file <code>videos/Cinematic1_720p.bik</code> must exist in the game archives, and the sound system, if it exists, must be ready for video.
* The video is played into the texture named <code>title_screen_video</code>. The stock window <code>EA_Window_CinematicDisplay</code> (<code>interfacecore/source/cinematicwindow.xml</code>) shows that texture in a DynamicImage, so a window like it must be shown for the video to be visible.
* While the video plays, the client stops the pregame theme music and sets the same flag as <code>[[API:PregameBlockMouseOver|PregameBlockMouseOver]](true)</code>. The previous value of the flag is remembered.
* If the video cannot be opened, nothing is played.
* Use [[API:PregameStopCinematic|PregameStopCinematic]] to end playback.

== Errors ==
None.

== Example ==
From <code>interfacecore/source/cinematicwindow.lua</code>:
<pre>
function EA_Window_CinematicDisplay.Show()
if ( CanPlayCinematic() )
then
if ( DoesWindowExist( "EA_Window_CinematicDisplay" ) )
then
WindowSetShowing("EA_Window_CinematicDisplay", true)
else
CreateWindow("EA_Window_CinematicDisplay", true)
end
PregamePlayCinematic()
else
-- offer to open the cinematic web page instead
end
end
</pre>

== See also ==
* [[API:PregameStopCinematic|PregameStopCinematic]]
* [[API:CanPlayCinematic|CanPlayCinematic]]
* [[API:PregameBlockMouseOver|PregameBlockMouseOver]]

API:PregamePlayCinematic - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)