Stop

This function block is designed to halt a running scenario. It is particularly useful when running scenarios in continuous UI mode, allowing users to stop processes as needed.

📥 Inputs

Boolean This input signal is used to trigger the stop action. Sending a True value will initiate the stop process.

📤 Outputs

This function block does not produce any outputs.

🕹️ Controls

No specific controls are present for this block; its functionality is purely based on input signaling.

🎨 Features

Scenario Stop Functionality The block provides an easy way to halt operations, ensuring that users can manage the flow of their scenarios effectively.

📝 Usage Instructions

1. Connect Stop Signal: Connect a boolean signal to the input socket that will trigger the stop action when set to True.

2. Run in Continuous Mode: Ensure that your scenario is running in continuous UI mode for the stop functionality to take effect.

3. Activate Stop: When the input signal is activated (set to True), the block will execute the stop event call.

📊 Evaluation

Upon execution, if a True signal is received on the input socket, the function block will call the stop event, effectively halting the ongoing scenario.

🛠️ Troubleshooting

No Response Upon Stopping

Ensure that the input socket is connected to a valid boolean signal that is set to True. Additionally, verify that the stop event is correctly installed and ready to be triggered.

Stop Event Not Installed

If the stop functionality does not operate as expected, check whether the stop event has been properly installed with the install_stop_event method. This needs to be done before the block can effectively stop any ongoing scenario.