Reference 〉Hook

pay( Agent agent, Agent recipient, num amount, Helipad model )

Runs when an agent pays another agent. This hook can allow payment to be diverted into forms other than a transfer of the monetary good.

Required Parameters

  • agent Agent

    The agent initiating the payment.

  • recipient Agent

    The agent receiving the payment.

  • amount num

    The amount of the monetary good to be paid to recipient.

  • model Helipad

    The model object.

Expected Return Value num

The amount of the monetary good to actually transfer.

Notes and Examples

  1. Contribute a Note

    Your email address will not be published. Required fields are marked *

    You may use limited HTML for formatting. Please embed blocks of code in <pre><code> </code></pre> tags.