Difference between revisions of "Event Compile.Start"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
+
<sidebar>Event Contents</sidebar>
 
Broadcast to all components that compilation is starting
 
Broadcast to all components that compilation is starting
  
Line 8: Line 8:
 
==Parameters==
 
==Parameters==
 
''This event has no parameters''
 
''This event has no parameters''
 +
  
 
==Return value==
 
==Return value==
[[Variable types|ULONG]]
+
[[Variable Types|ULONG]]
 +
Non-zero to prevent compilation
 +
 
  
Non-zero to prevent compilation
 
 
==Detailed description==
 
==Detailed description==
''<span style="color:red;">No additional information</span>''
+
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.
  
  
 
==Examples==
 
==Examples==
''<span style="color:red;">No additional information</span>''
+
''<span style="color:red;">No additional examples</span>''

Latest revision as of 15:58, 16 January 2014

<sidebar>Event Contents</sidebar> Broadcast to all components that compilation is starting

This event is part of the Compile class

Parameters

This event has no parameters


Return value

ULONG Non-zero to prevent compilation


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

No additional examples