Skip to content

Commit

Permalink
fixup
Browse files Browse the repository at this point in the history
  • Loading branch information
Robadob authored Nov 29, 2024
1 parent 31cdd66 commit cab22de
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/guide/defining-agents/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Agent ID
All agents have a built in ID variable. This is a number which uniquely identifies this agent. Each agent will automatically be assigned an ID when the simulation
starts or the agent is birthed. The ID is value for every agent is unique among agents of all types. There is currently no way to change the ID of an agent. The agent ID variable is of type :type:`flamegpu::id_t` (Python: ``ID``) which is an ``unsigned int`` by default, but can be redefined if more IDs are required, e.g. a model with extremely high rates of agent birth/death.

The symbol :var:`flamegpu::ID_NOT_SET` , equal to ``0``, is reserved and will never be assigned as an agent's id. Therefore it can be used if invalid or no ID must be represented.
The symbol :var:`flamegpu::ID_NOT_SET` , equal to ``0``, is reserved and will never be assigned as an agent's ID. Therefore it can be used if invalid or no ID must be represented.

User Defined Variables
----------------------
Expand Down

0 comments on commit cab22de

Please sign in to comment.