The name or number parameter specify which exception the script branch should wait on. The available exceptions depend on the simulated target. Instead of an exception, the -all flag may be given. The script branch will then wait on any exception.
If no processor object is specified, the currently selected processor is used.
If -recursive is used, not only the object, but the objects hierarchically below the object will be considered when adding the breakpoint. If timeout is a positive number, the command will run for at most that many seconds of virtual time.
If timeout-rt is a positive number, the command will run for at most that many seconds of real time.
A time-out will be signaled by throwing a CLI exception, which can be captured using try/except in order to take specific action, or to let it pass unhandled.
The command will by default only wait for events that occur when the simulation is running forward. To wait for events in the reverse direction use the -reverse flag. Similarly, the -always flag tells the command to wait for events in both simulation directions.