Game Script API

From DF21 Wiki
Revision as of 07:39, 15 November 2026 by Jerethk (talk | contribs) (Created page with "The <code>game</code> object exposes several methods on the game that is currently being played. == Methods == === getGameTime() === * returns the current game time in seconds (float) === text() === * displays text on the screen * parameter: message (string); the text to display === random() === * returns a random integer using the Dark Forces random number generator (this is not the C/C++ random number function) * parameter: an integer value; the returned number will...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

The game object exposes several methods on the game that is currently being played.

Methods

getGameTime()

  • returns the current game time in seconds (float)

text()

  • displays text on the screen
  • parameter: message (string); the text to display

random()

  • returns a random integer using the Dark Forces random number generator (this is not the C/C++ random number function)
  • parameter: an integer value; the returned number will be between 0 and this value

playCutscene()

  • plays an OGV cutscene
  • parameter: cutsceneName (string); the name of the cutscene to play