Reference 〉Function

Agent.pay( Agent recipient, num amount )

Unilaterally transfers an amount of the monetary good from the agent to a recipient, or from the recipient to the agent if amount<0. Note that this function will raise a RuntimeError if no monetary good has been specified.

Parameters

  • recipient Agent, required

    The object of the agent to receive the funds. The agent object can be retrieved by ID with model.agent().

  • amount num, required

    The amount of the monetary good to pay, or to be paid if less than 0.

Return Value num

The amount actually paid. Normally this will be equal to amount unless the agent's budget constraint is hit.

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.