GNN Doc - Revision history

Hiran: /* _showScreen(obj) */

2022-01-01T22:51:36Z

‎_showScreen(obj)

2022-01-01T22:51:06Z

‎_showScreen(obj)

2022-01-01T22:50:52Z

‎_showScreen(obj)

2022-01-01T22:49:42Z

2022-01-01T22:49:13Z

2022-01-01T22:48:18Z

2022-01-01T22:20:54Z

2022-01-01T20:44:32Z

2022-01-01T20:43:05Z

‎_showScreen(obj)

2022-01-01T20:37:29Z

‎_insertNews(obj)

@@ 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 54: / Line 54: @@
 A simple example:
-<code>worldScripts.GNN._insertNews({ID:'BGS',Message:'Hello'});</code>
+<code>worldScripts.GNN._showScreen({ID:'BGS',Message:'Hello'});</code>
 === _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 ==

@@ Line 3: / Line 3: @@
 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).
-If you need to force a message onto the user as soon as he docks use <code>_showScreen()</code> from your OXP's shipDockedWithStation() method.
+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.
 == Console usage ==

← Older revision		Revision as of 22:48, 1 January 2022
Line 2:		Line 2:

	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()</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 shipDockedWithStation() method.

	== Console usage ==		== Console usage ==

@@ Line 1: / Line 1: @@
 __TOC__
-The recommended way in [[GNN]] is passing news through <code>_insertNews()</code>.
+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).
 == Console usage ==
@@ Line 10: / Line 10: @@
 === _insertNews(obj) ===
 Puts the passed object in a queue of messages to be shown (the display pools). The object must contain at least .ID and .Message. Use at <code>startUpComplete</code> or later.
 :;ID: String. worldScript name.
@@ Line 45: / Line 46: @@
 === _showScreen(obj) ===
 Displays the passed GNN object immediately. Requires to be docked and !system.isInterstellarSpace. Callbacks are disabled. Use at <code>startUpComplete</code> or later.
-The obj is constructed the same as for the above call.
+The obj is constructed the same as for the above call. Use this message from your OXP's [[Oolite_JavaScript_Reference:_World_script_event_handlers#shipDockedWithStation | shipDockedWithStation()]] method.
 Return:

@@ Line 29: / Line 29: @@
 :;CB: String. Path of callback function. Passes the expanded message.
 :;CBID: String. Callback returns CBID instead of message. {{AV|1.1}}
 A simple example: