Cabal Common Library Doc Comms - Revision history

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

Svengali at 20:20, 9 June 2011

2011-06-09T20:20:58Z

Svengali: Doc for Cabal_Common_Library_Comms

2011-05-06T16:25:44Z

Doc for Cabal_Common_Library_Comms

New page

== Overview ==
This is the main class for the secure comms channels with its members.

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.

'''script_info:'''
:;ccl_secureChannel:String. Property in the script that holds the comm object.
:;ccl_secureChannelPrep:String. Function in the script that initiates the object.

The scripts should keep a valid object to use removeFromComm() or changeChoicesComm.

Everything else is performed within the EQ-script.

== Functions ==
=== addToComm() ===
{{CodeEx|codeex=addToComm = function( obj )}}
Adds incoming object to the list.

If the player selects a action, the script will pass the index of the action in the set. Therefor it is necessary to provide some infos when adding a entry.

'''Properties:'''
:;display:String. Used for onscreen display.
:;who:Entity/String. The entity or worldScript.
:;ent:Boolean. Must be true for entities, blank for worldScripts.
:;pID:Number/String. Must be entityPersonality for entities and this.name for worldScripts.
:;callback:String. The function that handles the actions.
:;noDist:Boolean. Optional. If true keep entity entry if out of scanner range.
:;react:Array. Holds the names of the actions.

Example for a ship:
{{CodeEx|codeex=this.myComm = { 
display:"My channel", 
who:this.ship, 
ent:true, 
pID:this.ship.entityPersonality, 
callback:"commCall", 
react:[{display:"Hail"},{display:"Back"}] 
}; 
worldScripts.Cabal_Common_Comms.addToComm(this.myComm);}}

Examle for a worldScript:
{{CodeEx|codeex=this.myComm = { 
display:"Snoopers", 
who:this.name, 
pID:"Snoopers", 
callback:"commCall", 
react:[{display:"Snoopers status"},{display:"Back"}] 
}; 
worldScripts.Cabal_Common_Comms.addToComm(this.myComm);}}

=== removeFromComm() ===
{{CodeEx|codeex=removeFromComm = function( obj )}}
Removes object from the list.

{{CodeEx|codeex=worldScripts.Cabal_Common_Comms.removeFromComm(this.myComm);}}

=== changeChoicesComm() ===
{{CodeEx|codeex=changeChoicesComm = function( pID, newSet)}}
Changes the stored actions for a specific entry.

Example for a ship:
{{CodeEx|codeex=var newSet = [{display:"Hail"},{display:"Back"}];
worldScripts.Cabal_Common_Comms.changeChoicesComm(this.ship.entityPersonality,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.

@@ Line 32: / Line 32: @@
 Example for a ship:
-{{CodeEx|codeex=this.myComm = {<br>
+{{CodeEx|codeex=this.myComm = {
-display:"My channel",<br>
+:display:"My channel",
-who:this.ship,<br>
+:who:this.ship,
-ent:true,<br>
+:ent:true,
-pID:this.ship.entityPersonality,<br>
+:pID:this.ship.entityPersonality,
-callback:"commCall",<br>
+:callback:"commCall",
-react:[{display:"Hail"},{display:"Back"}]<br>
+:react:[{display:"Hail"},{display:"Back"}]
 };<br>
 worldScripts.Cabal_Common_Comms.addToComm(this.myComm);}}
 Examle for a worldScript:
-{{CodeEx|codeex=this.myComm = {<br>
+{{CodeEx|codeex=this.myComm = {
-display:"Snoopers",<br>
+:display:"Snoopers",
-who:this.name,<br>
+:who:this.name,
-pID:"Snoopers",<br>
+:pID:"Snoopers",
-callback:"commCall",<br>
+:callback:"commCall",
-react:[{display:"Snoopers status"},{display:"Back"}]<br>
+:react:[{display:"Snoopers status"},{display:"Back"}]
 };<br>
 worldScripts.Cabal_Common_Comms.addToComm(this.myComm);}}

@@ Line 1: / Line 1: @@
 == Overview ==
-This is the main class for the secure comms channels with its members.
+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.
@@ Line 13: / Line 13: @@
 Everything else is performed within the EQ-script.
 == Functions ==

@@ Line 20: / Line 20: @@
 {{CodeExTime|native=0.000158|extension=0.000068|js=0.000124}}
 Adds incoming object to the list.
 If the player selects a action, the script will pass the index of the action in the set.  Therefor it is necessary to provide some infos when adding a entry.
@@ Line 58: / Line 64: @@
 {{CodeExTime|native=0.000038|extension=0.000010|js=0.000114}}
 Removes object from the list.
 {{CodeEx|codeex=worldScripts.Cabal_Common_Comms.removeFromComm(this.myComm);}}
@@ Line 66: / Line 78: @@
 {{CodeExTime|native=0.000154|extension=0.000068|js=0.000124}}
 Changes the stored actions for a specific entry.
 Example for a ship:

@@ Line 18: / Line 18: @@
 === addToComm() ===
 {{CodeEx|codeex=addToComm = function( obj )}}
 Adds incoming object to the list.
@@ Line 55: / Line 56: @@
 === removeFromComm() ===
 {{CodeEx|codeex=removeFromComm = function( obj )}}
 Removes object from the list.
@@ Line 62: / Line 64: @@
 === changeChoicesComm() ===
 {{CodeEx|codeex=changeChoicesComm = function( pID, newSet)}}
 Changes the stored actions for a specific entry.