API:PregameStopCinematic

UI Lua API · Pregame functions
Version: WAR 1.4.8

Stops the intro cinematic started with PregamePlayCinematic.

PregameStopCinematic()

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.
• If no cinematic is playing, nothing happens.
• Otherwise the video is stopped and closed, and the title_screen_video texture is cleared.
• The flag that PregamePlayCinematic set (the one PregameBlockMouseOver controls) gets back the value it had before playback.
• If the pregame theme music is not playing, it is started again.

Errors

None.

Example

From interfacecore/source/cinematicwindow.lua:

function EA_Window_CinematicDisplay.Hide()
    WindowSetShowing("EA_Window_CinematicDisplay", false)
    PregameStopCinematic()
end

See also

• PregamePlayCinematic
• CanPlayCinematic