TransactSell Script
Context: HL Kit … Kit Reference … Script Types
Technical Details
Initial Context: Pick Alternate Context: None Fields Finalized? Yes
The TransactSell script utilizes the following special symbols:
reject Entry: The empty string to indicate success.
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.
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 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.
~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]
