Mission variable

From Elite Wiki
Revision as of 12:41, 21 July 2010 by Kaks (talk | contribs) (JavaScript)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Mission variables are states that can be set and queried by a script in script.plist, or any JavaScript script.

They may be set to strings of characters that represent states (often in unspaced capital letters - just a style recommendation), or to numeric values, eg.

set: mission_myGreatMission_status START_OF_THE_MISSION
// mission_myGreatMission_status will be set to the string 'START_OF_THE_MISSION'

set: mission_myGreatMission_rewardValue 105.5
// mission_myGreatMission_rewardValue will be set to 105.5
// I might alter this value before I award it as credits at the end of the mission

They should have a unique name that is always prefixed by mission_. A good naming scheme is to use mission_ followed by a unique identifier for your script (for example, fredJamesMission1) followed by an underscore followed by the use to which the variable is being put (for example, _counter1 or _EnemyName).

Mission variables are saved in the player's saved game file.

Good Examples of Mission Variable Names

// might be set to a number that's incremented or decremented every so often

// could be the result of a missionChoice

// could be a phrase describing the current scripted action eg. BEGINNING_MISSION or KILLING_ALIENS or MISSION_COMPLETE

Poor Examples of Mission Variable Names

// no mission identifier

// no mission identifier

// could be easily misspelt or misunderstood


In JavaScript, mission variables can be accessed through the missionVariables global variable. In JavaScript, the mission_ prefix is not used. Two equivalent examples:

missionVariables.myGreatMission_status = "START_OF_THE_MISSION";
missionVariables["myGreatMission_status"] = "START_OF_THE_MISSION";