GNN Doc - Revision history

Cholmondely: Retagged!

2023-09-20T13:44:02Z

Retagged!

Cholmondely: Added link to Snoopers Doc's upgrade to GNN example, and note on Snooper's "Error Codes"

2023-09-05T09:15:14Z

Added link to Snoopers Doc's upgrade to GNN example, and note on Snooper's "Error Codes"

Cholmondely: Added note on Phrase Generator

2023-08-23T10:13:26Z

Added note on Phrase Generator

Cholmondely: /* An example */ Added link

2023-04-25T22:52:16Z

‎An example: Added link

Cholmondely: Added ML's example

2023-04-25T22:50:41Z

Added ML's example

Hiran: /* _showScreen(obj) */

2022-01-01T22:51:36Z

‎_showScreen(obj)

Hiran: /* _showScreen(obj) */

2022-01-01T22:51:06Z

‎_showScreen(obj)

Hiran: /* _showScreen(obj) */

2022-01-01T22:50:52Z

‎_showScreen(obj)

Hiran at 22:49, 1 January 2022

2022-01-01T22:49:42Z

Hiran at 22:49, 1 January 2022

2022-01-01T22:49:13Z

← Older revision		Revision as of 13:44, 20 September 2023
Line 112:		Line 112:
	These are not listed here, but [[Snoopers Doc]] has a section on Error Codes which may well be included in GNN (Snoopers was first published in 2009 and replaced by GNN in 2018)		These are not listed here, but [[Snoopers Doc]] has a section on Error Codes which may well be included in GNN (Snoopers was first published in 2009 and replaced by GNN in 2018)

−	[[Category:~~OXPDoc~~]]	+	[[Category:OXP API's]]

@@ Line 101: / Line 101: @@
   	if (worldScripts.GNN._insertNews) const delayMoarNews = new Timer (this, $main, 1)
+  }
 [[File:CCL PhraseGen Tool.gif|right|400px]]
 == GNN Phrase Generator ==
-[[Cabal Common Library Doc PhraseGen]] may well be relevant - the GNN version may well have been taken from [[CCL]]
+[[Cabal Common Library Doc PhraseGen]] could be relevant - the GNN version may well have been taken from [[CCL]]
 [[Category:OXPDoc]]

@@ Line 101: / Line 101: @@
   	if (worldScripts.GNN._insertNews) const delayMoarNews = new Timer (this, $main, 1)
+  }
 [[Category:OXPDoc]]

@@ Line 69: / Line 69: @@
 == An example ==
-This is ML's ''MoarNews.oxz'':
+This is [[User:Massively Locked|Massively Locked]]'s ''MoarNews.oxz'':
 This is the script.js from inside the Config folder. There is also a manifest.plist. That is the entire functioning .oxz - two files and one folder!
   "use strict"

← Older revision		Revision as of 22:50, 25 April 2023
Line 68:		Line 68:
	script_info = {GNN = true;};		script_info = {GNN = true;};

		+	== An example ==
		+	This is ML's ''MoarNews.oxz'':
		+	This is the script.js from inside the Config folder. There is also a manifest.plist. That is the entire functioning .oxz - two files and one folder!
		+	"use strict"
		+	this.name = "moarNews"
		+	this.version = "0.1"
		+	this.description = "moar news items for GNN"
		+	this.author = "Massively Locked"
		+	this.copyright = "(C) 2022"
		+	this.licence = "CC-NC-by-SA 4.0"
		+	/*
		+	This add-on obviously requires the GNN OXZ to be installed. If it isn't, this add-on will have no effect.
		+	*/
		+
		+	this.$main = function () {
		+	const moarNews = [ // this array contains all the news entries- it can get big!
		+	{ID: "moarNews000", Message: "The office of the Director of the Galactic Archives has issued a press release indicating that major announcements regarding the Archives will soon be forthcoming. When asked if there is any merit to the rumors of relocating the office to the Digebiti system, the office had no comment."},
		+	{ID: "moarNews001", Message: "The 342nd Annual Ships Expo has created enormous traffic jams in the Mariar system. One pilot interviewed at the station reportedly said that they were massively locked from witchpoint all the way to the station. Authorities advise travelling off-lane and to use public transport where possible."},
		+	{ID: "moarNews002", Message: "In entertainment news, there are rumors swirling about that the popular vid-serial, The Frontier in Life, which was cancelled several years ago- will be making a come-back. So far, there has been no word if the original cast would be returning for this possible revival."},
		+	// template for new entries. Don't forget to increment the ID# and the comma after the closing }
		+	// {ID: "moarNews00#", Message: "..."},
		+	] // closing bracket of moarNews- make sure that this is always after the last news entry
		+
		+	moarNews.forEach (function (elmnt, ndx) {
		+	worldScripts.GNN._insertNews (elmnt)
		+	// the following IF statement is mainly for testing
		+	const rndNews = Math.floor (Math.random () * moarNews.length)
		+	if (ndx === rndNews) worldScripts.GNN._showScreen (elmnt)
		+	})
		+	}
		+	this.startUpComplete = function () {
		+	if (worldScripts.GNN._insertNews) const delayMoarNews = new Timer (this, $main, 1)
		+	}

	[[Category:OXPDoc]]		[[Category:OXPDoc]]

@@ Line 54: / Line 54: @@
 A simple example:
-<code>worldScripts.GNN._showScreen({ID:'BGS',Message:'Hello'});</code>
+ worldScripts.GNN._showScreen({ID:'BGS',Message:'Hello'});
 === _addExtImages(arr,ws) ===

@@ Line 52: / Line 52: @@
 Return:
 This method returns true if the message was shown, false otherwise.
 === _addExtImages(arr,ws) ===

@@ Line 1: / Line 1: @@
 __TOC__
-The recommended way in [[GNN]] is passing news through <code>_insertNews()</code>. The user has to check for messages on the ship and system interfaces screen (F4).
+The recommended way in [[GNN]] is passing news through <code>_insertNews(obj)</code>. The user has to check for messages on the ship and system interfaces screen (F4).
-If you need to force a message onto the user as soon as he docks use <code>_showScreen()</code> from your OXP's [[Oolite_JavaScript_Reference:_World_script_event_handlers#shipDockedWithStation | shipDockedWithStation()]] method.
+If you need to force a message onto the user as soon as he docks use <code>_showScreen(obj)</code> from your OXP's [[Oolite_JavaScript_Reference:_World_script_event_handlers#shipDockedWithStation | shipDockedWithStation()]] method.
 == Console usage ==