From Bright Pattern Documentation
Matt.lashley (talk | contribs) m |
Wyler.metge (talk | contribs) (Updated via BpClonePage extension. Source page: draft:Scenario-builder-reference-guide/ScenarioBlocks/StartAnotherScenario) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | = Start Another Scenario= | |
| − | The Start Another Scenario block starts the specified scenario from within the given (parent) scenario | + | The Start Another Scenario block starts the specified scenario from within the given (parent) scenario. |
| − | [[File: | + | [[File:Start_another_scenario_palette_icon.png|alt=|frameless]] |
| − | |||
| − | + | Variables defined in the parent scenario are inherited by the "child" scenario, and if control returns to the parent, variables defined by the child are passed back to the parent. Whether control of the scenario returns to the parent depends on how the child scenario completes execution: | |
| − | |||
| + | * If the child scenario reaches a [[Scenario-builder-reference-guide/ScenarioBlocks/Return|Return]] block (or reaches its last block without executing an [[Scenario-builder-reference-guide/ScenarioBlocks/Exit|Exit]] block), control returns to the parent scenario and execution resumes at the block immediately following the Start Another Scenario block. | ||
| + | |||
| + | |||
| + | * If the child scenario reaches an [[Scenario-builder-reference-guide/ScenarioBlocks/Exit|Exit]] block, or terminates because of an error or disconnect, control ''does not'' return to the parent, and scenario execution ends. | ||
| − | |||
[[File:Start-Another-Scenario-Settings.png|800px|thumbnail|center|Scenario Builder Start Another Scenario block settings]] | [[File:Start-Another-Scenario-Settings.png|800px|thumbnail|center|Scenario Builder Start Another Scenario block settings]] | ||
| + | ===Configure the block === | ||
| + | |||
| + | |||
| + | * Select the desired child scenario in the drop-down list. | ||
| + | |||
| + | |||
| + | * Start typing the desired child scenario name in the search box to show a list of matching scenarios. | ||
| − | + | The label of the block in the flowchart will display ''Start Another Scenario “[scenario name]”.'' In the scenario shown, you can see that the Start Another Scenario block is used if the [[Scenario-builder-reference-guide/ScenarioBlocks/ConnectCall|Connect Call]] block reaches the [[Scenario-builder-reference-guide/ScenarioBlocks/ConnectCall#Target Disconnected|Target Disconnected conditional exit]]. | |
Latest revision as of 09:51, 28 March 2025
Start Another Scenario
The Start Another Scenario block starts the specified scenario from within the given (parent) scenario.
Variables defined in the parent scenario are inherited by the "child" scenario, and if control returns to the parent, variables defined by the child are passed back to the parent. Whether control of the scenario returns to the parent depends on how the child scenario completes execution:
- If the child scenario reaches a Return block (or reaches its last block without executing an Exit block), control returns to the parent scenario and execution resumes at the block immediately following the Start Another Scenario block.
- If the child scenario reaches an Exit block, or terminates because of an error or disconnect, control does not return to the parent, and scenario execution ends.
Configure the block
- Select the desired child scenario in the drop-down list.
- Start typing the desired child scenario name in the search box to show a list of matching scenarios.
The label of the block in the flowchart will display Start Another Scenario “[scenario name]”. In the scenario shown, you can see that the Start Another Scenario block is used if the Connect Call block reaches the Target Disconnected conditional exit.