Missiontext.plist

From Elite Wiki
Revision as of 21:46, 23 March 2010 by JazHaz (talk | contribs) (added wikilink to plist page)

This is the filename of the file that contains all the text relevant to scripted missions. See the Property List page for more detail on plists.

Structure

The file is organised as a dictionary <dict>. Every entry consists of the name <key>, followed by the text <string>.

Example:
  conhunt_short_desc1 = "Hunt for the constrictor stolen from Xeer.";
or in XML:
  <key>conhunt_short_desc1</key>
  <string>Hunt for the constrictor stolen from Xeer.</string>


Special Expansions

These can be include in your text, within the <string>..</string>, to automatically insert the following detail;

[commander_name] - Displays the name of the saved game file.

[commander_shipname] - Displays the name of the player's ship, as specified by shipdata.plist.

[commander_shipdisplayname] - Could be different from commander_shipname.

[commander_rank] - Displays the player's Elite rating.

[commander_legal_status] - Displays the player's current legal status.

[commander_bounty] - Displays the current bounty on the player. (Oolite v1.74 & up)

[nom] - Generate a random surname.

[thanks-for-assist] - Err, thanks the player for their assistance.

[police-thanks-for-assist] - the police thanks the player personally.

[describe-pirate] - Random description for an outlaw.

[describe-Pirate] - Capitalized random description for an outlaw.

[thargoid_curses] - Random Thargoid curses.

[police_warning] - Random impending fines notifications.

[police_attack_warning] - Random warning of immediate(?) attack.

%H - Will display the current system name i.e. Isinor.

%I - Displays the current system name with "ian" attached i.e. Isinorian.

%R - Random word.

%N - Random name. More variation than with %R. (Feature added with Oolite 1.73)

%Jxxx - Will display the system name of system with ID number "xxx". xxx must be a 3 digit number or no replacement takes place. e.g. %J007 is Lave. This replacement follows any system renaming by other oxp's. (Feature added with Oolite 1.73)

See also Communications in Methods.

Layout

Several spacial characters are used in determining the layout of the text, just as in Wiki.

  • \" Enables the use of colons.
  • \\n Insers a hard Enter.

In XML:

  • \n Inserts a hard Enter.
Example:
<key>trumble_offer</key>
<string>Commander,\n\nYou look like a man who could use a Trumble!...</string>

Choices

Most missions offer a choice, that is the spirit of elite.

Example:
<key>nova_yesno</key>
	<dict>
		<key>YES</key>
		<string>Okay, I'll help.</string>
		<key>NO</key>
		<string>No, sorry.</string>
	</dict>