API System: Difference between revisions
XML import of updated API docs |
No edit summary |
||
| (3 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
<sidebar>API Contents</sidebar> | |||
<sidebar>API | |||
General system operations | General system operations | ||
| Line 15: | Line 13: | ||
|width="35%"|[[API System.Forward|Forward]] | |width="35%"|[[API System.Forward|Forward]] | ||
|Sends the currently processing message to the target | |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]] | |width="35%"|[[API System.ShowHandle|ShowHandle]] | ||
| Line 39: | Line 43: | ||
|width="35%"|[[API System.TimerStop|TimerStop]] | |width="35%"|[[API System.TimerStop|TimerStop]] | ||
|Kills any timers with the given ident for this component | |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]] | |width="35%"|[[API System.ClaimEvent|ClaimEvent]] | ||
| Line 57: | Line 64: | ||
|width="35%"|[[API System.RedirectMacros|RedirectMacros]] | |width="35%"|[[API System.RedirectMacros|RedirectMacros]] | ||
|Allows calls to one of your children to be redirected to another component | |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. | |||
|} | |} | ||
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