Snoopers Doc - Revision history

Svengali: formatting

2013-09-15T23:48:18Z

formatting

Svengali: added screenID

2013-02-16T15:03:26Z

added screenID

Svengali: /* insertNews() */

2013-01-29T10:42:26Z

‎insertNews()

Svengali at 19:29, 19 December 2012

2012-12-19T19:29:30Z

Svengali: notes about removed errorcodes for v2.4

2012-10-09T18:07:11Z

notes about removed errorcodes for v2.4

Svengali: added table with errorcodes

2012-07-06T10:35:51Z

added table with errorcodes

Svengali: /* insertNews() */

2012-06-20T19:43:48Z

‎insertNews()

Svengali: added .Direct and .Anim

2012-06-11T20:28:46Z

added .Direct and .Anim

Svengali: cleanup

2011-12-17T00:56:09Z

cleanup

Svengali: /* insertNews() */

2011-10-05T20:56:13Z

‎insertNews()

@@ Line 3: / Line 3: @@
-Missionscreens in <tt>snoopers.js</tt> are using the screenID (v2.5+)
+Missionscreens in <tt>snoopers.js</tt> are using the screenID {{AV|2.5}}
 {{CodeEx|codeex="snoopers"}}
@@ Line 60: / Line 60: @@
 A simple example
-{{CodeEx|codeex=worldScripts.snoopers.insertNews({ ID: this.name , Message: "Hello world!" });}}
+  worldScripts.snoopers.insertNews({ ID: this.name , Message: "Hello world!" });

@@ Line 1: / Line 1: @@
 == Overview ==
@@ Line 31: / Line 33: @@
 == Functions ==
 === insertNews() ===
-{{CodeEx|codeex=this.insertNews = function(obj)}}
+{{CodeEx|codeex=worldScripts.snoopers.insertNews( obj )}}
 {{CodeExTime|native=0.000081|extension=0.000017|js=0.000337}}
-Handles incoming messages from other OXPs. Snoopers stores up to 10 messages and 20 CRCs if <tt>.Direct</tt> is not used and all checks are passed. Make sure that the object is extensible and not sealed or frozen.
+Handles incoming messages from other OXPs worldScripts. If <tt>.Direct</tt> is not used Snoopers stores up to 10 messages and 20 CRCs and all checks are passed (e.g. only 1 news per worldScript is allowed). <tt>.Direct</tt> news are displayed immediately and won't be stored. Make sure that the object is extensible and not sealed or frozen.
 '''Parameters'''
@@ Line 59: / Line 61: @@
 A simple example
 {{CodeEx|codeex=worldScripts.snoopers.insertNews({ ID: this.name , Message: "Hello world!" });}}
 == shipdata.plist ==
@@ Line 65: / Line 73: @@
 '''Key:'''
 :;snoopersNews:Boolean. Enables Snoopers for this station.
