VgaGames 3 - Miscellaneous man-pages

[.. upper level ..]

VG3_pause()

Pause game for non-network games.
SYNTAX
int VG3_pause(struct vg3_window *wstruct, struct vg3_text *stxt, int kbidx)

FUNCTION PARAMETERS
wstruct Window-struct
stxt Information to show (or NULL for standard text)
kbidx Key to finish the pause: one of the values of VGAG3_KEYS
or VGAG3_KEY_NOKEY = finish pause with return-key or space-key

RETURN VALUE
Returns integer: - 0: OK - 1: Got request for closing the window and exiting the game

DESCRIPTION
Pause game. This function should not be used in network-games, rather use VG3_nw_pause() to pause all clients simultaneously.