Difference between revisions of "API System"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
Line 1: Line 1:
 
<sidebar>API contents</sidebar>
 
<sidebar>API contents</sidebar>
 
General system operations
 
General system operations
 +
 +
__TOC__
  
 
==Functions provided for this class==
 
==Functions provided for this class==
Line 51: Line 53:
 
==Examples==
 
==Examples==
 
''No examples available''
 
''No examples available''
 +
 +
==See also==

Revision as of 21:25, 11 May 2013

<sidebar>API contents</sidebar> General system operations

Functions provided for this class

Notify Sends a System.User message to the targeted component
Forward Sends the currently processing message to the target
CreateHandle Creates a general-purpose garbage collected handle for resource management
SetHandleWord Sets a general purpose word in the handle for use by its owner
GetHandleWord Gets a general-purpose word set by the owner of a custom handle
DeleteHandle Deletes any handle created by the component
GetSender Gets the handle of the component that posted this event - 0 for system
TimerStart Calls the Component.Timer event with Ident as an argument after Millisecs time
TimerStop Kills any timers with the given ident for this component
ClaimEvent Claims an event message by name, returns true if claimed
ReleaseEvent Releases a previously claimed an event message by name, returns true if released
EnableEvent Allows an event to be fired or removes the ability for an event to fire - this may be nested
ClaimMouse Claims mouse clicks for the target object
ReleaseMouse Releases mouse clicks for the target object


Examples

No examples available

See also