Cabal Common Library Doc SpecialMarkets - Revision history

Svengali: added note about changes

2013-02-14T12:19:49Z

added note about changes

Svengali: /* Overview */

2012-05-29T22:49:56Z

‎Overview

Svengali: calculator for developers added

2011-12-13T12:41:33Z

calculator for developers added

Svengali: checkPSHold() added

2011-12-13T12:25:22Z

checkPSHold() added

Svengali at 18:03, 10 December 2011

2011-12-10T18:03:34Z

Svengali: documentation added

2011-11-14T22:19:46Z

documentation added

New page

== Overview ==
This is the main class for the special markets with its members.

The script gives another option for trading in special goods and calculates prices and availabilities for inserted items.

== Functions ==
=== registerLocation() ===
{{CodeEx|codeex=worldScripts.Cabal_Common_SpecialMarkets.registerLocation(obj); }}
Scripts can specify systems where items can be bought or sold. Only one object with a few properties has to be passed.

'''Properties of obj:'''
:;item:String. Required. Unique Name. Max length 40 chars.
:;galaxy:Array. Required. Galaxy [0...7].
:;buyID:Array. Required. System.IDs [0...255].
:;sellID:Array. Required. System.IDs. If sold (and no contract) callback [0...255].
:;stationID:Array. Required. Station name or 'main'.
:;cb:String. Required. worldScript name for callback.
:;cbb:String. Required. Function that handles the delivery if !contract.
:;priceclass:Number. Required. Base priceclass. The higher the lower the production. [5...100].
:;refresh:Number. Required. Units produced every day [0...1].
:;desc:String. Required. Description.

:;block:Boolean. Blocks cargohold on purchase. If true disables contract.
:;contract:String. If !block it turns it into a cargo contract to a random system in sellID.
:;offset:Number. Sell multiplier for calculated price [1.3...5]. Default 1.3.
:;avail:Number. Starting availability [0...25]. Higher values will lower the prices. Default 0.
:;times: Number. Start time [clock.days-1000...clock.days]. Default clock.days.
:;decrease:Number. Affects prices and produced units over time [0.01...0.5]. Default 0.1.
:;legal:Boolean. Legality of this item. Default true.
:;model:String. Role. Default "cargopod".
:;oneShot:Boolean. One shot deal. If true item will be removed after selling.

'''Returns:'''
:;success:Boolean. True on success.

=== removeTradeItem() ===
{{CodeEx|codeex=worldScripts.Cabal_Common_SpecialMarkets.removeTradeItem(item); }}
Removes the specified item.

'''Parameters:'''
:;item:String. Item to be removed.

'''Returns:'''
:;nothing.

----

[[Category:OXPDoc]]

← Older revision		Revision as of 12:19, 14 February 2013
Line 1:		Line 1:
	== Overview ==		== Overview ==
		+	{{OXPNote\|The market will be turned into a 'Black market' for v1.7.1. For standard goods we already have cims [[New Cargoes]]. More options will become available to handle equipment and special goods. By the time of writing only 1 OXP is affected ([[Vector OXP\|Vector]])}}
	This is the main class for the special markets with its members and part of the [[Cabal_Common_Library]].		This is the main class for the special markets with its members and part of the [[Cabal_Common_Library]].

← Older revision		Revision as of 12:41, 13 December 2011
Line 3:		Line 3:

	The script gives another option for trading in special goods and calculates prices and availabilities for inserted items.		The script gives another option for trading in special goods and calculates prices and availabilities for inserted items.
		+
		+	A calculator (OpenOffice format) for OXP developers is available: [http://www.box.com/s/68r3dqmv9sn605gy3up8 CCL_SpecialMarkets_Calc.zip] (21.3 KB).

	== Functions ==		== Functions ==

@@ Line 1: / Line 1: @@
 == Overview ==
-This is the main class for the special markets with its members.
+This is the main class for the special markets with its members and part of the [[Cabal_Common_Library]].
 The script gives another option for trading in special goods and calculates prices and availabilities for inserted items.

@@ Line 45: / Line 45: @@
 '''Returns:'''
 :;nothing.
 ----

@@ Line 14: / Line 14: @@
 :;buyID:Array. Required. System.IDs [0...255].
 :;sellID:Array. Required. System.IDs. If sold (and no contract) callback [0...255].
-:;stationID:Array. Required. Station name or 'main'.
+:;stationID:Array. Required. Specified stations for buy and sell, e.g. [["main"],["MyStation"]].
 :;cb:String. Required. worldScript name for callback.
 :;cbb:String. Required. Function that handles the delivery if !contract.