TransactSetup Script - Revision history

Colen: /* Technical Details */

2011-03-01T23:32:36Z

Technical Details

← Older revision		Revision as of 23:32, 1 March 2011
Line 30:		Line 30:
	\|ispick		\|ispick
	\|(Number) Entry: Indicates whether the context is a pick (non-zero) or a thing (zero).<br>		\|(Number) Entry: Indicates whether the context is a pick (non-zero) or a thing (zero).<br>
			Exit: Ignored.
			\|-
			\|isprimary
			\|(Number) Entry: Indicates whether this is the [[Primary Transaction\|primary transaction]] taking place (non-zero) or not (zero).<br>
	Exit: Ignored.		Exit: Ignored.
	\|-		\|-

Colen: /* Technical Details */

2011-03-01T23:29:50Z

Technical Details

← Older revision		Revision as of 23:29, 1 March 2011
Line 35:		Line 35:
	\|(Number) 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.
			\|-
			\|notransact
			\|(Number) Entry: 0<br>
			Exit: If set to non-zero in the setup script for a "sell" transaction, no sell transaction happens - instead, the regular "Delete?" form is shown instead.

			This is intended for Shadowrun and similar games, where you always want to refund 100% of an item's cost during character creation, or while building an item - in those cases, you don't sell something, you're actually "un-buying" it so the money was never deducted in the first place.

			This is totally ignored in the xactsetup script for a "buy" transaction.
	\|-		\|-
	\|}		\|}

Rob: /* Technical Details */

2009-02-20T09:02:09Z

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:
			\|"xactsetup" type, "transact" context, "pick" context
	\|-		\|-
	\|}		\|}

Rob at 00:24, 16 December 2008

2008-12-16T00:24:07Z

← 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]]
	\|-		\|-
	\|}		\|}
Line 29:		Line 32:
	\|(Number) 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.
	\|-
	~~\|Where Used:~~
	~~\|[[Component Element (Data)\|Components]]~~
	\|-		\|-
	\|}		\|}

Rob at 00:23, 16 December 2008

2008-12-16T00:23:27Z

← Older revision		Revision as of 00:23, 16 December 2008
Line 29:		Line 29:
	\|(Number) 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.
			\|-
			\|Where Used:
			\|[[Component Element (Data)\|Components]]
	\|-		\|-
	\|}		\|}

Rob at 12:29, 15 December 2008

2008-12-15T12:29:47Z

← Older revision		Revision as of 12:29, 15 December 2008
Line 19:		Line 19:
	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|isbuy		\|class="leftnormal"\|isbuy
	\|Entry: Indicates whether the transaction is buy (non-zero) or sell (zero).<br>		\|(Number) Entry: Indicates whether the transaction is buy (non-zero) or sell (zero).<br>
	Exit: Ignored.		Exit: Ignored.
	\|-		\|-
	\|ispick		\|ispick
	\|Entry: Indicates whether the context is a pick (non-zero) or a thing (zero).<br>		\|(Number) Entry: Indicates whether the context is a pick (non-zero) or a thing (zero).<br>
	Exit: Ignored.		Exit: Ignored.
	\|-		\|-
	\|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 00:08, 15 December 2008

2008-12-15T00:08:00Z

← Older revision		Revision as of 00:08, 15 December 2008
Line 53:		Line 53:

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

	~~{{note}}The TransactSetup script is only invoked when buying and selling items that belong to a component that is stackable. If the component does not support stacking, the~~


	==Example==		==Example==

	The ~~Change~~ script below shows ~~how~~ the ~~calculation~~ of XP cost is ~~performed for~~ the ~~World~~ of ~~Darkness game system. This example~~ is ~~edited down~~ to ~~show~~ the ~~core behaviors,~~ as ~~the real script handles additional factors~~.		The TransactSetup script below shows the behavior of the Sample data files for handling gear transactions. The "each" cost is setup to the cost of the gear, the actual amount paid is set to zero so that default handling is used, and the gear is identified as a holder if appropriate.

	<pre>		<pre>

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

2008-12-14T23:42:32Z

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

New page

{{context|Kit Reference|Script Types}}

==Technical Details==

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

The TransactSetup script utilizes the following special symbols:

:{| class="infotable"
|class="leftnormal"|isbuy
|Entry: Indicates whether the transaction is buy (non-zero) or sell (zero).<br>
Exit: Ignored.
|-
|ispick
|Entry: Indicates whether the context is a pick (non-zero) or a thing (zero).<br>
Exit: Ignored.
|-
|special
|Entry: Value specified with the definition of the portal to allow different behaviors based on usage.<br>
Exit: Ignored.
|-
|}

==Description==

The TransactSetup script is invoked at the beginning of a [[Transactions|transaction]], whether it be a buy or sell operation. When invoked, the initial context is either the thing being purchased or the pick being sold. The script can also access the separate "transaction" context to manipulate the transaction pick. In fact, the role of the TransactSetup script is to appropriately configure the transaction pick so that everything is properly presented and handled for the user.

The engine will automatically setup the transaction pick with a few pieces of information. It's up to you to setup the remaining details for how you want the transaction to be handled. The automatic behaviors of the engine differs for buying and selling operations, so both are outlined separately below.

Setup logic for a "buy" transaction:
#The "xactName" field is set to the name of the thing being purchased
#The "xactLimit" field is set to no limit
#The "xactQty" field is set to the lot size for the thing being purchased
#The TransactSetup script is invoked

Setup logic for a "sell" transaction:
#The "xactName" field is set to the name of the thing being purchased
#The "xactLimit" field is set to the total quantity possessed for the pick
#The "xactQty" field is set to the total quantity possessed
#The TransactSetup script is invoked

Within the TransactSetup script, the "xactEach" field must always be set to the proper unit cost for the item being purchased or sold. Other fields may be setup as you deem appropriate to the transaction requirements.

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

{{note}}The TransactSetup script is only invoked when buying and selling items that belong to a component that is stackable. If the component does not support stacking, the

==Example==

The Change script below shows how the calculation of XP cost is performed for the World of Darkness game system. This example is edited down to show the core behaviors, as the real script handles additional factors.

<pre>
~start by assuming our unit cost is the cost of one item
var cost as number
cost = field[grCost].value

~setup the unit cost for the item
hero.transact.field[xactEach].value = cost

~zero out the cash amount to be paid (implying use of the standard cost)
hero.transact.field[xactCash].value = 0

~if the item is gear, setup whether the item holds other gear
if (isgear <> 0) then
hero.transact.field[xactHolder].value = gearcount
endif
</pre>