Other great resources: Official JS API docs, Scripting Forum

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

This event is triggered once at the start of the game before the map is ready.

 

Overview

This event is only called when a game first starts, it is not called when a saved game is loaded.

When the event is fired, all your scripts have been loaded and basic game initialisation is complete:

  • You can retrieve basic information about the game, such as playerData and use most if not all of the enum functions (such as enumDroid() and enumStruct()
  • Do not issue any commands (such as production, research or droid orders) because the game hasn't properly started yet.
  • Avoid setTimer()queue() or bind() calls linked to functions that issue commands, because they might get triggered before the game properly starts.

To issue initial commands or set timers, etc., it's much safer to use eventStartLevel() instead.

Syntax

function eventGameInit() {
  // do stuff
}

Parameters

This event has no parameters.

Return value

Warzone does not process your event handler's return value.

Example

Choose a research path based on AI difficulty
var insaneResearchPath = [ /* research items here */ ];
var hardResearchPath = [ /* research items here */ ];
var mediumResearchPath = [ /* research items here */ ];
var easyResearchPath = [ /* research items here */ ];


function eventGameInit() {
  switch (difficulty) {
    case INSANE: {
      global.researchPath = insaneResearchPath;
      break;
    }
    case HARD: {
      global.researchPath = hardResearchPath;
      break;
    }
    case MEDIUM: {
      global.researchPath = mediumResearchPath;
      break;
    }
    case EASY: {
      global.researchPath = easyResearchPath;
      break;
    }
  }
}

Availability

Requires:

  • Warzone 3.1 Beta 1 and above.

See also

Related articles:

  • eventStartLevel() – triggered once the map has been initialised, you can now issue commands and set timers, etc.
  • Events – documentation for all other events in the JS API

 

  • No labels