Difference between revisions of "API System"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import API auto-gen) |
||
| Line 1: | Line 1: | ||
wiki page name | wiki page name | ||
| − | + | General system operations | |
| − | |||
| − | |||
===Functions provided for this class=== | ===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|} | {||-|[[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|} | ||
===Examples=== | ===Examples=== | ||
Revision as of 15:34, 10 May 2013
wiki page name General system operations
