Difference between revisions of "API System"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
(XML import) |
||
| Line 2: | Line 2: | ||
General system operations | General system operations | ||
| − | + | ==Functions provided for this class== | |
| − | {||-|[[API System.Notify|Notify]]|Sends a System.User message to the targeted component|-|[[API System.Forward|Forward]]|Sends the currently processing message to the target|-|[[API System.CreateHandle|CreateHandle]]|Creates a general-purpose garbage collected handle for resource management|-|[[API System.SetHandleWord|SetHandleWord]]|Sets a general purpose word in the handle for use by its owner|-|[[API System.GetHandleWord|GetHandleWord]]|Gets a general-purpose word set by the owner of a custom handle|-|[[API System.DeleteHandle|DeleteHandle]]|Deletes any handle created by the component|-|[[API System.GetSender|GetSender]]|Gets the handle of the component that posted this event - 0 for system|-|[[API System.TimerStart|TimerStart]]|Calls the Component.Timer event with Ident as an argument after Millisecs time|-|[[API System.TimerStop|TimerStop]]|Kills any timers with the given ident for this component|-|[[API System.ClaimEvent|ClaimEvent]]|Claims an event message by name, returns true if claimed|-|[[API System.ReleaseEvent|ReleaseEvent]]|Releases a previously claimed an event message by name, returns true if released|-|[[API System.EnableEvent|EnableEvent]]|Allows an event to be fired or removes the ability for an event to fire - this may be nested|-|[[API System.ClaimMouse|ClaimMouse]]|Claims mouse clicks for the target object|-|[[API System.ReleaseMouse|ReleaseMouse]]|Releases mouse clicks for the target object|} | + | {| |
| + | |- | ||
| + | |width="35%"|[[API System.Notify|Notify]] | ||
| + | |Sends a System.User message to the targeted component | ||
| + | |- | ||
| + | |width="35%"|[[API System.Forward|Forward]] | ||
| + | |Sends the currently processing message to the target | ||
| + | |- | ||
| + | |width="35%"|[[API System.CreateHandle|CreateHandle]] | ||
| + | |Creates a general-purpose garbage collected handle for resource management | ||
| + | |- | ||
| + | |width="35%"|[[API System.SetHandleWord|SetHandleWord]] | ||
| + | |Sets a general purpose word in the handle for use by its owner | ||
| + | |- | ||
| + | |width="35%"|[[API System.GetHandleWord|GetHandleWord]] | ||
| + | |Gets a general-purpose word set by the owner of a custom handle | ||
| + | |- | ||
| + | |width="35%"|[[API System.DeleteHandle|DeleteHandle]] | ||
| + | |Deletes any handle created by the component | ||
| + | |- | ||
| + | |width="35%"|[[API System.GetSender|GetSender]] | ||
| + | |Gets the handle of the component that posted this event - 0 for system | ||
| + | |- | ||
| + | |width="35%"|[[API System.TimerStart|TimerStart]] | ||
| + | |Calls the Component.Timer event with Ident as an argument after Millisecs time | ||
| + | |- | ||
| + | |width="35%"|[[API System.TimerStop|TimerStop]] | ||
| + | |Kills any timers with the given ident for this component | ||
| + | |- | ||
| + | |width="35%"|[[API System.ClaimEvent|ClaimEvent]] | ||
| + | |Claims an event message by name, returns true if claimed | ||
| + | |- | ||
| + | |width="35%"|[[API System.ReleaseEvent|ReleaseEvent]] | ||
| + | |Releases a previously claimed an event message by name, returns true if released | ||
| + | |- | ||
| + | |width="35%"|[[API System.EnableEvent|EnableEvent]] | ||
| + | |Allows an event to be fired or removes the ability for an event to fire - this may be nested | ||
| + | |- | ||
| + | |width="35%"|[[API System.ClaimMouse|ClaimMouse]] | ||
| + | |Claims mouse clicks for the target object | ||
| + | |- | ||
| + | |width="35%"|[[API System.ReleaseMouse|ReleaseMouse]] | ||
| + | |Releases mouse clicks for the target object | ||
| + | |} | ||
| − | + | ||
| + | ==Examples== | ||
| + | ''No examples available'' | ||
Revision as of 21:14, 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
