Runs when an agent is clicked in the SpatialPlot
plot.
Required Parameters
agents — list[Agent]
The live agent(s) that were clicked on, possibly multiple if there are overlapping agents in the current map. Note that, if clicking on a historical map state (i.e. having scrubbed the time bar backward), the clicked agent may be dead, in which case None will be passed instead of an agent object.
plot — SpatialPlot
The
SpatialPlot
object that was clicked on.t — int
The time currently displayed on the time slider. This may not match the current model time if the time slider has been scrubbed backward.
charwick
Feb 10, 2021 at 4:24Usually it will be desirable only to take an action if an agent is clicked while the current model time is displayed in the visualizer, since any actions taken will affect the current model state rather than the historical state. The third parameter can be used to ensure that the action is only taken when the visualization is current.