Cabal Common Library Doc Functions - Revision history

Svengali: added updateGalaxyStats()

2013-09-24T18:44:07Z

added updateGalaxyStats()

Svengali at 22:49, 18 September 2013

2013-09-18T22:49:42Z

Svengali at 22:30, 18 September 2013

2013-09-18T22:30:14Z

Svengali: added findSystemsPredicate()

2013-09-18T22:09:25Z

added findSystemsPredicate()

Svengali at 11:14, 16 September 2013

2013-09-16T11:14:04Z

Svengali at 23:09, 15 September 2013

2013-09-15T23:09:30Z

Svengali: formatting

2013-09-15T21:09:31Z

formatting

Show changes

Svengali: added arrFlat and objFindKeyValue

2013-09-15T20:12:36Z

added arrFlat and objFindKeyValue

Svengali at 14:34, 15 September 2013

2013-09-15T14:34:47Z

Svengali: aded getType()

2013-09-15T11:04:06Z

aded getType()

← Older revision		Revision as of 18:44, 24 September 2013
Line 839:		Line 839:
	var a = [{eco:0,c:1},{gov:7,c:1},{tec:12,c:3}];		var a = [{eco:0,c:1},{gov:7,c:1},{tec:12,c:3}];
	var b = worldScripts.Cabal_Common_Functions.findSystemsPredicate(a);		var b = worldScripts.Cabal_Common_Functions.findSystemsPredicate(a);
		+
		+
		+	=== updateGalaxyStats() ===
		+	{{CodeEx\|codeex=updateGalaxyStats( id ) {{AV\|1.8}} }}
		+	Updates nodes in [[#galaxyStats\|galaxyStats]] and lists [[#ecos\|ecos]], [[#govs\|govs]], [[#tecs\|tecs]] and [[#nova\|nova]]. If id is not specified current <tt>system.ID</tt> is used if player is not in interstellar space.
		+
		+	'''Parameters:'''
		+	:;id:Number. Optional <tt>system.ID</tt>.
		+
		+	'''Returns:'''
		+	:;nothing.

@@ Line 821: / Line 821: @@
 == Methods ==
 === findSystemsPredicate() ===
-{{CodeEx|codeex=findSystemsPredicate( arr ) {{AV|1.10}} }}
+{{CodeEx|codeex=findSystemsPredicate( arr ) {{AV|1.8}} }}
 {{CodeExTime|native=0.000043|extension=0.000011|js=0.001751}}
 Returns array with <tt>system.IDs</tt> if the system data matches the passed conditions. The method uses the binary searchtree in [[#galaxyStats|galaxyStats]], so it is available after <tt>startUp</tt> only.
@@ Line 857: / Line 857: @@
 :;connected:{{AV|1.7}} Array. Delayed as it is timeintensive. Holds system.IDs of connected systems from the current location. The path finding is executed after <code>startUp</code> and <code>playerEnteredNewGalaxy</code> only.
 :;conEntsOXP:Array. Delayed array holding the numbers of 30 jumps.-->
-:;ecos:{{AV|1.10}} Array. Holds 8 arrays of system.IDs for the systems economy.
+:;ecos:{{AV|1.8}} Array. Holds 8 arrays of system.IDs for the systems economy.
-:;govs:{{AV|1.10}} Array. Holds 8 arrays of system.IDs for the systems governments.
+:;govs:{{AV|1.8}} Array. Holds 8 arrays of system.IDs for the systems governments.
-:;tecs:{{AV|1.10}} Array. Holds 16 arrays of system.IDs for the systems techlevels. If the systems techlevel is >14, it is stored in tecs[15].
+:;tecs:{{AV|1.8}} Array. Holds 16 arrays of system.IDs for the systems techlevels. If the systems techlevel is >14, it is stored in tecs[15].
 {{CodeExTime|native=0.000050|extension=0.000016|js=0.000087}}

@@ Line 822: / Line 822: @@
 === findSystemsPredicate() ===
 {{CodeEx|codeex=findSystemsPredicate( arr ) {{AV|1.10}} }}
 Returns array with <tt>system.IDs</tt> if the system data matches the passed conditions. The method uses the binary searchtree in [[#galaxyStats|galaxyStats]], so it is available after <tt>startUp</tt> only.
@@ Line 830: / Line 831: @@
 ::::gov:Number. In range [0...7].
 ::::tec:Number. In range [0...15].
-::::All members above need also:
+:::::All members above need also:
 ::::c:Number. Required. In range [1...4] with 1=Equal, 2=Not equal, 3=Greaterthan, 4=Lessthan.

@@ Line 1: / Line 1: @@
 == Overview ==
-This is the main class for the helper library with its members and part of the [[Cabal_Common_Library]].  Scripts can instantiate a copy, e.g.
+This is the main class for the helper library with its members and part of the [[Cabal_Common_Library]].
   this.myHelper = new worldScripts.Cabal_Common_Functions.Cabal_Common();
 Versions before v1.6 have used <code>this.myHelper = new Cabal_Common();</code>
@@ Line 16: / Line 16: @@
 === internalVersion ===
 Number. Property to give OXPs a chance to check the required lib min. version easily. This number will be raised with every release.
   var a = this.myHelper.internalVersion;
@@ Line 21: / Line 23: @@
-== Methods ==
+== API Methods ==
 === baseChange() ===
-{{CodeEx|codeex=baseChange: function(n, to, from )}}
+{{CodeEx|codeex=baseChange: function( n, to, from )}}
 {{CodeExTime|native=0.000038|extension=0.000012|js=0.000067}}
 Changes the base of n.
@@ Line 44: / Line 46: @@
 === clamp() ===
-{{CodeEx|codeex=clamp: function(value, max, min )}}
+{{CodeEx|codeex=clamp: function( value, max, min )}}
 {{CodeExTime|native=0.000041|extension=0.000012|js=0.000069}}
 Clamps value to max...min.
 '''Paramaters:'''
 :;value:Number. To be clamped.
@@ Line 96: / Line 98: @@
 {{CodeExTime|native=0.000038|extension=0.000010|js=0.000062}}
 Returns number of bits set in n. If n<0 a bitwise NOT will be applied before execution.
 '''Parameters:'''
 :;n:Number. To be evaluated.
@@ Line 111: / Line 113: @@
 {{CodeExTime|native=0.000041|extension=0.000010|js=0.000069}}
 Returns rounded number with specified precision.
 '''Parameters:'''
 :;x:Number. To be rounded.
@@ Line 284: / Line 286: @@
 {{CodeExTime|native=0.000038|extension=0.000011|js=0.000067}}
 Takes an integer number of minutes and converts it into a string. The returned string has the form 'd' days, 'h' hours and 'm' minutes, accomodating all cases of singular, plural, and 0.
 '''Parameters:'''
 :;minutes:Number. The time in minutes.
 '''Returns:'''
 :;timeString:String.
@@ Line 813: / Line 815: @@
   var a = this.myHelper.screenChecks();
   a -> [1024,768,256,1.33333333]
@@ Line 823: / Line 846: @@
 :;avgEnts:Number. Average number of entities on <code>shipExitedWitchspace</code> in the first 30 jumps in a session.
 :;avgEntsOXP:Number. Delayed average number of entities (30 jumps).
 :;jumpCount:Number of jumps the player has done in this session.
 :;lastJumpDiff:Number. Time difference between <code>lastJumpTime</code> and current time.
 <!--:;conEnt:Array. Holds the numbers of 30 jumps on <code>shipExitedWitchspace</code>.
 :;conEntsOXP:Array. Delayed array holding the numbers of 30 jumps.-->
 {{CodeExTime|native=0.000050|extension=0.000016|js=0.000087}}
 :;galaxyStats:{{AV|1.7}} Object. Binary search tree. The collected objects are holding only primitive values (= no references to System.infoForSystem) to keep it fast. <tt>coordinates, description, economy, government, ID, inhabitant, inhabitants, market, name, population, productivity, radius, sun</tt> (true, if sun_gone_nova false) and <tt>techlevel</tt> are stored.
 ::Scripts can access the data via
-  var myInfo = worldScripts.Cabal_Common_Functions.moreInfo.galaxyStats.contains(7).description;
+  var myInfo = worldScripts.Cabal_Common_Functions.moreInfo.galaxyStats.contains(7);
 ::The returned object holds the above mentioned properties for the requested system.

@@ Line 630: / Line 630: @@
 === objFindKeyValue() ===
-{{CodeEx|codeex=objFindKeyValue: function( obj, key, value, flat ) {{AV|1.8}} }}
+{{CodeEx|codeex=objFindKeyValue: function( obj, key, value ) {{AV|1.8}} }}
-{{CodeExTime|native=0.000039|extension=0.000011|js=0.000418}}
+{{CodeExTime|native=0.000040|extension=0.000011|js=0.000139}}
-Find all key/value pairs in object.
+Returns all objects which match key===value.
 '''Parameters:'''
-:;obj:Object.
+:;obj:Object. To be checked.
 :;key:String. Keyname.
 :;value:Any.
 '''Returns:'''
@@ Line 644: / Line 643: @@
   var x = {a:[{id:2},{id:4}],b:["c","d"]};
-  var y= this.myHelper.objClone(x,"id",4,1);
+  var y= this.myHelper.objClone(x,"id",4);
   -> {id:4}

@@ Line 4: / Line 4: @@
 Versions before v1.6 have used <code>this.myHelper = new Cabal_Common();</code>
   worldScripts.Cabal_Common_Functions.helper.getType(obj);
 The Profiler boxes will give you a quick overview about runtimes. Times are measured with the listed examples on a Core2Duo @2GHz.
 == Properties ==
@@ Line 57: / Line 61: @@
 === getType() ===
-{{CodeEx|codeex=getType: function( what )}}
+{{CodeEx|codeex=getType: function( what )  {{AV|1.8}} }}
 {{CodeExTime|native=0.000040|extension=0.000010|js=0.000062}}
-Returns lowercase string with the type or null. (New in v1.8)
+Returns lowercase string with the type or null.
 '''Parameters:'''
@@ Line 122: / Line 126: @@
 {{CodeEx|codeex=pseudoRand: function( salt, mode )}}
 {{CodeExTime|native=0.000041|extension=0.000017|js=0.000106}}
-LCG (Linear congruential generator) pseudo-random number generator with salt (and pepper).  Can be used to generate deterministic unique values, e.g. to decide if a specific entity should be spawned.
+LCG (Linear congruential generator) pseudo-random number generator with salt (and pepper). Can be used to generate deterministic unique values, e.g. to decide if a specific entity should be spawned.
 '''Parameters:'''
@@ Line 178: / Line 182: @@
 === strAddAlignedText() ===
-{{CodeEx|codeex=strAddAlignedText: function( text, alignment )}}
+{{CodeEx|codeex=strAddAlignedText: function( text, alignment )  {{AV|1.6.1}} }}
 {{CodeExTime|native=0.000122|extension=0.000028|js=0.000082}}
 Returns padded text for a single line.
@@ Line 190: / Line 194: @@
 Author: Thargoid.
 === strAddEdgeText() ===
-{{CodeEx|codeex=strAddEdgeText: function( leftText, rightText )}}
+{{CodeEx|codeex=strAddEdgeText: function( leftText, rightText ) {{AV|1.6.1}} }}
 {{CodeExTime|native=0.000159|extension=0.000040|js=0.000295}}
 Returns two edge-aligned columns, one on the left and the other on the right for a single line.
@@ Line 206: / Line 209: @@
 Author: Thargoid.
 === strAddIndentedText() ===
-{{CodeEx|codeex=strAddIndentedText: function( text, indent )}}
+{{CodeEx|codeex=strAddIndentedText: function( text, indent ) {{AV|1.6.1}} }}
 {{CodeExTime|native=0.000112|extension=0.000028|js=0.000133}}
 Returns indented line of text by the given distance (in ems) from the left.
@@ Line 222: / Line 224: @@
 Author: Thargoid.
 === strAdd2Columns() ===
-{{CodeEx|codeex=strAdd2Columns: function( leftText, leftIndent, rightText, rightIndent )}}
+{{CodeEx|codeex=strAdd2Columns: function( leftText, leftIndent, rightText, rightIndent ) {{AV|1.6.1}} }}
 {{CodeExTime|native=0.000137|extension=0.000057|js=0.000414}}
 Returns single line text with two columns indented from the left margin by the given amount (in ems, 0-32).
@@ Line 240: / Line 241: @@
 Author: Thargoid.
 === strAdd3Columns() ===
-{{CodeEx|codeex=strAdd3Columns: function( leftText, leftIndent, centreText, centreIndent, rightText, rightIndent )}}
+{{CodeEx|codeex=strAdd3Columns: function( leftText, leftIndent, centreText, centreIndent, rightText, rightIndent ) {{AV|1.6.1}} }}
 {{CodeExTime|native=0.000041|extension=0.000013|js=0.000366}}
 Returns single line text with three columns, left, centre and right.
@@ Line 260: / Line 260: @@
 Author: Thargoid.
@@ Line 531: / Line 530: @@
 === arrFlat() ===
-{{CodeEx|codeex=arrFlat: function( arr )}}
+{{CodeEx|codeex=arrFlat: function( arr ) {{AV|1.8}} }}
 {{CodeExTime|native=0.000039|extension=0.000012|js=0.000259}}
 Flattens multidimensional arrays.
@@ Line 617: / Line 616: @@
 === objClone() ===
-{{CodeEx|codeex=objClone: function( src )}}
+{{CodeEx|codeex=objClone: function( src ) {{AV|1.8}} }}
 {{CodeExTime|native=0.000033|extension=0.000009|js=0.000146}}
-Creates a clone of the input object. (New in v1.8)
+Creates a clone of the input object.
 '''Parameters:'''
@@ Line 631: / Line 630: @@
 === objFindKeyValue() ===
-{{CodeEx|codeex=objFindKeyValue: function( obj, key, value, flat )}}
+{{CodeEx|codeex=objFindKeyValue: function( obj, key, value, flat ) {{AV|1.8}} }}
 {{CodeExTime|native=0.000039|extension=0.000011|js=0.000418}}
 Find all key/value pairs in object.
@@ Line 825: / Line 824: @@
 :;avgEnts:Number. Average number of entities on <code>shipExitedWitchspace</code> in the first 30 jumps in a session.
 :;avgEntsOXP:Number. Delayed average number of entities (30 jumps).
-:;connected:Array. Delayed as it is timeintensive. Holds system.IDs of connected systems from the current location. The path finding is executed after <code>startUp</code> and <code>playerEnteredNewGalaxy</code> only. (New in v1.6.1)
+:;connected:{{AV|1.7}} Array. Delayed as it is timeintensive. Holds system.IDs of connected systems from the current location. The path finding is executed after <code>startUp</code> and <code>playerEnteredNewGalaxy</code> only.
 :;jumpCount:Number of jumps the player has done in this session.
 :;lastJumpTime:Number. Time when the last jump occured. Uses <code>clock.absoluteSeconds</code>
@@ Line 834: / Line 833: @@
 ==== moreInfo Objects ====
 {{CodeExTime|native=0.000050|extension=0.000016|js=0.000087}}
-:;galaxyStats:Object. Binary search tree. The collected objects are holding only primitive values (= no references to System.infoForSystem) to keep it fast.
+:;galaxyStats:{{AV|1.7}} Object. Binary search tree. The collected objects are holding only primitive values (= no references to System.infoForSystem) to keep it fast. <tt>coordinates, description, economy, government, ID, inhabitant, inhabitants, market, name, population, productivity, radius, sun</tt> (true, if sun_gone_nova false) and <tt>techlevel</tt> are stored.
 ::Scripts can access the data via

@@ Line 4: / Line 4: @@
 Versions before v1.6 have used <code>this.myHelper = new Cabal_Common();</code>
-A convenience instance is created and can be used directly via (New in v1.8). This is specially useful if you only need a some of the available.
+A convenience instance is created and can be used directly via (New in v1.8). This is specially useful if you only need a small part of the library.
 {{CodeEx|codeex=worldScripts.Cabal_Common_Functions.helper.getType(obj);}}
@@ Line 56: / Line 56: @@
 === getType() ===
 {{CodeEx|codeex=getType: function( what )}}
-{{CodeExTime|native=0.0|extension=0.0|js=0.0}}
+{{CodeExTime|native=0.000040|extension=0.000010|js=0.000062}}
 Returns lowercase string with the type or null. (New in v1.8)
@@ Line 64: / Line 64: @@
 '''Returns:'''
 :;type:String or null. If String 'array', 'boolean', 'date', 'function', 'number', 'object', 'regexp', 'string', or 'undefined'
@@ Line 520: / Line 523: @@
 var cleanedArray = this.myHelper.arrDiff(testA,testB);<br>
 cleanedArray -> "AA","AD"}}
@@ Line 600: / Line 619: @@
 :;obj:Object. Cloned object.
 {{CodeEx|codeex=var dir = this.myHelper.objClone({a:["a","b"],b:["c","d"]});}}

← Older revision		Revision as of 14:34, 15 September 2013
Line 63:		Line 63:

	'''Returns:'''		'''Returns:'''
−	:;type:String or null. If String '~~undefined~~','boolean','number','~~string~~','~~function~~','~~array~~','~~object~~'	+	:;type:String or null. If String 'array', 'boolean', 'date', 'function', 'number', 'object', 'regexp', 'string', or 'undefined'

@@ Line 2: / Line 2: @@
 This is the main class for the helper library with its members and part of the [[Cabal_Common_Library]].  Scripts can instantiate a copy, e.g.
 {{CodeEx|codeex=this.myHelper = new worldScripts.Cabal_Common_Functions.Cabal_Common();}}
-Versions before v1.6 have used <code>this.myHelper = new Cabal_Common_2DCollision();</code>
+Versions before v1.6 have used <code>this.myHelper = new Cabal_Common();</code>
 == Properties ==
@@ Line 49: / Line 52: @@
 {{CodeEx|codeex=var a = this.myHelper.clamp(Math.random(),0.6,0.2);
 a -> 0.2}}