Mission variable - Revision history

Kaks: /* JavaScript */

2010-07-21T11:41:15Z

‎JavaScript

2009-10-02T08:16:16Z

added to category Oolite scripting

2007-07-10T16:58:02Z

‎JavaScript: Typo

2007-07-10T16:57:27Z

Added JavaScript note

2006-02-19T08:26:30Z

remove nonexist category

2006-01-22T17:43:31Z

2006-01-21T23:51:27Z

syntactical correction

2006-01-21T15:47:36Z

More examples and style changes

2006-01-21T15:41:12Z

Categorised and respaced

2006-01-21T15:01:04Z

Mission variables moved to Mission variable

@@ Line 38: / Line 38: @@
 === JavaScript ===
-In JavaScript, mission variables can be accessed through the [[Oolite JavaScript Reference: object model#Global Properties|missionVariables global variable]]. In JavaScript, the '''mission_''' prefix is not used. Two equivalent examples:
+In JavaScript, mission variables can be accessed through the [[Oolite_JavaScript_Reference:_Global#missionVariables|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";

@@ Line 38: / Line 38: @@
 === JavaScript ===
-In JavaScript, script variables can be accessed through the [[Oolite JavaScript Reference: object model#Global Properties|missionVariables]] global variable. In JavaScript, the '''mission_''' prefix is not used. Two equivalent examples:
+In JavaScript, mission variables can be accessed through the [[Oolite JavaScript Reference: object model#Global Properties|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";

@@ Line 1: / Line 1: @@
-Mission variables are states that can be set and queried by a script in [[script.plist]]
+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.
@@ Line 35: / Line 35: @@
  '''mission_mymissionisaverycomplexaffairthatImightmisspell_andthisisanequallycomplexvariable'''
  // could be easily misspelt or misunderstood

← Older revision		Revision as of 17:43, 22 January 2006
Line 1:		Line 1:
−	Mission variables are states that can be set and queried by a script in [[~~scripts~~.plist]]	+	Mission variables are states that can be set and queried by a script in [[script.plist]]

	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.		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.

@@ Line 10: / Line 10: @@
  // 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 then the use to which the variable is being put (for example, '''_counter1''' or '''_EnemyName'''.
+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.

@@ Line 1: / Line 1: @@
 Mission variables are states that can be set and queried by a script in [[scripts.plist]]
 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 then the use to which the variable is being put (for example, '''_counter1''' or '''_EnemyName'''.
@@ Line 7: / Line 16: @@
 === Good Examples of Mission Variable Names ===
- mission_fredJamesMission_counter1
+ '''mission_fredJamesMission_counter1'''
  // might be set to a number that's incremented or decremented every so often
- mission_trumbles_decisionKey
+ '''mission_trumbles_decisionKey'''
  // could be the result of a missionChoice
- mission_moonShot_stage
+ '''mission_moonShot_stage'''
  // could be a phrase describing the current scripted action eg. BEGINNING_MISSION or KILLING_ALIENS or MISSION_COMPLETE
 === Poor Examples of Mission Variable Names ===
- mission_counter
+ '''mission_counter'''
- mission_variable
+ '''mission_variable'''
  // no mission identifier
- mission_mymissionisaverycomplexaffairthatImightmisspell_andthisisanequallycomplexvariable
+ '''mission_mymissionisaverycomplexaffairthatImightmisspell_andthisisanequallycomplexvariable'''
  // could be easily misspelt or misunderstood

← Older revision	Revision as of 15:01, 21 January 2006
(No difference)