Difference between revisions of "Event Simulation.Pause"

From Flowcode Help
Jump to navigationJump to search
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Pause'''
 +
|-
 +
| colspan="2" | Broadcast to all components that simulation has paused 
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
Broadcast to all components that simulation has paused
 
  
This event is part of the [[Event class Simulation|Simulation]] class
+
Details on using Event Macros can be found here: [[Simulation Events|Event Macros]]
 
 
__TOC__
 
 
 
==Parameters==
 
''This event has no parameters''
 
 
 
 
 
==Return value==
 
[[Variable types|ULONG]]
 
The return of this event is currently unused
 
  
  
Line 18: Line 18:
 
This event is sent to all components when simulation is paused at any time. At this point it may be assumed simulation is active but idle - none of the main flowchart program will be executed whilst paused.
 
This event is sent to all components when simulation is paused at any time. At this point it may be assumed simulation is active but idle - none of the main flowchart program will be executed whilst paused.
  
The system becomes active again on a [[Event Simulation.Resume|Simulation.Resume]]
+
The system becomes active again on a [[Event Simulation.Resume|Simulation.Resume]].
  
  
 
==Examples==
 
==Examples==
''<span style="color:red;">No additional information</span>''
 

Latest revision as of 12:12, 16 January 2023

Fc9-comp-macro.png Pause
Broadcast to all components that simulation has paused 
Fc9-void-icon.png - NONE Return


Details on using Event Macros can be found here: Event Macros


Detailed description

This event is sent to all components when simulation is paused at any time. At this point it may be assumed simulation is active but idle - none of the main flowchart program will be executed whilst paused.

The system becomes active again on a Simulation.Resume.


Examples