Cabal Common Library Doc Comms - Revision history

Cholmondely: Added more

2025-07-01T14:38:46Z

Added more

Cholmondely: Added Links

2024-04-10T18:03:27Z

Added Links

Cholmondely: Retagged!

2023-09-20T14:13:21Z

Retagged!

Svengali: formatting

2013-09-15T23:29:35Z

formatting

Svengali at 10:47, 29 January 2013

2013-01-29T10:47:22Z

Svengali at 19:24, 20 June 2012

2012-06-20T19:24:18Z

Svengali: /* Overview */

2012-05-29T22:46:52Z

‎Overview

Svengali at 14:56, 11 October 2011

2011-10-11T14:56:06Z

Svengali: Furher info about the script_info keys and list cleaning.

2011-10-11T14:43:52Z

Furher info about the script_info keys and list cleaning.

Svengali at 10:26, 26 July 2011

2011-07-26T10:26:06Z

@@ Line 1: / Line 1: @@
 == Overview ==
 This is the main class for the secure comms channels with its members and part of the [[Cabal_Common_Library]].
@@ Line 13: / Line 15: @@
 Everything else is performed within the EQ-script.
 == Functions ==
@@ Line 92: / Line 107: @@
 == Links ==
 *[https://bb.oolite.space/viewtopic.php?p=173966#p173966 CCL offers comms channels, but as far as I know only the Vector uses it (and the MaterialsFinder).] (Svengali, 2012 - and see next few posts).
 [[Category:OXP API's]]

← Older revision		Revision as of 18:03, 10 April 2024
Line 90:		Line 90:
	this.myComm.react = newSet;		this.myComm.react = newSet;

		+	== Links ==
		+	*[https://bb.oolite.space/viewtopic.php?p=173966#p173966 CCL offers comms channels, but as far as I know only the Vector uses it (and the MaterialsFinder).] (Svengali, 2012 - and see next few posts).

	[[Category:OXP API's]]		[[Category:OXP API's]]

← Older revision		Revision as of 14:13, 20 September 2023
Line 91:		Line 91:


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

@@ Line 16: / Line 16: @@
 == Functions ==
 === addToComm() ===
-{{CodeEx|codeex=addToComm = function( obj )}}
+{{CodeEx|codeex=addToComm: function( obj )}}
 {{CodeExTime|native=0.000158|extension=0.000068|js=0.000124}}
 Adds incoming object to the list. Make sure that the object is extensible and not sealed or frozen.
@@ Line 38: / Line 38: @@
 Example for a ship:
-{{CodeEx|codeex=this.myComm = {
+  this.myComm = {
-:display:"My channel",
+    display:"My channel",
-:who:this.ship,
+    who:this.ship,
-:ent:true,
+    ent:true,
-:pID:this.ship.entityPersonality,
+    pID:this.ship.entityPersonality,
-:callback:"commCall",
+    callback:"commCall",
-:react:[{display:"Hail"},{display:"Back"}]
+    react:[{display:"Hail"},{display:"Back"}]
-};<br>
+  };
-worldScripts.Cabal_Common_Comms.addToComm(this.myComm);}}
+  worldScripts.Cabal_Common_Comms.addToComm(this.myComm);
 Examle for a worldScript:
-{{CodeEx|codeex=this.myComm = {
+  this.myComm = {
-:display:"Snoopers",
+    display:"Snoopers",
-:who:this.name,
+    who:this.name,
-:pID:"Snoopers",
+    pID:"Snoopers",
-:callback:"commCall",
+    callback:"commCall",
-:react:[{display:"Snoopers status"},{display:"Back"}]
+    react:[{display:"Snoopers status"},{display:"Back"}]
-};<br>
+  };
-worldScripts.Cabal_Common_Comms.addToComm(this.myComm);}}
+  worldScripts.Cabal_Common_Comms.addToComm(this.myComm);
 === removeFromComm() ===
-{{CodeEx|codeex=removeFromComm = function( obj )}}
+{{CodeEx|codeex=removeFromComm: function( obj )}}
 {{CodeExTime|native=0.000038|extension=0.000010|js=0.000114}}
 Removes object from the list.
@@ Line 70: / Line 70: @@
 :;bool: Boolean. True on success.
-{{CodeEx|codeex=worldScripts.Cabal_Common_Comms.removeFromComm(this.myComm);}}
+  worldScripts.Cabal_Common_Comms.removeFromComm(this.myComm);
 === changeChoicesComm() ===
-{{CodeEx|codeex=changeChoicesComm = function( pID, newSet)}}
+{{CodeEx|codeex=changeChoicesComm: function( pID, newSet )}}
 {{CodeExTime|native=0.000154|extension=0.000068|js=0.000124}}
 Changes the stored actions for a specific entry.
@@ Line 86: / Line 86: @@
 Example for a ship:
-{{CodeEx|codeex=var newSet = [{display:"Hail"},{display:"Back"}];
+  var newSet = [{display:"Hail"},{display:"Back"}];
-worldScripts.Cabal_Common_Comms.changeChoicesComm(this.ship.entityPersonality,newSet);<br>
+  worldScripts.Cabal_Common_Comms.changeChoicesComm(this.ship.entityPersonality,newSet);
-this.myComm.react = newSet;}}
+  this.myComm.react = newSet;
 [[Category:OXPDoc]]

@@ Line 18: / Line 18: @@
 {{CodeEx|codeex=addToComm = function( obj )}}
 {{CodeExTime|native=0.000158|extension=0.000068|js=0.000124}}
-Adds incoming object to the list.
+Adds incoming object to the list. Make sure that the object is extensible and not sealed or frozen.
 '''Parameters:'''

@@ Line 2: / Line 2: @@
 This is the main class for the secure comms channels with its members and part of the [[Cabal_Common_Library]].
-The script is mainly used to store and handle incoming data from shipscripts and worldScripts for a secure communication channel.  Entities can place, change or remove their data fairly simple and a few parameters are handled.  The equipment itself is not visible to the player and added automagically by adding a entry. Additionally entities can use script_info keys to give the player the option to open a channel. Entries are valid until the player leaves the system or in case of entities is out of scanner range. The range check can by bypassed.
+The script is mainly used to store and handle incoming data from shipscripts and worldScripts for a secure communication channel.  Entities can place, change or remove their data fairly simple and a few parameters are handled.  The equipment itself is not visible to the player and added automagically by adding a entry. Additionally entities can use script_info keys to give the player the option to open a channel. Entries are valid until the player leaves the system or in case of entities is out of scanner range based on a timer with 25 sec intervals. The range check can by bypassed.
 The script checks the following shipdata.plist script_info key when the player receives a comms message from that entity.
@@ Line 10: / Line 10: @@
 :;ccl_secureChannelPrep:String.  Function in the ship-script that initiates the object.
-The scripts should keep a valid object to use removeFromComm() or changeChoicesComm.
+The scripts should keep a valid object to use removeFromComm() or changeChoicesComm().
 Everything else is performed within the EQ-script.