Oolite JavaScript Reference: Market Scripts - Revision history

Debresser: moved Oolite Javascript Reference: Market Scripts to Oolite JavaScript Reference: Market Scripts: Use capital like all other articles.

2016-01-16T19:59:48Z

moved Oolite Javascript Reference: Market Scripts to Oolite JavaScript Reference: Market Scripts: Use capital like all other articles.

Norby: updateLocalCommodityDefinition example link

2015-12-04T01:18:10Z

updateLocalCommodityDefinition example link

Cim: /* updateGeneralCommodityDefinition */ not null

2014-12-05T22:51:17Z

‎updateGeneralCommodityDefinition: not null

Cim: moved Oolite Javascript Reference: Oolite Market Scripts to Oolite Javascript Reference: Market Scripts

2014-09-13T15:19:29Z

moved Oolite Javascript Reference: Oolite Market Scripts to Oolite Javascript Reference: Market Scripts

Cim: moved Oolite Market Scripts to Oolite Javascript Reference: Oolite Market Scripts: Consistent name

2014-09-13T15:18:53Z

moved Oolite Market Scripts to Oolite Javascript Reference: Oolite Market Scripts: Consistent name

Cim: Market scripts for 1.81

2014-09-13T15:18:34Z

Market scripts for 1.81

New page

'''Note: this page describes functionality currently only in the 1.81 development code. It may change further before being part of a stable release.'''

From Oolite 1.81 it is possible for Javascript to be used to modify station, system and trade good prices. It is possible that a single trade good price/quantity calculation may be affected by more than one script. The order of events in the calculation is as follows:

# Firstly, the primary system market is calculated
## The trade good price and quantity are generated from the values in [[trade-goods.plist]]
## The <code>updateGeneralCommodityDefinition</code> handler of the commodity's [[Trade-goods.plist#market_script|market_script]] will be called to set primary market data for the trade good
## The <code>updateLocalCommodityDefinition</code> handler of the system's [[Planetinfo.plist#market_script|market_script]] will be called to modify primary market data for the trade good.
# Secondary markets are then calculated for each non-main station
## The primary system market is copied into the secondary market, and then quantities are scaled to the station's market capacity
## If the station does not have a market script, the rules in its [[shipdata.plist#market_definition|market_definition]] are applied.
## The <code>updateGeneralCommodityDefinition</code> handler of the commodity's [[Trade-goods.plist#market_script|market_script]] will be called again to set secondary market data for the trade good.
## The <code>updateLocalCommodityDefinition</code> handler of the station's [[shipdata.plist#market_script|market_script]] will be called to modify secondary market data for the trade good.

== Handlers ==

=== updateGeneralCommodityDefinition ===
{{oolite-method-added|1.81}}
function updateGeneralCommodityDefinition (goodDefinition : Object, station : [[Oolite_JavaScript_Reference:_Station|Station]], system : Int) : Object
This method takes an object containing the current good definition (keys as in [[trade-goods.plist]], with an additional "price" key for the current price, "quantity" for the current quantity, and "key" for the identifier of the trade good in the plist), carries out modifications to it based on the station and system, and returns the object in the same format.

In general this method should only modify the "price", "quantity", "capacity", "legality_export" and "legality_import" keys of the goodDefinition object. Modifying other keys is possible but significant caution should be used when doing so.

This method is called for scripts defined for the trade good, and is applied once for each market that good appears at. It may be called twice for the same good - once with station = null to set the primary market, and once with station != null for each secondary market. In general distinguishing between these two cases and performing different modifications will be necessary.

=== updateLocalCommodityDefinition ===
{{oolite-method-added|1.81}}
function updateLocalCommodityDefinition (goodDefinition : Object, station : [[Oolite_JavaScript_Reference:_Station|Station]], system : Int) : Object
This method takes an object containing the current good definition (keys as in [[trade-goods.plist]], with an additional "price" key for the current price, "quantity" for the current quantity, and "key" for the identifier of the trade good in the plist), carries out modifications to it based on the station and system, and returns the object in the same format.

In general this method should only modify the "price", "quantity", "capacity", "legality_export" and "legality_import" keys of the goodDefinition object. Modifying other keys is possible but significant caution should be used when doing so.

This method is called for scripts defined for the system or station, and is called once for each good in that market. To allow the same script to be applied to multiple systems or stations, the station and system parameters will give the current context.

[[Category:Oolite JavaScript Reference]]

← Older revision		Revision as of 01:18, 4 December 2015
Line 32:		Line 32:

	This method is called for scripts defined for the system or station, and is called once for each good in that market. To allow the same script to be applied to multiple systems or stations, the station and system parameters will give the current context.		This method is called for scripts defined for the system or station, and is called once for each good in that market. To allow the same script to be applied to multiple systems or stations, the station and system parameters will give the current context.
		+
		+	[http://aegidian.org/bb/viewtopic.php?f=4&t=17621#p239979 Here is an example] how to use this function.

← Older revision	Revision as of 19:59, 16 January 2016
(No difference)

@@ Line 22: / Line 22: @@
 In general this method should only modify the "price", "quantity", "capacity", "legality_export" and "legality_import" keys of the goodDefinition object. Modifying other keys is possible but significant caution should be used when doing so.
-This method is called for scripts defined for the trade good, and is applied once for each market that good appears at. It may be called twice for the same good - once with station = null to set the primary market, and once with station != null for each secondary market. In general distinguishing between these two cases and performing different modifications will be necessary.
+This method is called for scripts defined for the trade good, and is applied once for each market that good appears at. It may be called twice for the same good - once with station = false to set the primary market, and once with station = (Station) for each secondary market. In general distinguishing between these two cases and performing different modifications will be necessary.
 === updateLocalCommodityDefinition ===

← Older revision	Revision as of 15:19, 13 September 2014
(No difference)

← Older revision	Revision as of 15:18, 13 September 2014
(No difference)