Cabal Common Library Doc OXPStrength - Revision history

Phkb: Updating BB links

2024-02-29T01:22:23Z

Updating BB links

Cholmondely: Added a couple of links

2024-01-14T13:09:03Z

Added a couple of links

Cholmondely: Retagged!

2023-09-20T14:10:18Z

Retagged!

Cholmondely: /* checkPower() */ link!

2022-05-13T16:12:38Z

‎checkPower(): link!

Svengali: /* grabSTDValue() */

2013-02-12T16:38:11Z

‎grabSTDValue()

Svengali: part IX

2013-02-12T16:35:19Z

part IX

Svengali: part VIII

2013-02-09T12:48:00Z

part VIII

Svengali: /* checkWeapons() */

2013-02-08T20:20:02Z

‎checkWeapons()

Svengali: /* checkSpaceLane() */

2013-02-08T20:18:30Z

‎checkSpaceLane()

Svengali: part VII

2013-02-08T20:08:07Z

part VII

Show changes

@@ Line 27: / Line 27: @@
 == Quote ==
-  Cabal_Common_Strength is using a missionVariable (mission_CCL_OXPStrength) to avoid the spawning of strong entities which have specified conditions in shipdata. It is set to 9 by default, lower values are indicating strength level. The variable is reset on entering witchspace if no system setting is specified for the target system. [http://aegidian.org/bb/viewtopic.php?p=159537#p159537 Svengali 2011]
+  Cabal_Common_Strength is using a missionVariable (mission_CCL_OXPStrength) to avoid the spawning of strong entities which have specified conditions in shipdata. It is set to 9 by default, lower values are indicating strength level. The variable is reset on entering witchspace if no system setting is specified for the target system. [https://bb.oolite.space/viewtopic.php?p=159537#p159537 Svengali 2011]
 == Functions ==

@@ Line 26: / Line 26: @@
 * Turrets
 == Functions ==
@@ Line 259: / Line 261: @@
 ----
 [[Category:OXP API's]]

← Older revision		Revision as of 14:10, 20 September 2023
Line 259:		Line 259:

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

@@ Line 43: / Line 43: @@
 :;entity:Entity. If specified only this entity will be checked, otherwise all entities in the system (except the player).
 ::Optional.
-:;logging:Boolean. If true a verbose list will be logged to <tt>Latest.log</tt>. This is useful while writing OXPs.
+:;logging:Boolean. If true a verbose list will be logged to <tt>[[Latest.log]]</tt>. This is useful while writing OXPs.
 ::Optional. Default false.
 :;coef:Number. If specified the minimum threshold for returned coef. Unused if <tt>entity</tt> is specified.
@@ Line 61: / Line 61: @@
 *See [[#checkSpaceLane()|checkSpaceLane()]], [[#Table of Player Ships|Table of Player Ships]].
 === checkEQs() ===

@@ Line 156: / Line 156: @@
 {{CodeEx|codeex=worldScripts.Cabal_Common_OXPStrength.checkOXPStrength.grabSTDValue( mass, name ); }}
 {{CodeExTime|native=0.000274|extension=0.000022|js=0.000142}}
-Returns calculated value based on mass based on peak value for the Boa Class Cruiser. Values degrade linear to minimum value. Usecase is to compare the derieved value from [[#checkPower()|checkPower()]] against a list of 'native' values. If name is passed the script will return the standard value for native ships instead if it matches the native names.
+Returns calculated value based peak value for the Boa Class Cruiser. Values degrade linear to minimum value. Usecase is to compare the derieved value from [[#checkPower()|checkPower()]] against a list of 'native' values. If name is passed the script will return the standard value for native ships instead if it matches the native names.
 '''Parameters:'''
@@ Line 167: / Line 167: @@
 * See [[#checkPower()|checkPower()]], [[#Table of Player Ships|Table of Player Ships]].
 == Properties ==

@@ Line 25: / Line 25: @@
 * Subent laser
 * Turrets
 == Functions ==
@@ Line 38: / Line 39: @@
 NPCs:
 The standard range is <500, but OXP entities can have a lot higher value based on their settings. Multilaser ships and/or turreted ships are getting easily >3,000. Everything beyond 1,000 may affect missions. The highest value I've seen was beyond 40,000,000!
 '''Parameters:'''
@@ Line 60: / Line 59: @@
 :;coef:Number. Calculated coefficient.
 ::If <tt>entity</tt> was specified the value for this specific entity, otherwise the highest value in the system.
@@ Line 102: / Line 103: @@
 {{CodeExTime|native=0.000286|extension=0.000151|js=0.000319}}
 Returns array with distances to the main station, witchpoint and lanes (witchpoint->planet, planet->sun, witchpoint->sun).
 '''Parameters:'''
@@ Line 117: / Line 117: @@
 :::*1 - interstellar space, entities close to [0,0,0]
 :::*2 - standard system, entities close to checked locations
 === checkWeapons() ===
@@ Line 134: / Line 137: @@
 :::* 5 - Military Laser
 :::* 8 - Thargoid Laser
 === checkSubWeapons() ===
@@ Line 146: / Line 150: @@
 :;array:Array with the format [Number of Turrets, Number of slots, sum, typestring]. typestring is concatenated string of sum, but exclusive turrets (e.g. "1111").
-* See [[#checkWeapons()|checkWeapons()]]
+* See [[#checkWeapons()|checkWeapons()]].

@@ Line 5: / Line 5: @@
 This is the main class for the OXPStrength with its members and part of the [[Cabal_Common_Library]].
-It is a helper tool specially for mission OXPs to check the environment and helps to determine the players strength. The script is meant for OXP developers only.
+It is a helper tool specially for mission OXPs to check the environment and helps to determine the players strength. The script is meant for OXP developers only and does nothing on it's own. It's main purpose is to help OXPs to decide if specific options should/can be offered to the player or if super strong entities may affect the mission.
-The underlaying API calculates a checksum (coef) for entities. This checksum can be gathered by scripts for specific entities (Player and NPCs). Factors are:
+The underlaying API calculates a checksum (coef) for entities in relation to the hotspots (main station, witchpoint and lanes witchpoint->planet, planet->sun, witchpoint->sun). This checksum can be gathered by scripts for specific entities (Player and NPCs) and for all NPCs. Factors are:
 * Accuracy (v1.7.1)
-* Distance to the hotspots (MainStation,WP and lanes WP,WS,PS)
+* Distance to the hotspots (Main Station, WP and lanes WP, PS, WS)
 * Equipment
 * Escorts / Defense ships
@@ Line 33: / Line 33: @@
 Checks entities and returns the gathered coefficient. This is the main entry point for OXPs.
-For NPCs the standard range is <500, but OXP entities can have a lot higher value based on their settings. A standard Cobra MkIII has a value of ~100 in the beginning and gets up to >500 if fully equipped with standard weaponry, missiles and other standard equipment. The Boa Class Cruiser has even a bit more.
+Player ships:
 *See [[#checkSpaceLane()|checkSpaceLane()]], [[#Table of Player Ships|Table of Player Ships]].
@@ Line 40: / Line 45: @@
 ::Optional.
 :;logging:Boolean. If true a verbose list will be logged to <tt>Latest.log</tt>. This is useful while writing OXPs.
-::Optional.
+::Optional. Default false.
 :;coef:Number. If specified the minimum threshold for returned coef. Unused if <tt>entity</tt> is specified.
 ::Optional. Default 400.
@@ Line 102: / Line 107: @@
 :;entity:Entity.
 :;location:Number.
-::Optional.
+::Optional. Default 7.
 '''Returns:'''
@@ Line 156: / Line 161: @@
 * 3 = coef < 600
 * 4 = coef < 800
-* 5 = coef < 1000
+* 5 = coef < 1,000
-* 6 = coef < 1500
+* 6 = coef < 1,500
-* 7 = coef < 3000
+* 7 = coef < 3,000
-* 8 = coef < 5000
+* 8 = coef < 5,000
 * 9 = otherwise, default setting for <tt>CCL_OXPStrength</tt>.

@@ Line 115: / Line 115: @@
 === checkWeapons() ===
 {{CodeEx|codeex=worldScripts.Cabal_Common_OXPStrength.checkOXPStrength.checkWeapons(entity); }}
-{{CodeExTime|native=0.000176|extension=0.000067|js=0.000152}}
+{{CodeExTime|native=0.000144|extension=0.000061|js=0.000139}}
 Returns array with values for weapons in standard weapon slots (forward, aft, port, starboard).
@@ Line 129: / Line 129: @@
 :::* 5 - Military Laser
 :::* 8 - Thargoid Laser
 === checkSubWeapons() ===

@@ Line 95: / Line 95: @@
 === checkSpaceLane() ===
 {{CodeEx|codeex=worldScripts.Cabal_Common_OXPStrength.checkOXPStrength.checkSpaceLane( entity, location ); }}
-{{CodeExTime|native=0.000550|extension=0.000260|js=0.000545}}
+{{CodeExTime|native=0.000286|extension=0.000151|js=0.000319}}
 Returns array with distances to the main station, witchpoint and lanes (witchpoint->planet, planet->sun, witchpoint->sun).
 *See [[#checkPower()|checkPower()]].