Difference between revisions of "Event Compile.Start"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
(9 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;" | '''Start'''
 +
|-
 +
| colspan="2" | Broadcast to all components that compilation is starting 
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|-
 +
| colspan="2" | Non-zero to prevent compilation 
 +
|}
  
Broadcast to all components that compilation is starting
 
  
This event is part of the [[Event class Compile|Compile]] class
+
Details on using Event Macros can be found here: [[Simulation Events|Event Macros]]
  
__TOC__
 
  
==Parameters==
+
==Detailed description==
''This event has no parameters''
+
When the user clicks compile a component may need to perform checks on its status that Flowcode can not be aware of, and perhaps prevent compilation in extreme circumstances.
  
 
+
This event is a compliment to the [[Event Simulation.Start|Simulation.Start]] event that is broadcast-sent to all components before any text is written to the code file.
==Return value==
 
[[Variable types|ULONG]]
 
Non-zero to prevent compilation
 
 
 
 
 
==Detailed description==
 
''<span style="color:red;">No additional information</span>''
 
  
  
 
==Examples==
 
==Examples==
''<span style="color:red;">No additional information</span>''
 

Latest revision as of 12:32, 16 January 2023

Fc9-comp-macro.png Start
Broadcast to all components that compilation is starting 
Fc9-u32-icon.png - ULONG Return
Non-zero to prevent compilation 


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


Detailed description

When the user clicks compile a component may need to perform checks on its status that Flowcode can not be aware of, and perhaps prevent compilation in extreme circumstances.

This event is a compliment to the Simulation.Start event that is broadcast-sent to all components before any text is written to the code file.


Examples