Kill

Kill

The kill module allows users to kill agents during the simulation based on a metadata value. 

At each frame the agent metadata with the given name will be compared to the given values and in case it matches any of the criteria the agent will be killed.

For integers and doubles a frame range can be provided.

 


Attributes

Type

Overridable

Description

metadataName

string

no

The metadata name

boolValue

bool

no

The bool value

stringValue

string

no

The string value

intMinValue

int

no

The min value for the integer range.

intMaxValue

int

no

The max value for the integer range.

doubleMinValue

double

no

The min value for the double range.

doubleMaxValue

double

no

The max value for the double range.

invert

bool

yes

If set to true, kills all the agents with a metadata value different from the provided one

Copyright © 2017, Toolchefs LTD.