trap_CIN_PlayCinematic

Description

This function loads up and begins playing an ROQ file at the coordinates given.

Prototype

    int trap_CIN_PlayCinematic(
        const char *arg0,
        int xpos,
        int ypos,
        int width,
        int height,
        int bits
    );

Parameters

arg0 : the name of the .RoQ file to load.
xpos : the X coordinate on-screen for the left edge of the cinematic display.
ypos : the Y coordinate on-screen for the top edge of the cinematic display.
width : the screen width of the cinematic display.
height : the screen height of the cinematic display.
bits : combinations of the following flags :

CIN_system
CIN_loop
CIN_hold
CIN_silent
CIN_shader

Remarks

If the CIN_hold flag is specified, the ROQ is loaded in a paused state.

Return value

The function returns a handle to the cinematic instance or zero on failure.

Author(s)

D!ABLO

QuakeIII trap calls reference