TransactSell Script - Revision history

Colen: /* Technical Details */

2011-03-01T23:33:30Z

Technical Details

← Older revision		Revision as of 23:33, 1 March 2011
Line 24:		Line 24:

	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|reject		\|class="leftnormal"\|isprimary
			\|(Number) Entry: Indicates whether this is the [[Primary Transaction\|primary transaction]] taking place (non-zero) or not (zero).<br>
			Exit: Ignored.
			\|-
			\|reject
	\|(String) Entry: The empty string to indicate success.<br>		\|(String) Entry: The empty string to indicate success.<br>
	Exit: If non-empty, indicates the transaction was rejected, with the contents being shown to the user as the explanation for the failure.		Exit: If non-empty, indicates the transaction was rejected, with the contents being shown to the user as the explanation for the failure.

Rob: /* Technical Details */

2009-02-20T09:02:39Z

Technical Details

← Older revision		Revision as of 09:02, 20 February 2009
Line 15:		Line 15:
	\|Where Used:		\|Where Used:
	\|[[Component Element (Data)\|Components]]		\|[[Component Element (Data)\|Components]]
			\|-
			\|Procedure Use:
			\|"xactsell" type, "transact" context, "pick" context
	\|-		\|-
	\|}		\|}

Rob at 00:24, 16 December 2008

2008-12-16T00:24:23Z

← Older revision		Revision as of 00:24, 16 December 2008
Line 12:		Line 12:
	\|Fields Finalized?		\|Fields Finalized?
	\|Yes		\|Yes
			\|-
			\|Where Used:
			\|[[Component Element (Data)\|Components]]
	\|-		\|-
	\|}		\|}

Rob at 12:30, 15 December 2008

2008-12-15T12:30:43Z

← Older revision		Revision as of 12:30, 15 December 2008
Line 19:		Line 19:
	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|reject		\|class="leftnormal"\|reject
	\|Entry: The empty string to indicate success.<br>		\|(String) Entry: The empty string to indicate success.<br>
	Exit: If non-empty, indicates the transaction was rejected, with the contents being shown to the user as the explanation for the failure.		Exit: If non-empty, indicates the transaction was rejected, with the contents being shown to the user as the explanation for the failure.
	\|-		\|-
	\|special		\|special
	\|Entry: Value specified with the definition of the portal to allow different behaviors based on usage.<br>		\|(Number) Entry: Value specified with the definition of the portal to allow different behaviors based on usage.<br>
	Exit: Ignored.		Exit: Ignored.
	\|-		\|-

Rob at 10:41, 15 December 2008

2008-12-15T10:41:20Z

← Older revision		Revision as of 10:41, 15 December 2008
Line 30:		Line 30:
	==Description==		==Description==

	The ~~TransactBuy~~ script is invoked at the completion of a "~~buy~~" transaction. The purpose of the script is to appropriately complete the ~~purchase~~. It achieves this by retrieving the details of the transaction from the special "transaction" pick. Once the information is retrieved, whatever actions comprise the ~~purchase~~ can be performed, such as ~~subtracting~~ the ~~cost~~ of the ~~purchase from~~ the cash possessed by the character.		The TransactSell script is invoked at the completion of a "sell" transaction. The purpose of the script is to appropriately complete the sale. It achieves this by retrieving the details of the transaction from the special "transaction" pick. Once the information is retrieved, whatever actions comprise the sale can be performed, such as adding the proceeds of the sale to the cash possessed by the character.

	When invoked, the initial context is the ~~thing~~ being ~~purchased~~. However, this script will primarily be interested in the contents of the "transaction" pick, which can be accessed via the "transaction" context. The transaction pick will contain all of the particulars specified by the user for the ~~purchase~~.		When invoked, the initial context is the pick that is being sold. However, this script will primarily be interested in the contents of the "transaction" pick, which can be accessed via the "transaction" context. The transaction pick will contain all of the particulars specified by the user for the sale.

	The contents of the transaction pick will depend entirely on the "~~buy~~" template utilized. Whatever portals are presented within the ~~buy~~ template will dictate the values of fields within the transaction pick.		The contents of the transaction pick will depend entirely on the "sell" template utilized. Whatever portals are presented within the sell template will dictate the values of fields within the transaction pick.

	The engine will retrieve the final quantity ~~purchased~~ from the "xactQty" field of the transaction pick. The value of this field will dictate the actual quantity ~~assigned to~~ the ~~new~~ pick that is ~~purchased~~.		The engine will retrieve the final quantity sold from the "xactQty" field of the transaction pick. The value of this field will dictate the actual quantity deducted from the pick that is sold. If the entire quantity of the pick is sold, the pick is deleted.

	Please see the separate documentation for further details on [[Transactions\|using transactions]].		Please see the separate documentation for further details on [[Transactions\|using transactions]].
