Reference 〉Function

Helipad.addItem( str obj, str name, str color, str prim = None )

An internal function aliased by model.addGood() and model.addBreed().

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.

Parameters

  • obj str, required

    Either 'breed' or 'good' to indicate which type of item is being added. Other values will raise a ValueError.

  • name str, required

    The name of the object to be added.

  • color str, required

    The hex value (without the initial '#') for the color to represent the item in the control panel and graphs.

  • prim str, optional

    Required if obj=='breed'. Specifies the agent primitive to which the breed should be added.

    Default value: None

Return Value Breed|Good

The newly created Item object, either a Breed or a Good.

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.

History