-{{CodeEx|codeex=script_info = { "snoopersNews" = true; };}}
+{{CodeEx|codeex=script_info = { snoopersNews = true; };}}
 == Errorcodes ==
 {| class="wikitable"
 |-

@@ Line 33: / Line 33: @@
 {{CodeEx|codeex=this.insertNews = function(obj)}}
 {{CodeExTime|native=0.000081|extension=0.000017|js=0.000337}}
-Handles incoming messages from other OXPs. Snoopers stores up to 10 messages and 20 CRCs if <tt>.Direct</tt> is not used and all checks are passed.
+Handles incoming messages from other OXPs. Snoopers stores up to 10 messages and 20 CRCs if <tt>.Direct</tt> is not used and all checks are passed. Make sure that the object is extensible and not sealed or frozen.
 '''Parameters'''
@@ Line 59: / Line 59: @@
 A simple example
 {{CodeEx|codeex=worldScripts.snoopers.insertNews({ ID: this.name , Message: "Hello world!" });}}
 == shipdata.plist ==

@@ Line 1: / Line 1: @@
 == Overview ==
-snoopers.js is the script for the galactic news network. OXPs (worldScripts) can insert own messages by passing a object to [[Snoopers]].
+<tt>snoopers.js</tt> is the script for the galactic news network. OXPs (worldScripts) can insert own messages by passing a object to [[Snoopers]].
 {{CodeEx|codeex=worldScripts.snoopers.insertNews(obj);}}
@@ Line 8: / Line 8: @@
 == Properties ==
 === logging ===
-:Boolean. Switches extended logging on/off and can be configured via OXPConfig2. Default is false.
+:Boolean. Switches extended logging on/off. Default is false. <sup>OXPC</sup>
 === audio ===
-:Boolean. Switches audio for internal news on/off and can be configured via OXPConfig2. Default is true.
+:Boolean. Switches audio for internal news on/off. Default is true. <sup>OXPC</sup>
 === extraA ===
-:Boolean. Switches full mode for internal news on/off and can be configured via OXPConfig2. Default is true.
+:Boolean. Switches full mode for internal news on/off. Default is true. <sup>OXPC</sup>
 === sliderA ===
-:Integer. Chance for newsflashes and can be configured via OXPConfig2. Default is 0x3 (#3).
+:Integer. Chance for newsflashes. Default is 0x3 (#3). <sup>OXPC</sup>
 === sliderB ===
-:Integer. Max days between newsflashes and can be configured via OXPConfig2. Default is 0x19 (#25).
+:Integer. Max days between newsflashes. Default is 0x19 (#25). <sup>OXPC</sup>
 === sliderC ===
-:Integer. Brightness for displayed model and can be configured via OXPConfig2. Default is 0x4 (#4). This will only affect shadered models which support it. Uses the fuel property.
+:Integer. Brightness for displayed model. Default is 0x4 (#4). This will only affect shadered models which support it. Uses the fuel property. <sup>OXPC</sup>
@@ Line 31: / Line 33: @@
 {{CodeEx|codeex=this.insertNews = function(obj)}}
 {{CodeExTime|native=0.000081|extension=0.000017|js=0.000337}}
-Handles incoming messages from other OXPs. Snoopers stores up to 10 messages and 20 CRCs if .Direct is not used and all checks are passed.
+Handles incoming messages from other OXPs. Snoopers stores up to 10 messages and 20 CRCs if <tt>.Direct</tt> is not used and all checks are passed.
 '''Parameters'''
@@ Line 41: / Line 43: @@
 The passed object can hold a couple of properties:
-:;ID:String. Required. Name of the calling worldScript. Snoopers stores a checksum (CRC) to scatter the messages on every start and inbetween if .Direct is not used.
+:;ID:String. Required. Name of the calling worldScript. Snoopers stores a checksum (CRC) to scatter the messages on every start and inbetween if <tt>.Direct</tt> is not used.
 :;Message:String/Key. Required. Message can be a string or keynames (descriptions.plist or missiontext.plist), mixtures allowed, max 700 chars, min 10 chars.
 :;Agency:Number. Defines 1-GNN, 2-Rooters, 3-Snoopers. If used Snoopers disables custom pics and models and uses internal ones.
 :;Priority:Number. 1 highest (and bypasses CRC check), used to sort the inserted news on next docking. Default 3.
-:;Pic:String. Overlay image, use tranparent areas if model should be used. Fileextension is required. If Agency and Pic not declared default setting choosen.
+:;Pic:String. Overlay image, use tranparent areas if model should be used. Fileextension is required. If  <tt>.Agency</tt> and <tt>.Pic</tt> not declared default setting choosen.
 :;Music:String. Music for Newsflash. Fileextension is required. If not declared, default setting choosen.
 :;Model:String. Role for Model. Starting with v2.3 it can be any NPC role.
-:;Pos:Array. 3 valid numbers. Adjusted on screen aspect ratios. If not defined Snoopers bases it on entity.position.z.
+:;Pos:Array. 3 valid numbers. Adjusted on screen aspect ratios. If not defined Snoopers bases it on <tt>entity.position.z</tt>.
-:;Ori:Number/Array. Orientation of Model. If number: 1=[1,0,0,0], 2=[1,0,0,1], 4=[0,0,1,0], 8=[1,1,0,0]. Default 8. Otherwise Array with 4 valid numbers.
+:;Ori:Number/Array. Orientation of Model. If number: 1=<tt>[1,0,0,0]</tt>, 2=<tt>[1,0,0,1]</tt>, 4=<tt>[0,0,1,0]</tt>, 8=<tt>[1,1,0,0]</tt>. Default 8. Otherwise Array with 4 valid numbers.
 :;Recall:Boolean. Resend callback in case other OXPs have overridden Snoopers screen and Replay gets activated.
 :;Direct:Boolean. Display message directly without storing, CRC or other buffer checks. Requires the player to be docked.
-:;Anim:Array. Uses [[Cabal_Common_Library_Doc_Briefing#startBriefing()|Cabal_Common_Briefing]] capture option. The array must contain only the .briefing part. Ignored if .Direct is not used.
+:;Anim:Array. Uses [[Cabal_Common_Library_Doc_Briefing#startBriefing()|Cabal_Common_Briefing]] capture option. The array must contain only the <tt>.briefing</tt> part. Ignored if <tt>.Direct</tt> is not used.
@@ Line 60: / Line 62: @@
 == shipdata.plist ==
-Snoopers usually doesn't do anything on other stations than the main station and stations with NPC traffic (except with .Direct messages). A script_info key can change this behaviour.
+Snoopers usually doesn't do anything on other stations than the main station and stations with NPC traffic (except with <tt>.Direct</tt> messages). A script_info key can change this behaviour.
 '''Key:'''

@@ Line 110: / Line 110: @@
 |-
 | 7
-| Property 'Message' starts with whitespace (\\f \\t \\r \\n or space)
+| Property 'Message' starts with whitespace (\\f \\t \\r \\n or space). Removed in v2.4. Snoopers will trim the string.
 |-
 | 8
-| Property 'Message' - Sent message not expandable
+| Property 'Message' - Sent message not expandable.
 |-
 | 9
-| Property 'Message' - Number of opening brackets doesn't match number of closing brackets
+| Property 'Message' - Number of opening brackets doesn't match number of closing brackets. Removed in v2.4.
 |-
 | 10
-| Property 'Message' - Expanded key (descriptions.plist) too long (limit 700 chars)
+| Property 'Message' - Expanded key (descriptions.plist) too long (limit 700 chars). Removed in v2.4.
 |-
 | 11
-| Property 'Message' - Expanded key (missiontext.plist) too long (limit 700 chars)
+| Property 'Message' - Expanded key (missiontext.plist) too long (limit 700 chars). Removed in v2.4.
 |-
 | 12

@@ Line 50: / Line 50: @@
 :;Model:String. Role for Model, if used Pos must be passed to, else disabled. shipdata.plist must use the same name and roles must contain snoopers_model(0).
 :;Pos:Array. 3 valid numbers, ignored if Model not declared.
-:;Ori:Number. Defines the orientation of Model. 1-[1,0,0,0], 2-[1,0,0,1], 4-[0,0,1,0], 8-[1,1,0,0]. Default 8. (New in 2.1.1)
+:;Ori:Number. Defines the orientation of Model. 1-[1,0,0,0], 2-[1,0,0,1], 4-[0,0,1,0], 8-[1,1,0,0]. Default 8.
-:;Recall:Boolean. Resend callback in case other OXPs have overridden Snoopers screen and Replay got activated. (New in 2.1.2)
+:;Recall:Boolean. Resend callback in case other OXPs have overridden Snoopers screen and Replay got activated.
@@ Line 68: / Line 68: @@
 '''Key:'''
-:;snoopersNews:Boolean. Enables Snoopers for this station. (New in 2.1.1)
+:;snoopersNews:Boolean. Enables Snoopers for this station.
 {{CodeEx|codeex=script_info = { "snoopersNews" = true; };}}