Line 42:		Line 42:
	==Example==		==Example==

	The ~~TransactBuy~~ script below shows the behavior of the Sample data files for handling gear transactions. If the ~~gear~~ is ~~free,~~ the ~~transaction is completed without any changes to~~ the character's ~~cash. Otherwise, the appropriate cash is deducted from the proper usage pool, with a rejection error being reported if there is insufficient~~ cash.		The TransactSell script below shows the behavior of the Sample data files for handling gear transactions. The cash value specified by the user is retrieved and added back to the usage pool the manages the character's cash.

	<pre>		<pre>

Rob: New page: {{context|Kit Reference|Script Types}} ==Technical Details== :{| class="scripttable" |class="leftnormal"|Initial Context: |Pick |- |Alternate Context: |None |- |Fields F...

2008-12-15T10:38:30Z

New page: {{context|Kit Reference|Script Types}} ==Technical Details== :{| class="scripttable" |class="leftnormal"|Initial Context: |Pick |- |Alternate Context: |None |- |Fields F...

New page

{{context|Kit Reference|Script Types}}

==Technical Details==

:{| class="scripttable"
|class="leftnormal"|Initial Context:
|[[Pick Context|Pick]]
|-
|Alternate Context:
|None
|-
|Fields Finalized?
|Yes
|-
|}

The TransactSell script utilizes the following special symbols:

:{| class="infotable"
|class="leftnormal"|reject
|Entry: The empty string to indicate success.<br>
Exit: If non-empty, indicates the transaction was rejected, with the contents being shown to the user as the explanation for the failure.
|-
|special
|Entry: Value specified with the definition of the portal to allow different behaviors based on usage.<br>
Exit: Ignored.
|-
|}

==Description==

The TransactBuy script is invoked at the completion of a "buy" transaction. The purpose of the script is to appropriately complete the purchase. It achieves this by retrieving the details of the transaction from the special "transaction" pick. Once the information is retrieved, whatever actions comprise the purchase can be performed, such as subtracting the cost of the purchase from the cash possessed by the character.

When invoked, the initial context is the thing being purchased. However, this script will primarily be interested in the contents of the "transaction" pick, which can be accessed via the "transaction" context. The transaction pick will contain all of the particulars specified by the user for the purchase.

The contents of the transaction pick will depend entirely on the "buy" template utilized. Whatever portals are presented within the buy template will dictate the values of fields within the transaction pick.

The engine will retrieve the final quantity purchased from the "xactQty" field of the transaction pick. The value of this field will dictate the actual quantity assigned to the new pick that is purchased.

Please see the separate documentation for further details on [[Transactions|using transactions]].

==Example==

The TransactBuy script below shows the behavior of the Sample data files for handling gear transactions. If the gear is free, the transaction is completed without any changes to the character's cash. Otherwise, the appropriate cash is deducted from the proper usage pool, with a rejection error being reported if there is insufficient cash.

<pre>
~get the cash amount specified by the user
var cash as number
cash = hero.transact.field[xactCash].value

~add the amount to the current pool of cash
perform hero.usagepool[TotalCash].adjust[cash]
</pre>