Built-in Behaviors of Entities

Icon

List of Built-in Behaviors

Built-in Behaviors	Description	Parameter 1	Parameter 2	Parameter 3	Return	Belong to	Agent	Cell	Link	For Formulas	Dependencies
Die	Die					Individual					Agent / Link
GetCell	Get cell at specified coordinates	coordinates: [Number]			Result: Cell	Observer					Cell
GetNeighborCells	Get a list of all Cell individuals within a specified radius centered around the caller's Cell.	radius: 1			Result: [Cell]	Individual					Cell
GetNeighbors	Get Agents within a specified radius, sorted by distance	radius: 1			Result: [Agent]	Individual					Cell
FilterEntities	Filter individuals belonging to the same population from a List or Set	[Entity]			Result: [Entity]	Observer					Entity
GetAgentsOn	Get all Agents on a cell or list of cells	Cell / [Cell]			Result: [Agent]	Observer					Cell
GetRelatives	Get neighbor nodes of the caller in a network	Link	radius: 1	weight: false	Result: [Agent]	Individual					Link
GetPredecessors	Get directed predecessor nodes of the caller in a network	Link	radius: 1	weight: false	Result: [Agent]	Individual					Link
GetSuccessors	Get directed successor nodes of the caller in a network	Link	radius: 1	weight: false	Result: [Agent]	Individual					Link
RemoveNode	Remove a specified node from the network	Agent				Observer					Link
GetLink	Get Link individuals or a list of them between two Agents. If the Link object is non-repeatable, return an entity; if it is repeatable, return the list of entities.	from: Agent	to: Agent		Result: Link/[Link]	Observer					Link
IsActive	Checks whether the entity is currently active.				Bool	Individual					Agent / Link

Notes

• The Call and Ask components can access all built-in behaviors. This makes them beneficial for graphical modeling.
• Behaviors that retrieve information without changing the logic (i.e., except Die and RemoveNode) can be used in expressions.
• Methods beginning with 'Get,' if unable to obtain results, will return None or [] according to the return data format in the above table.
• The table's rightmost "Dependencies" column shows how the system dynamically creates built-in behaviors based on entity types in your model. While this doesn't affect modeling features (like formula bar suggestions, quotes, ask-to-access, etc.), you must include the required entity types in your model to avoid runtime errors.