GNN Doc

From Elite Wiki
Revision as of 09:06, 14 February 2018 by Svengali (talk | contribs) (v1.0 documentation)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Console usage

worldScripts.GNN._Help();

The recommended way is passing news through _insertNews().

Functions

_insertNews(obj)

Puts the passed object in the display pools. The object must contain at least .ID and .Message. Use at startUpComplete or later.

ID
String. worldScript name.
Message
String. Text to be displayed.
DKey
Bool. If set expandDescription will be used on Message.
Priority
Number (1..5), Default: 3. Used to sort messages.
Agency
Number. 1=GNN, 2=Rooters, 3=Snoopers, 4=Chronicle.
Pic
String. Overlay, Default:'GNN_clean.png'. Needs alpha channel for Model.
Music
Music for Newsflash. Default:'GNN.ogg'.
Model
String. Role of the model. Default:'lib_ms_helper'.
Pos
Array. Position for Model.
Ori
Array. Orientation for Model.
Spin
Bool. Sets spinModel. Default:false.
AutoPos
Bool. Automagically sets the position and orientation.
Tex
String. Sets the texture.
Mat
Object. Sets the material.
Delay
Number. Number of days until the newsflash will be available.
CB
String. Path of callback function.

A simple example:

worldScripts.GNN._insertNews({ID:'BGS',Message:'Hello'});

GNN applies some rules in the following order:

Agency disables Pic
Model disables Tex
!Model disables Ori and Pos.
!Pos enables AutoPos.

_showScreen(obj)

Displays the passed GNN object immediately. Requires to be docked and !system.isInterstellarSpace. Callbacks are disabled. Use at startUpComplete or later.


shipdata.plist

GNN uses a script_info key in shipdata.plist to decide if the interface should be shown. Set 'GNN' to true for stations. By default only main stations and stations with hasNPCTraffic set will get an interface. Stations in interstellar space are excluded.

script_info = {GNN = true;};