Skip to main content

Built-in Properties

List of Built-in Properties

Built-in PropertyData TypeBelong toAgentCellLinkAssigned during initializationModified by formulasModified by componentsDependencies
TickNumberGlobal
NowDateTimeGlobal
IDNumberIndividualEntity
ColorStringIndividualCell/Link
SizeNumberIndividualCell/Link
ShapeStringIndividualCell/Link
CoordinatesList[Number]IndividualMove/Place AtCell
CoordinatesList[Number]IndividualCell
AngleNumberIndividualMoveCell
CurrentSpaceCell ObserverIndividualPlace AtCell
CurrentCellCellIndividualCell
LineTypeStringIndividualLink
ThicknessNumberIndividualLink
EndsList[Agent]IndividualLink
WeightNumberIndividualLink
PopulationSizeNumberObserverEntity
IndividualsList[Entity]ObserverEntity
NodesList[Agent]ObserverLink
MaxXNumberObserverCell
MinXNumberObserverCell
MaxYNumberObserverCell
MinYNumberObserverCell

Notes

  • Built-in properties of entities can be overridden by custom properties with the same name.
  • For the data type of entity, any instance not explicitly identified as an Observer refers to individual objects.
  • The Now property only holds a value when the simulation is set to calendar mode in the global model settings.
  • The table's rightmost "Dependencies" column shows how the system dynamically creates built-in properties based on entity types in your model. While this doesn't affect modeling features (like formula bar smart suggestions, quotes, ask-to-access, etc.), you must include the required entity types that built-in properties depend on in your model to avoid runtime errors.

Description of Built-in Property Functions

Built-in PropertyGlobalAgentCellLink
TickCurrent simulation step
NowCalendar time of the current simulation step
IDUnique natural number identifier of the individualUnique natural number identifier of the individualUnique natural number identifier of the individual
ColorColor: The color of an entity, configurable to display specific visual effects within the WorldView and Network View Charts. For detailed values, refer to the Usage of Color Properties.Color of the entity; it can be displayed in chartsColor of the entity; it can be displayed in charts.
SizeSize of the Agent; it can be represented in relevant charts.
ShapeThe shape of an Agent, which configurable to display specific visual effects within the Worldview Charts. The system supports various enumerated values, as detailed in the notes below.
CoordinatesCoordinates of the Agent in spaceNominal position of the Cell, i.e., its center coordinates
AngleOrientation angle of the Agent, [0,360). 0° is East, 90° is North.
CurrentSpaceThe space where the Agent is currently located
CurrentCellThe grid cell where the Agent is currently located
LineTypeLine type of the Link entity. It can be set to show specific visual effects within the network view, using various enumerated values as detailed below.
ThicknessLine width of the Link entity. It can be adjusted to display specific visual effects within the network view.
EndsThe Agents at both ends of the Link entity
WeightStrength of the Link entity. When using methods to obtain closely related entities, distance can be calculated based on weight. Non-negative value.
PopulationSizePopulation sizePopulation sizePopulation size
IndividualsAll individuals in the populationAll individuals in the populationAll individuals in the population
NodesAll Agents in the network graph
MaxXMaximum X coordinate of a Cell in the space.
MinXMinimum X coordinate of a Cell in the space.
MaxYMaximum Y coordinate of a Cell in the space.
MinYMinimum Y coordinate of a Cell in the space.

Notes

  1. Shape Values and Corresponding Icons: Refer to the table below for details, with the default being arrow.
ShapeIcon
arrow
ant
sheep
person
car
circle
wolf
  1. LineType: The system supports the following enumerated values: solid, dashed, and dotted, with the default being solid.

Using Color Properties

  • The Color built-in property is formatted as a string value. For example, it can be set to blue or a hexadecimal color code like #0000FF.
  • HoloBit supports CSS Color standard RGB notation. You can use string names and hexadecimal color codes directly. See https://www.w3.org/TR/css-color-4/#named-colors for details.
  • You can also use the global function rgb(Number1, Number2, Number3) provided by the system to return the color you need.
Model Example

Gradient Function

Usage of Built-in Properties in Modeling

  • The usage of built-in properties is the same as regular custom properties.
  • You can drag and drop quotes for these properties onto the canvas for graphical modeling.
  • Within the scope, you can directly use the built-in properties' names in formulas or expressions. Outside the scope, you can access built-in properties using the format entity_object.property_name.