Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:40:58Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Pregame}}
Returns whether the intro cinematic can be played.

<pre>
canPlay = CanPlayCinematic()
</pre>

== Arguments ==
None.

== Returns ==
;canPlay : <code>boolean</code> – <code>true</code> if the cinematic can be played.

== Details ==
* The result is <code>false</code> if the sound system exists and reports that it is not ready for video.
* Otherwise the result is <code>true</code> only if the file <code>videos/Cinematic1_720p.bik</code> exists in the game archives.
* [[API:PregamePlayCinematic|PregamePlayCinematic]] checks the same conditions before it starts playback.
* Unlike the other pregame cinematic functions, this one does not depend on the game state.

== Errors ==
None.

== Example ==
From <code>interfacecore/source/cinematicwindow.lua</code>, which offers the cinematic web page when the video cannot be played:
<pre>
if ( CanPlayCinematic() )
then
-- show EA_Window_CinematicDisplay ...
PregamePlayCinematic()
else
DialogManager.MakeTwoButtonDialog( GetPregameString(StringTables.Pregame.DIALOG_CONFIRM_OPEN_CINEMATIC),
GetString(StringTables.Default.LABEL_YES), OpenCinematicPageInBrowser,
GetString(StringTables.Default.LABEL_NO), nil,
nil, nil, false, nil, nil )
end
</pre>

== See also ==
* [[API:PregamePlayCinematic|PregamePlayCinematic]]
* [[API:PregameStopCinematic|PregameStopCinematic]]

API:CanPlayCinematic - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)