Reference 〉Function

Helipad.summary( str var, str prim = None, str breed = None )

A function, generally used in the debug console, that prints summary statistics (length, mean, standard deviation, variance, maximum, minimum, and sum) for an agent property.

Parameters

  • var str, required

    The property to summarize. Only works for properties with a numeric value.

  • prim str, optional

    Which agent primitive to gather the data from. A value of None will select the first primitive in order, usually 'agent' unless that primitive has been removed or reordered.

    Default value: None

  • breed str, optional

    Limits the data to agents of that particular breed.

    Default value: None

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