NewCargoesAPI - Revision history

Cholmondely: Added example

2024-05-29T09:48:31Z

Added example

2023-09-20T13:46:17Z

Retagged!

2023-04-19T12:08:23Z

‎registerCargoType: Added example code

2012-04-15T10:50:51Z

‎System Trading data: Versioning info

2012-04-15T10:47:45Z

‎System Trading data: New API functions

2012-04-14T09:23:25Z

‎tradeFloor: Fix header level

2012-04-14T09:21:30Z

Add OXP API documentation category

2012-04-13T08:51:30Z

‎controlledGood: API doc fix thanks to Capt. Murphy

2012-04-12T21:46:11Z

‎The player's manifest: Additional function in 1.0.1

2012-04-11T20:44:19Z

worldScript --> worldScripts correction in header for function calling example

@@ Line 350: / Line 350: @@
 Used to return the player to the trade floor after talking with a
 trade floor personality.
 [[Category:OXP API's]]

@@ Line 20: / Line 20: @@
 in the long term than safe trading of the same generic good in an
 Agri/Ind pair, provided that the trader makes reasonably optimal
-decisions:
+decisions.
 * '''ID''': The unique ID of the cargo type. Can only contain letters, numbers, underscores, dots and dashes.

@@ Line 210: / Line 210: @@
 ===checkExports===
 <code>bool checkExports(Station station)</code>
 Returns true if this station applies legal penalties for export of controlled cargo.
@@ Line 215: / Line 216: @@
 ===checkImports===
 <code>bool checkImports(Station station)</code>
 Returns true if this station applies legal penalties for import of controlled cargo.

← Older revision		Revision as of 10:47, 15 April 2012
Line 207:		Line 207:

	''marketinfo'' is the world script that defines the market for the relevant station. (e.g. <code>worldScripts["CargoTypeExtension-Station-RockHermit"]</code>) Use [[#defaultMarketInfo\|defaultMarketInfo]] for the main station.		''marketinfo'' is the world script that defines the market for the relevant station. (e.g. <code>worldScripts["CargoTypeExtension-Station-RockHermit"]</code>) Use [[#defaultMarketInfo\|defaultMarketInfo]] for the main station.
		+
		+	===checkExports===
		+	<code>bool checkExports(Station station)</code>
		+
		+	Returns true if this station applies legal penalties for export of controlled cargo.
		+
		+	===checkImports===
		+	<code>bool checkImports(Station station)</code>
		+
		+	Returns true if this station applies legal penalties for import of controlled cargo.

	===defaultMarketInfo===		===defaultMarketInfo===

@@ Line 329: / Line 329: @@
 message length and content.
-==tradeFloor==
+===tradeFloor===
 <code>void tradeFloor()</code>

← Older revision		Revision as of 09:21, 14 April 2012
Line 334:		Line 334:
	Used to return the player to the trade floor after talking with a		Used to return the player to the trade floor after talking with a
	trade floor personality.		trade floor personality.
		+
		+	[[Category:OXPDoc]]

@@ Line 293: / Line 293: @@
 ===controlledGood===
-<code>int controlledGood(CargoID good)</code>
+<code>bool controlledGood(CargoID good)</code>
-Returns the basic export penalty for this good, ''including'' any
+Returns true if there is a basic export penalty for this good, ''including'' any
-effects from the generic type.
+effects from the generic type. This does not take into account any local effects
 ===extendableCargo===

@@ Line 92: / Line 92: @@
 returns true if successful. There must be sufficient hold space
 available, and the cargo ID must have previously been defined.
 ''origininfo'' is a description of the origin of the good - for
@@ Line 101: / Line 102: @@
 Returns the number of TCs of the given cargo which the player
 currently has in their manifest.
 ===removeSpecialCargo===
@@ Line 106: / Line 120: @@
 Attempts to remove 1 TC of special cargo from the player's hold,
-returning true if successful.
+returning true if successful. Generic cargo levels will also be updated by this function.
 ===restorePlayerManifest===
@@ Line 123: / Line 137: @@
 ===specialCargoesCarried===
 <code>CargoIDs specialCargoesCarried()</code>
 Returns a list of the IDs of the distinct cargo types carried by the player.
 ===suspendPlayerManifest===
-<code>SerialisedData suspendPlayerManifest(SerialisedData ncmanifest)</code>
+<code>SerialisedData suspendPlayerManifest()</code>
 Discards all new cargoes information for the player, converting all
 hold goods to their generic type, and returns a string describing
-their specific types which can be given to
+their specific types which can be given to [[#mergePlayerManifest|mergePlayerManifest]] or
 [[#restorePlayerManifest|restorePlayerManifest]] later.

@@ Line 2: / Line 2: @@
 functionality in a variety of ways. All API functions are in the
 CargoTypeExtension worldScript, and are called with
-<code>worldScript.CargoTypeExtension.''functionName''</code>
+<code>worldScripts.CargoTypeExtension.''functionName''</code>
 ==Registration==