API System: Difference between revisions
XML import of API auto-gen |
No edit summary |
||
| (12 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
<sidebar>API Contents</sidebar> | |||
==System== | General system operations | ||
__TOC__ | |||
==Functions provided for this class== | |||
{| | |||
|- | |||
|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.MacroExists|MacroExists]] | |||
|Checks to see if the macro exists by referencing a macro name string | |||
|- | |||
|width="35%"|[[API System.CallMacro|CallMacro]] | |||
|Calls a macro by referencing a macro name string | |||
|- | |||
|width="35%"|[[API System.ShowHandle|ShowHandle]] | |||
|Given a handle to an object with viewable presence, shows that object on screen | |||
|- | |||
|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.WDTEnable|WDTEnable]] | |||
|Enables or disables the software watchdog during long operations | |||
|- | |||
|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 | |||
|- | |||
|width="35%"|[[API System.RedirectMacros|RedirectMacros]] | |||
|Allows calls to one of your children to be redirected to another component | |||
|- | |||
|width="35%"|[[API System.StartSim|StartSim]] | |||
|Starts the simulation runtime. | |||
|- | |||
|width="35%"|[[API System.StopSim|StopSim]] | |||
|Stops the simulation runtime. | |||
|} | |||
=== | ==Examples== | ||
''<span style="color:red;">No additional examples</span>'' | |||
==See also== | |||
''<span style="color:red;">No additional information</span>'' | |||
Latest revision as of 14:57, 27 October 2020
<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 |
| MacroExists | Checks to see if the macro exists by referencing a macro name string |
| CallMacro | Calls a macro by referencing a macro name string |
| ShowHandle | Given a handle to an object with viewable presence, shows that object on screen |
| 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 |
| WDTEnable | Enables or disables the software watchdog during long operations |
| 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 |
| RedirectMacros | Allows calls to one of your children to be redirected to another component |
| StartSim | Starts the simulation runtime. |
| StopSim | Stops the simulation runtime. |
Examples
No additional examples
See also
No additional information