Reference 〉 Function


Retrieves the value of the parameter. Should not be called directly; use model.param() instead.

WARNING: This is an internal function. Its use in user code is not recommended or supported, and its signature can change in future updates without warning. Use one of the suggested functions above instead, if applicable.


  • item str, optional

    For a per-breed or per-good parameter, this specifies the breed or good whose parameter value should be returned. Otherwise the function returns a dict of values corresponding to the breeds or goods.

    Default value: None

Return Value str|bool|num|dict

The current value of the parameter, a str for a menu, a bool for a checkbox, or a num for a slider. If the parameter is a per-good or per-breed parameter and item is not specified, the function returns a dict of values.

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.