documented pack type data types.

git-svn-id: svn://svn.code.sf.net/p/magicseteditor/code/trunk@1065 0fc631ac-6414-0410-93d0-97cfa31319b6

doc/type/game.txt

@@ -34,7 +34,12 @@ Such a package contains a [[file:format|data file]] called <tt>game</tt> that ha
 | @card fields@			[[type:list]] of [[type:field]]s	 		Fields for each card.
 | @card list color script@	[[type:script]]				from fields	Script that determines the color of an item in the card list. <br/>If not set uses the @card list colors@ property of the first card field that has it.
 | @statistics dimensions@	[[type:list]] of [[type:statistics dimension]]s		from fields	Dimensions for statistics, a dimension is rougly the same as an axis. <br/>By default all card fields with 'show statistics' set to true are used.
-| @statistics categories@	[[type:list]] of [[type:statistics category]]s		from dimensions	Choices shown on the statistics panel. <br/>By default all statistics dimensions are used.
+| @statistics categories@	[[type:list]] of [[type:statistics category]]s		from dimensions	DOC_MSE_VERSION: not used since 0.3.6
+				 					 		Choices shown on the statistics panel. <br/>By default all statistics dimensions are used.
+| @pack items@			[[type:list]] of [[type:pack item]]s	 		DOC_MSE_VERSION: since 0.3.7
+				 					 		The categories of items that can be in booster packs.<br/> For example "commons", "uncommons" and "rares" are pack items.
+| @pack types@			[[type:list]] of [[type:pack type]]s	 		DOC_MSE_VERSION: since 0.3.7
+				 					 		The types of card packs that will be listed on the random booster panel.
 | @has keywords@		[[type:boolean]]			@false@		Does this game use keywords? Should the keywords tab be available?
 | @keyword match script@	[[type:script]]				@;@		Script to apply to the @match@ property of keywords.
 | @keyword modes@		[[type:list]] of [[type:keyword mode]]s		 	Choices for the 'mode' property of keywords.

doc/type/pack_item.txt

@@ -0,0 +1,21 @@
+Data type: card pack item
+
+DOC_MSE_VERSION: since 0.3.7
+
+--Overview--
+
+A type of card that can be included in [[type:pack type|card pack types]].
+
+The pack item describes how this type of card is selected from the set.
+
+--Properties--
+! Property	Type			Description
+| @name@	[[type:string]]		Name of this type of item.
+| @filter@	[[type:script]]		Condition that a card must satisfy to be selected.
+
+--Example--
+>pack item:
+>	name: rare
+>	filter: card.rarity == "rare"
+
+Rare cards are those with the rarity value of @"rare"@.

doc/type/pack_item_reference.txt

@@ -0,0 +1,24 @@
+Data type: card pack item reference
+
+DOC_MSE_VERSION: since 0.3.7
+
+--Overview--
+
+A reference to a [[type:pack item]].
+
+
+
+--Properties--
+! Property	Type				Default		Description
+| @name@	Name of a [[type:pack item]]	''required''	Name of the pack item to include in this pack.
+| @amount@	[[type:scriptable]] [[type:double]]	1	How many of those cards are in the pack?
+| @type@	@"replace"@, @"no replace"@ or @"cyclic"@	@"replace"@	How should the cards be selected? The options are: <ul><li>Random with replacement</li><li>Random without replacement</li><li>Cyclic, selecting each card in turn</li></ul>
+
+--Example--
+>item:
+>	name: common
+>	amount: 11
+>	type: no replace
+
+Include 11 commons in this [[type:pack type|pack]].
+The cards will be selected without replacement, so the pack is guaranteed not to contain duplicate cards (if the set is large enough).

doc/type/pack_type.txt

@@ -0,0 +1,30 @@
+Data type: card pack type
+
+DOC_MSE_VERSION: since 0.3.7
+
+--Overview--
+
+A type of card packs. For instance "booster" and "tournament pack" are card pack types.
+
+A pack type contains one or more [[type:pack item reference]]s, indicating what kinds and how many cards are in the pack.
+
+--Properties--
+! Property	Type					Default		Description
+| @name@	[[type:string]]				 		Name of this card pack type.
+| @enabled@	[[type:scriptable]] [[type:boolean]]	@true@		Is this pack type enabled, i.e. can the user select it?
+| @items@	[[type:list]] of [[type:pack item reference]]s	 	The items to include in this pack.
+
+--Example--
+>pack type:
+>	name: booster pack
+>	item:
+>		name: rare
+>		amount: 1
+>	item:
+>		name: uncommon
+>		amount: 3
+>	item:
+>		name: common
+>		amount: 11
+
+A Magic booster pack contains 1 rare, 3 uncommons and 11 commons.

doc/type/statistics_category.txt

@@ -1,5 +1,7 @@
 Data type: statistics category
 
+DOC_MSE_VERSION: not used since 0.3.6
+
 --Overview--
 
 A category in the statistics panel.