Flowcode Help - User contributions [en]

MediaWiki:Group-user.css

2026-07-28T09:14:48Z

SteveT:

/* CSS placed here will affect registered users only */

/*
#vector-page-tools-dropdown {
display: block !important;
}
*/

/* Ensure the toolbar is visible for logged-in users */
#right-navigation {
display: flex !important;
}

#left-navigation {
display: flex !important;
}

MediaWiki:Common.css

2026-07-28T09:12:51Z

SteveT:

/* CSS placed here will be applied to all skins */
.noautonum .tocnumber { display: none; }

/* Edits by ST090726 to improve dark mode */
@media screen {
html.skin-theme-clientpref-night {
}

html.skin-theme-clientpref-night .mw-parser-output > span.mw-default-size:not(.skin-invert-image) img,html.skin-theme-clientpref-night section .mw-heading ~ div > span.mw-default-size:not(.skin-invert-image) img,html.skin-theme-clientpref-night section > span.mw-default-size:not(.skin-invert-image) img,html.skin-theme-clientpref-night dd > span.mw-default-size:not(.skin-invert-image) img,html.skin-theme-clientpref-night p > span.mw-default-size:not(.skin-invert-image) img,html.skin-theme-clientpref-night .mw-parser-output > figure[typeof^='mw:File']:not(.skin-invert-image) img,html.skin-theme-clientpref-night section .mw-heading ~ div > figure[typeof^='mw:File']:not(.skin-invert-image) img,html.skin-theme-clientpref-night section > figure[typeof^='mw:File']:not(.skin-invert-image) img,html.skin-theme-clientpref-night dd > figure[typeof^='mw:File']:not(.skin-invert-image) img,html.skin-theme-clientpref-night p > figure[typeof^='mw:File']:not(.skin-invert-image) img {
background-color: transparent;
color: var(--color-base-fixed,#202122);
filter: brightness(0.8)
}

.tabs-label {
cursor: pointer;
padding: 1px 6px;
background-color: transparent;
border: 1px solid #AAA;
}

.tabs-tabbox > .tabs-input:checked + .tabs-label, .tabs-input-0:checked + .tabs-input-1 + .tabs-label {
z-index: 2;
background-color: #ae92b3a0; /*#a022b5a8;*/
font-weight: bold;
}

}

/* These vars are not used. Use the classes below instead. */
:root {
--mtx-tabs-bk-head: #ae92b3a0; /*#a022b5a0;*/
--mtx-tabs-bk-2d: #41b5222b;
--mtx-tabs-bk-3d: #718dd750;
--mtx-tabs-bk-both: #e372722b;
}

/* The classes for displaying tables in light and dark modes */
.mtx-class-bk-head {
background-color: #ae92b3a0;
font-weight: bold;
}

.mtx-class-bk-2d {
background-color: #41b5222b;
}

.mtx-class-bk-3d {
background-color: #718dd750;
}

.mtx-class-bk-both {
background-color: #e372722b;
}

.mtx-class-macrotable {
width: 60%;
border: 1px solid #a7a7a7;
}

.mtx-class-macrotable > tr > th,.mtx-class-macrotable > tr > td,.mtx-class-macrotable > * > tr > th,.mtx-class-macrotable > * > tr > td {
border: 1px solid #a7a7a7;
}

.mtx-class-macrohead {
background-color: #c79fc7a1;
font-weight: bold;
border: 1px solid #a7a7a7;
}

.mtx-class-propfolder {
background-color: #f5daf5a1;
font-weight: bold;
}

/* Hide toolbar for anonymous/logged-out users */
#right-navigation {
display: none;
}

#left-navigation {
display: none;
}

MediaWiki:Group-user.css

2026-07-28T09:11:57Z

SteveT:

/* CSS placed here will affect registered users only */

/*
#vector-page-tools-dropdown {
display: block !important;
}
*/

/* Ensure the toolbar is visible for logged-in users */
#right-navigation {
display: block !important;
}

#left-navigation {
display: block !important;
}

MediaWiki:Common.css

2026-07-28T09:07:02Z

SteveT:

/* CSS placed here will be applied to all skins */
.noautonum .tocnumber { display: none; }

/* Edits by ST090726 to improve dark mode */
@media screen {
html.skin-theme-clientpref-night {
}

html.skin-theme-clientpref-night .mw-parser-output > span.mw-default-size:not(.skin-invert-image) img,html.skin-theme-clientpref-night section .mw-heading ~ div > span.mw-default-size:not(.skin-invert-image) img,html.skin-theme-clientpref-night section > span.mw-default-size:not(.skin-invert-image) img,html.skin-theme-clientpref-night dd > span.mw-default-size:not(.skin-invert-image) img,html.skin-theme-clientpref-night p > span.mw-default-size:not(.skin-invert-image) img,html.skin-theme-clientpref-night .mw-parser-output > figure[typeof^='mw:File']:not(.skin-invert-image) img,html.skin-theme-clientpref-night section .mw-heading ~ div > figure[typeof^='mw:File']:not(.skin-invert-image) img,html.skin-theme-clientpref-night section > figure[typeof^='mw:File']:not(.skin-invert-image) img,html.skin-theme-clientpref-night dd > figure[typeof^='mw:File']:not(.skin-invert-image) img,html.skin-theme-clientpref-night p > figure[typeof^='mw:File']:not(.skin-invert-image) img {
background-color: transparent;
color: var(--color-base-fixed,#202122);
filter: brightness(0.8)
}

.tabs-label {
cursor: pointer;
padding: 1px 6px;
background-color: transparent;
border: 1px solid #AAA;
}

.tabs-tabbox > .tabs-input:checked + .tabs-label, .tabs-input-0:checked + .tabs-input-1 + .tabs-label {
z-index: 2;
background-color: #ae92b3a0; /*#a022b5a8;*/
font-weight: bold;
}

}

/* These vars are not used. Use the classes below instead. */
:root {
--mtx-tabs-bk-head: #ae92b3a0; /*#a022b5a0;*/
--mtx-tabs-bk-2d: #41b5222b;
--mtx-tabs-bk-3d: #718dd750;
--mtx-tabs-bk-both: #e372722b;
}

/* The classes for displaying tables in light and dark modes */
.mtx-class-bk-head {
background-color: #ae92b3a0;
font-weight: bold;
}

.mtx-class-bk-2d {
background-color: #41b5222b;
}

.mtx-class-bk-3d {
background-color: #718dd750;
}

.mtx-class-bk-both {
background-color: #e372722b;
}

.mtx-class-macrotable {
width: 60%;
border: 1px solid #a7a7a7;
}

.mtx-class-macrotable > tr > th,.mtx-class-macrotable > tr > td,.mtx-class-macrotable > * > tr > th,.mtx-class-macrotable > * > tr > td {
border: 1px solid #a7a7a7;
}

.mtx-class-macrohead {
background-color: #c79fc7a1;
font-weight: bold;
border: 1px solid #a7a7a7;
}

.mtx-class-propfolder {
background-color: #f5daf5a1;
font-weight: bold;
}

/* Hide tools menu for anonymous/logged-out users */
#vector-page-tools-dropdown {
display: none;
}

MediaWiki:Group-user.css

2026-07-28T09:06:15Z

SteveT: Created page with "/* CSS placed here will affect registered users only */ #vector-page-tools-dropdown { display: block !important; }"

/* CSS placed here will affect registered users only */

#vector-page-tools-dropdown {

display: block !important;

}

MediaWiki:Common.css

2026-07-28T09:00:22Z

SteveT:

/* CSS placed here will be applied to all skins */
.noautonum .tocnumber { display: none; }

/* Edits by ST090726 to improve dark mode */
@media screen {
html.skin-theme-clientpref-night {
}

html.skin-theme-clientpref-night .mw-parser-output > span.mw-default-size:not(.skin-invert-image) img,html.skin-theme-clientpref-night section .mw-heading ~ div > span.mw-default-size:not(.skin-invert-image) img,html.skin-theme-clientpref-night section > span.mw-default-size:not(.skin-invert-image) img,html.skin-theme-clientpref-night dd > span.mw-default-size:not(.skin-invert-image) img,html.skin-theme-clientpref-night p > span.mw-default-size:not(.skin-invert-image) img,html.skin-theme-clientpref-night .mw-parser-output > figure[typeof^='mw:File']:not(.skin-invert-image) img,html.skin-theme-clientpref-night section .mw-heading ~ div > figure[typeof^='mw:File']:not(.skin-invert-image) img,html.skin-theme-clientpref-night section > figure[typeof^='mw:File']:not(.skin-invert-image) img,html.skin-theme-clientpref-night dd > figure[typeof^='mw:File']:not(.skin-invert-image) img,html.skin-theme-clientpref-night p > figure[typeof^='mw:File']:not(.skin-invert-image) img {
background-color: transparent;
color: var(--color-base-fixed,#202122);
filter: brightness(0.8)
}

.tabs-label {
cursor: pointer;
padding: 1px 6px;
background-color: transparent;
border: 1px solid #AAA;
}

.tabs-tabbox > .tabs-input:checked + .tabs-label, .tabs-input-0:checked + .tabs-input-1 + .tabs-label {
z-index: 2;
background-color: #ae92b3a0; /*#a022b5a8;*/
font-weight: bold;
}

}

/* These vars are not used. Use the classes below instead. */
:root {
--mtx-tabs-bk-head: #ae92b3a0; /*#a022b5a0;*/
--mtx-tabs-bk-2d: #41b5222b;
--mtx-tabs-bk-3d: #718dd750;
--mtx-tabs-bk-both: #e372722b;
}

/* The classes for displaying tables in light and dark modes */
.mtx-class-bk-head {
background-color: #ae92b3a0;
font-weight: bold;
}

.mtx-class-bk-2d {
background-color: #41b5222b;
}

.mtx-class-bk-3d {
background-color: #718dd750;
}

.mtx-class-bk-both {
background-color: #e372722b;
}

.mtx-class-macrotable {
width: 60%;
border: 1px solid #a7a7a7;
}

.mtx-class-macrotable > tr > th,.mtx-class-macrotable > tr > td,.mtx-class-macrotable > * > tr > th,.mtx-class-macrotable > * > tr > td {
border: 1px solid #a7a7a7;
}

.mtx-class-macrohead {
background-color: #c79fc7a1;
font-weight: bold;
border: 1px solid #a7a7a7;
}

.mtx-class-propfolder {
background-color: #f5daf5a1;
font-weight: bold;
}

/* Hide tools menu for anonymous/logged-out users */
body.skin-vector-2022 .vector-menu-portal#p-tb,
body.mediawiki-logged-out #p-tb {
display: none !important;
}

State Icon Properties

2026-07-23T16:31:21Z

SteveT: /* Editing the order of transitions */

[[File:iconState.png|border]]

A State icon is used within a [[State_diagrams|State Diagram macro]] to represent one of the states. Each State icon will have optional functionality that is executed when the State is entered.

==Details==
{| style="margin:0px; text-align:center;"
|-
|[[File:iconState.png|border]]
|width="50px" |→
|[[File:Properties_State.png]]
|}

A State Diagram consists of several state icons interconnected with transitions. Like a transition, a state icon has a display name (i.e. the text displayed on the state within the diagram) and an optional function.

'''Display Name'''

The name of the icon that appears in the State icon in the State Diagram.

This can be optionally displayed or hidden on the icon itself when the "Show" tick-box is unticked.

'''Function'''

The function is code that is executed when the program flow enters (or remains in) that state icon.

This can be to call a macro, perform a calculation, delay program execution or execute some custom C code.

States will perform their optional function when program flow enters that state through a transition from another state.

This can be optionally displayed or hidden on the icon itself when the "Show" tick-box is unticked.

'''Edit...'''

Click the "Edit..." button to change the details of the selected function. This button will be hidden if the function is set to "Do nothing" and will be labelled "Choose macro..." if the "Call Macro" function is chosen.

This will open another property window that is specific to the selected function. More details are here:

{| class="wikitable"
|+
|-
| [[Macro_Icon_Properties|Call macro]]
|-
| [[Calculation_Icon_Properties|Calculation]]
|-
| [[Delay_Icon_Properties|Delay]]
|-
| [[Code_Icon_Properties|Code]]
|}

'''Set transition order'''

States usually have one or more exit transitions: arrows that flow out of the state icon with optional conditions that must be true for program execution to ‘flow’ along that Transition.

These exit Transitions are evaluated in turn until one is found to be true. The evaluation order of these transitions can be set by clicking “Set transition order” or by reconnecting the start end of the transition to the state.

==Editing the order of transitions==
[[File:TransitionOrder.png]]

The order in which transitions are evaluated can be set in this window. Click the required transition to select it and set its position in the list using the up and down arrows.

The transitions can be listed here by their Display Name, their specified Condition, or the Function that they perform.

More details can be found [[Reorder_Transitions|here]].

==Special States==

A state without an exit transition will force program execution to remain in that state until the program is stopped by the user.

Each state diagram must contain a single “Entry State” icon which contains the code to be executed when the program enters that macro.

Only one transition can exit this entry state and neither this transition nor the entry state can be deleted from the state diagram.

State Diagrams can may have one or more [[Exit_State_Icon_Properties|Exit State icons]], which cause the State Diagram to return to its calling macro.

These may have a return value if this State Diagram macro specifies a return type.

==Example of a State Diagram==

[[File:State0.png|State Diagram Overview]]

FAQ

2026-07-23T16:27:26Z

SteveT: Removed redirect to Frequently Asked Questions

#REDIRECT [https://flowcode.co.uk/faq/ Frequently Asked Questions]

Event Reference

2026-07-23T16:21:07Z

SteveT:

Flowcode provides an ''event interface'' to help writing simulation and PC-side programs.

This event list allows Flowcode to communicate with the components through macros.

An event may be thought of as a ''simulation-side interrupt''. Each event associated with a Flowcode program will call a macro when that event occurs.

Events are grouped by ''class'' to provide context for their use. A reference to the classes and events are available here: [[Simulation_Functionality#Events|Simulation Library]].

Event Reference

2026-07-23T16:20:55Z

SteveT: Replaced content with "<sidebar>Event Contents</sidebar> Flowcode provides an ''event interface'' to help writing simulation and PC-side programs. This event list allows Flowcode to communicate with the components through macros. An event may be thought of as a ''simulation-side interrupt''. Each event associated with a Flowcode program will call a macro when that event occurs. Events are grouped by ''class'' to provide context for their use. A reference to the classes and events are av..."

<sidebar>Event Contents</sidebar>
Flowcode provides an ''event interface'' to help writing simulation and PC-side programs.

This event list allows Flowcode to communicate with the components through macros.

An event may be thought of as a ''simulation-side interrupt''. Each event associated with a Flowcode program will call a macro when that event occurs.

Events are grouped by ''class'' to provide context for their use. A reference to the classes and events are available here: [[Simulation_Functionality#Events|Simulation Library]].

Auto Documentation

2026-07-23T16:19:09Z

SteveT:

[[File:Gen_Project_Report_Export_Wizard_01.png|right]]
Auto-generated documentation consists of technical information taken directly from your project and consists of information such as its name and description, along with details of the [[Editing Variables|variables]], [[Creating_a_New_Macro|macros]], and [[Component|components]] used within the project.

You can 'Create a Project Report' of your own Flowcode file to auto-generate documentation of your project in different styles, from an overall report to flowchart images and even flowchart source code, the report covers the contents of your Flowcode file, from chip and compiler settings to macros and variables.

To do this you go to the '''File >> Export >> Make information about your project available in HTML format''' option within Flowcode.

This information is taken directly from Flowcode and exported into a HTML document, where all the information will be formatted and organised to include connections, tables, properties and images etc.

In regards to the auto-documentation for the wiki, there are then fields and areas left to complete such as detailed descriptions and an examples and further information regarding a function, component or property etc.

By default these fields contain red text saying "''<span style="color:red;">No additional information</span>''", or "''<span style="color:red;">No additional examples</span>''". These fields are then filled out on the wiki to provide further information about the specified area.

This documentation provides technical information regarding Flowcode, examples of this on the wiki are as follows:
*[[Variable Types]]
*[[Components]]
*[[Simulation Events]]
*[[Simulation Functionality]]

Simulation Macro Icon Properties

2026-07-23T16:13:54Z

SteveT: /* Details */

[[File:IconBuiltinFunction.png|border]]

Simulation-only macros for advanced Flowcode use such as component creation.

==Old Versions==
This page is current for Flowcode v9 and later. Earlier versions can be found below:
{| class="wikitable"
|+
|-
| [[Special:PermanentLink/11926|Flowcode v8]]
|}

==Details==
{| style="margin:0px; text-align:center;"
|-
|[[File:IconBuiltinFunction.png|border]]
| width="50px" |→
|[[File:Gen_Simulation_Macro_Flowchart_Icon_01.png]]
|width="50px" |→
|[[File:Properties_ApiMacro.png]]
|}

[[API_Overview|Built-in functions]] (sometimes called API or Simulation Macros) consist of a wide range of [[Simulation_Functionality|Simulation Functions]] that provide enhanced features for software simulation of your Flowcode project. This means that no code is produced when a project is built (with the exception of a few Web Developer functions).

These internal functions are used to produce advanced systems on software to accurately replicate and simulate existing systems and even demonstrate new concepts by creating simulation-only programs to test the capabilities of potential systems. They are used mainly in the creation of Flowcode components and are rarely suitable for general Flowcode projects.

'''Adding a call to a Built-in Function'''

The functions are listed under various categories. Expand each category to manually locate the required function, or right-click near the top of the list and select "Search" to enter a search term.

Select the macro and fill in the parameters required and select a return value if required.

'''Parameters'''

If the device macro requires any parameters then these can be entered in this field. Each can be a literal value or an existing variable. Clicking on the down arrow [[File:Btn_Arrow.png]] brings up the variables dialog window allowing you to select an existing variable or to [[Creating Variables|create a new one]].

The parameter details will list the parameter type. Parameters must be of a compatible type to be accepted.

Note that a full set of parameters must be provided.

'''Return value'''

If the device macro returns a value then you can assign that value to an existing variable for use later in the flowchart. If the function returns a value but you do not wish to retrieve it then leave this field empty.

The [[Variable Types|variable type]] of the return value will be listed. A variable of compatible type must be used to accept the return value.

==Macro types==
Macros are 3 types of macro that can be called using this command icon:

{| class="wikitable"
|+
|-
| [[Macro_Icon_Properties|Macros]]
| Macros designed and created by the user that are created as part of this project.
|-
| [[Component_Macro_Icon_Properties|Components]]
| Pre-defined macros supplied with the components. Only components that have been added to this project are available.
|-
| [[Simulation_Macro_Icon_Properties|Built-in Functions]]
| Simulation-only macros for advanced Flowcode use such as component creation.
|}

==Video==

Watch the [http://www.youtube.com/watch?v=LSz0p0NqMBw&list=PLQDWBb7bxuCgg6aJgPJcfXBMzZdLILceQ Download and Simulation code] video for a demonstration, example and explanation of downloadable and simulation only code and the difference between the two.

See the [http://www.youtube.com/watch?v=B_tOeSTeAbw&list=PLQDWBb7bxuCgg6aJgPJcfXBMzZdLILceQ Simulation Icon] video for information on the simulation functions available, the video highlights how they are organised and presented and how they can be used.

{| style="margin:auto;"
|-
|{{#ev:youtube|LSz0p0NqMBw}}
| width="100px" |
|{{#ev:youtube|B_tOeSTeAbw}}
|}

API Overview

2026-07-23T16:12:44Z

SteveT:

Flowcode provides an ''application programming interface'' to help writing simulation and PC-side programs.

This API (also known as ''Built-in Functions'') is a list of macros built in to Flowcode with each group, or class, of macros dealing with a specific area of the system.

Use of this API is limited to simulation only - when downloaded to the chip these calls will be omitted, so if need be they can be interleaved in downloadable code.

A reference to the classes and macros available can be found [[Simulation_Functionality#Built-in_functions|here]].

API Reference

2026-07-23T16:10:20Z

SteveT:

API Overview

2026-07-23T16:09:44Z

SteveT:

Simulation Functionality

2026-07-23T16:08:29Z

SteveT: /* Built in functions */

In Flowcode, simulation allows you to test and debug your embedded system designs without needing physical hardware. It provides a visual environment where you can run your program, interact with components, and observe their behavior in real-time. The simulation includes features like breakpoints, variable tracking, and real-time data display, helping you identify issues and optimize your design before uploading it to the actual hardware.

Flowcode's simulation feature offers a powerful environment for testing and debugging embedded system designs. Here’s more detail on its capabilities:

* Real-Time Simulation: You can run your design as if it were on actual hardware, with real-time updates on how components like LEDs, sensors, or motors behave in response to the programmed logic.
* Interactive Testing: Many components allow user interaction during the simulation. For example, you can press virtual buttons, adjust sensor values, or modify inputs to see how the system responds.
* Debugging Tools: The simulation includes essential debugging features like breakpoints, step-by-step execution, and variable tracking. This lets you pause and inspect your program at specific points to identify issues or optimize performance.
* Graphical Feedback: Data like sensor readings or communication signals can be visualized using built-in graphs and data monitors, making it easier to observe trends and behaviors over time.
* Component Visualization: Physical components, such as displays or motors, are visually represented, so you can see how they would react in a real-world scenario, enhancing understanding and design verification.
* Error Checking: Flowcode provides error messages and warnings during simulation, helping catch issues like incorrect component configurations or logical errors in the code.

Simulation in Flowcode helps streamline the development process by allowing thorough testing before deployment to hardware, reducing errors and saving time in the prototyping phase.

__TOC__

==Built-in functions==
Flowcode provides a set of built-in functions (also known as the API or ''application programming interface'') to help writing simulation and PC-side programs.

This API is a list of macros built in to Flowcode with each group, or class, of macros dealing with a specific area of the system.

Use of this API is limited to simulation only - when downloaded to the chip these calls will be omitted, so if need be they can be interleaved in downloadable code.

A reference to the classes and macros available can be found here:

<tabs>

<tab name="Component">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="3" align="center" class="mtx-class-bk-head" | Property
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.GetValue|GetValue]]
| class="mtx-class-bk-both" | Gets the value of a property as a string
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.SetColor|SetColor]]
| class="mtx-class-bk-both" | Sets a components 'color' property as a R,G,B value
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.SetValue|SetValue]]
| class="mtx-class-bk-both" | Sets a components property as a string
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.CopyValue|CopyValue]]
| class="mtx-class-bk-both" | Copies a property value from one target to another
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.SetChildValues|SetChildValues]]
| class="mtx-class-bk-both" | Sets all child components property as a string
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.CopyChildValues|CopyChildValues]]
| class="mtx-class-bk-both" | Copies the values of a properties children from the source to dest
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.SetVisible|SetVisible]]
| class="mtx-class-bk-both" | Sets whether the property is visible or not
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.SetWritable|SetWritable]]
| class="mtx-class-bk-both" | Sets whether the property can be edited in the UI or not
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.GetVisible|GetVisible]]
| class="mtx-class-bk-both" | Gets whether the property is visible or not
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.GetWritable|GetWritable]]
| class="mtx-class-bk-both" | Gets whether the property can be edited in the UI or not
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.GetFilter|GetFilter]]
| class="mtx-class-bk-both" | Gets a components property filter string for lists, files, etc
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.SetFilter|SetFilter]]
| class="mtx-class-bk-both" | Sets a components property filter string for lists, files, etc
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.CopyFilter|CopyFilter]]
| class="mtx-class-bk-both" | Copies a property filter from one target to another
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.GetListIndex|GetListIndex]]
| class="mtx-class-bk-both" | Gets a single lists index value from a property by line number
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.GetListItem|GetListItem]]
| class="mtx-class-bk-both" | Gets a single list entry from a property by named index
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.SetListItem|SetListItem]]
| class="mtx-class-bk-both" | Sets an existing list entries text for the property by named index
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.AddListItem|AddListItem]]
| class="mtx-class-bk-both" | Alters or appends a list entries text for the property by named index
|-
|}
{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.GetPanel|GetPanel]]
| class="mtx-class-bk-both" | Returns the id of the panel hosting the component
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.SetInteractive|SetInteractive]]
| class="mtx-class-bk-both" | Sets whether a component can interact with the mouse
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.GetInteractive|GetInteractive]]
| class="mtx-class-bk-both" | Gets whether a component can interact with the mouse
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.SetVisible|SetVisible]]
| class="mtx-class-bk-both" | Sets whether a component can be seen on the panel
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.GetVisible|GetVisible]]
| class="mtx-class-bk-both" | Gets whether a component can be seen on the panel
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.SetSolid|SetSolid]]
| class="mtx-class-bk-both" | Sets whether a component is checked in collision detections
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.GetSolid|GetSolid]]
| class="mtx-class-bk-both" | Gets whether a component is checked in collision detections
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.SetCompile|SetCompile]]
| class="mtx-class-bk-both" | Sets whether a component is considered for compilation or not
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.GetCompile|GetCompile]]
| class="mtx-class-bk-both" | Gets whether a component will be compiled or not
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.GetInstance|GetInstance]]
| class="mtx-class-bk-both" | Gets the type-instance of the component, >= 1 is valid
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.FindChild|FindChild]]
| class="mtx-class-bk-both" | Finds a named object that is part of the component
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.GetRoot|GetRoot]]
| class="mtx-class-bk-both" | Gets the root component handle
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.GetTopParent|GetTopParent]]
| class="mtx-class-bk-both" | Gets the top-level owner of the component
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.GetParent|GetParent]]
| class="mtx-class-bk-both" | Gets the owner of the component
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.GetNext|GetNext]]
| class="mtx-class-bk-both" | Gets the next (younger) sibling of the components handle
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.GetLast|GetLast]]
| class="mtx-class-bk-both" | Gets the previous (elder) sibling of the components handle
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.GetChildHead|GetChildHead]]
| class="mtx-class-bk-both" | Gets the first (eldest) child of the component
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.GetChildTail|GetChildTail]]
| class="mtx-class-bk-both" | Gets the last (youngest) child of the component
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.GetOriginal|GetOriginal]]
| class="mtx-class-bk-both" | Gets the original definition of the component, returns Current if no original copy
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Clone|Clone]]
| class="mtx-class-bk-both" | Clones an existing object to another position on the panel
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Delete|Delete]]
| class="mtx-class-bk-both" | Deletes an existing object, removing it from the panel
|-
|}

</tab>

<tab name="Panel">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.GetPanelName|GetPanelName]]
| class="mtx-class-bk-both" | Returns the name of the panel from the id
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.GetPanelBkColour|GetPanelBkColour]]
| class="mtx-class-bk-both" | Returns the main background colour of the panel
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Get2dPanelCount|Get2dPanelCount]]
| class="mtx-class-bk-both" | Gets the number of 2d panels
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Create2dPanel|Create2dPanel]]
| class="mtx-class-bk-both" | Creates a new 2d panel
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.AddNewComponent|AddNewComponent]]
| class="mtx-class-bk-both" | Adds a new component to a panel
|-
|}
{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="3" align="center" class="mtx-class-bk-head" | Position
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.GetWorldPosition|GetWorldPosition]]
| class="mtx-class-bk-both" | Returns the positions coordinates in (X,Y,Z) array
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.GetWorldSize|GetWorldSize]]
| class="mtx-class-bk-both" | Returns the component size in (X,Y,Z) array
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.SetWorldPosition|SetWorldPosition]]
| class="mtx-class-bk-both" | Moves the object to the given coordinates in World coordinates
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.SetWorldSize|SetWorldSize]]
| class="mtx-class-bk-both" | Sets the objects size to a value
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.Get|Get]]
| class="mtx-class-bk-both" | Gets a handle to an object representing the components current position
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.GetOrigin|GetOrigin]]
| class="mtx-class-bk-both" | Gets a handle to an empty position
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.Set|Set]]
| class="mtx-class-bk-both" | Sets an objects position based on a component or pre-defined position
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.SetCoords|SetCoords]]
| class="mtx-class-bk-both" | Sets an objects coordinates based on a position
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.SetScale|SetScale]]
| class="mtx-class-bk-both" | Sets an objects scale based on a position
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.SetRotation|SetRotation]]
| class="mtx-class-bk-both" | Sets an objects orientation based on a position
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.GetBox|GetBox]]
| class="mtx-class-bk-both" | Gets a handle to an object representing the components bounding box position
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.GetLineNodes|GetLineNodes]]
| class="mtx-class-bk-both" | Returns the position of a line's nodes as a comma-separated list
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.SetLineNodes|SetLineNodes]]
| class="mtx-class-bk-both" | Sets the nodes of a line
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.Morph|Morph]]
| class="mtx-class-bk-both" | Blends positions from two sources to a destination
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.Animate|Animate]]
| class="mtx-class-bk-both" | Blends positions from two sources to a destination over time
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.StopAnimate|StopAnimate]]
| class="mtx-class-bk-both" | Stops all animations started by this component
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.MoveAlong|MoveAlong]]
| class="mtx-class-bk-both" | Moves the object by the given offset relative to its parent along an axis
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.MoveBy|MoveBy]]
| class="mtx-class-bk-both" | Moves the object by the given offset relative to its parent
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.MoveTo|MoveTo]]
| class="mtx-class-bk-both" | Moves the object to the given coordinates relative to its parent
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.ScaleTo|ScaleTo]]
| class="mtx-class-bk-both" | Sets the objects scale to a value
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.ScaleUp|ScaleUp]]
| class="mtx-class-bk-both" | Multiplies the objects scale by a value
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.ScaleDown|ScaleDown]]
| class="mtx-class-bk-both" | Divides the objects scale by a value
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.RotateTo|RotateTo]]
| class="mtx-class-bk-both" | Rotates the object to the given rotation
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.RotateAlong|RotateAlong]]
| class="mtx-class-bk-both" | Rotates the object by the given rotation along an axis
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.RotateX|RotateX]]
| class="mtx-class-bk-both" | Rotates the object around the X axis
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.RotateY|RotateY]]
| class="mtx-class-bk-both" | Rotates the object around the Y axis
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.RotateZ|RotateZ]]
| class="mtx-class-bk-both" | Rotates the object around the Z axis
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.GetCoords|GetCoords]]
| class="mtx-class-bk-both" | Returns the positions coordinates in (X,Y,Z) array
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.GetScale|GetScale]]
| class="mtx-class-bk-both" | Returns the positions scale in (X,Y,Z) array
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.GetQuat|GetQuat]]
| class="mtx-class-bk-both" | Returns the positions quaternion in (X,Y,Z,W) array
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.GetEuler|GetEuler]]
| class="mtx-class-bk-both" | Returns the positions euler angles in (P,Y,R) array
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.Math|Math]]
| class="mtx-class-bk-both" | Coordinate maths functions
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.Panel2D|Panel2D]]
| class="mtx-class-bk-both" | 2D Panel functions
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.Camera|Camera]]
| class="mtx-class-bk-both" | Camera positioning for 3D panel
|-
|}
{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="3" align="center" class="mtx-class-bk-head" | PCloud
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.Create|Create]]
| class="mtx-class-bk-both" | Creates a new point cloud tied to a position handle
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.SetVisible|SetVisible]]
| class="mtx-class-bk-both" | Sets whether the point cloud is displayed or not
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.SetPos|SetPos]]
| class="mtx-class-bk-both" | Sets the position for the point cloud to be located at
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.GetPos|GetPos]]
| class="mtx-class-bk-both" | Gets the position the point cloud is located at
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.SetPoints|SetPoints]]
| class="mtx-class-bk-both" | Sets the X,Y,Z point lists
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.SetPointsEx|SetPointsEx]]
| class="mtx-class-bk-both" | Sets the X,Y,Z point lists
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.SetGrid|SetGrid]]
| class="mtx-class-bk-both" | Sets the X,Y,Z point lists in a height-map grid
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.SetGridEx|SetGridEx]]
| class="mtx-class-bk-both" | Sets the X,Y,Z point lists in a height-map grid
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.SetGridFlat|SetGridFlat]]
| class="mtx-class-bk-both" | Sets the X,Y,Z point lists in a flat height-map grid
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.SetGridPoint|SetGridPoint]]
| class="mtx-class-bk-both" | Given an XY on the grid, sets the vertex value at that point
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.UnitScale|UnitScale]]
| class="mtx-class-bk-both" | Creates a unit scaled axis (X, Y or Z) with a center of zero and a range of two
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.SetColor|SetColor]]
| class="mtx-class-bk-both" | Sets the RGB colour of the entire cloud
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.SetColors|SetColors]]
| class="mtx-class-bk-both" | Sets the RGB colour of the individual points in the cloud
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.SetGridColor|SetGridColor]]
| class="mtx-class-bk-both" | Given an XY on the grid, sets the vertex colour at that point
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.SetMode|SetMode]]
| class="mtx-class-bk-both" | Sets the rendering mode of the point cloud
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.SetPointLight|SetPointLight]]
| class="mtx-class-bk-both" | Enables or disables simple lighting for point mode, providing a normal passing through the point and (0,0,0)
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.Update|Update]]
| class="mtx-class-bk-both" | Manually refresh the screen the point cloud exists on
|-
|}
{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="3" align="center" class="mtx-class-bk-head" | LinkBar
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.LinkBar.Create|Create]]
| class="mtx-class-bk-both" | Creates a new bar linking a pair of position handles
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.LinkBar.SetVisible|SetVisible]]
| class="mtx-class-bk-both" | Sets whether the link is displayed or not
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.LinkBar.SetStartPos|SetStartPos]]
| class="mtx-class-bk-both" | Sets the position for the start point of the bar
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.LinkBar.SetEndPos|SetEndPos]]
| class="mtx-class-bk-both" | Sets the position for the end point of the bar
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.LinkBar.SetStartAdjustment|SetStartAdjustment]]
| class="mtx-class-bk-both" | Sets the clipping adjustments for the beginning of the link
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.LinkBar.SetEndAdjustment|SetEndAdjustment]]
| class="mtx-class-bk-both" | Sets the clipping adjustments for the end of the link
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.LinkBar.SetStartGfx|SetStartGfx]]
| class="mtx-class-bk-both" | Sets the graphic for the start point of the bar
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.LinkBar.SetBarGfx|SetBarGfx]]
| class="mtx-class-bk-both" | Sets the graphic for the main line of the bar
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.LinkBar.SetEndGfx|SetEndGfx]]
| class="mtx-class-bk-both" | Sets the graphic for the end point of the bar
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.LinkBar.GetStartPos|GetStartPos]]
| class="mtx-class-bk-both" | Gets the position the bars start point is located at
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.LinkBar.GetBarPos|GetBarPos]]
| class="mtx-class-bk-both" | Gets the position the bar is located at
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.LinkBar.GetEndPos|GetEndPos]]
| class="mtx-class-bk-both" | Gets the position the bars end point is located at
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.LinkBar.Update|Update]]
| class="mtx-class-bk-both" | Manually refresh the screen the bar exists on
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.LinkBar.EnableAuto|EnableAuto]]
| class="mtx-class-bk-both" | Sets whether Flowcode should automatically draw links for component object property types
|-
|}
{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="3" align="center" class="mtx-class-bk-head" | TextLabel
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.TextLabel.Create|Create]]
| class="mtx-class-bk-both" | Creates a new text label that always faces the camera
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.TextLabel.SetVisible|SetVisible]]
| class="mtx-class-bk-both" | Sets whether the label is displayed or not
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.TextLabel.SetPos|SetPos]]
| class="mtx-class-bk-both" | Sets the position for the point to draw the text at
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.TextLabel.SetOffset|SetOffset]]
| class="mtx-class-bk-both" | Sets the offset from the SetPos() position for the label
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.TextLabel.SetText|SetText]]
| class="mtx-class-bk-both" | Sets the text for the label
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.TextLabel.SetScale|SetScale]]
| class="mtx-class-bk-both" | Sets the multipliers for the width and height of the label
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.TextLabel.SetColors|SetColors]]
| class="mtx-class-bk-both" | Sets the foreground and background colours for the label
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.TextLabel.SetViewMode|SetViewMode]]
| class="mtx-class-bk-both" | Sets whether to draw at a fixed size or to scale based on distance from the camera
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.TextLabel.GetPos|GetPos]]
| class="mtx-class-bk-both" | Gets the position the label is located at
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.TextLabel.Update|Update]]
| class="mtx-class-bk-both" | Manually refresh the screen the label exists on
|-
|}
{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="3" align="center" class="mtx-class-bk-head" | Collision
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Collision.TestTable|TestTable]]
| class="mtx-class-bk-both" | Tests whether an object collides with the table top, returns Z distance to move to rest on the table
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Collision.TestSingle|TestSingle]]
| class="mtx-class-bk-both" | Tests whether an object collides with a position
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Collision.GetSingleAxis|GetSingleAxis]]
| class="mtx-class-bk-both" | Tests whether an object collides with a position
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Collision.GetSinglePos|GetSinglePos]]
| class="mtx-class-bk-both" | Returns the position to move Pos to so it does not collide with Test - null if no collide
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Collision.GetMultiAxis|GetMultiAxis]]
| class="mtx-class-bk-both" | Tests whether an object collides with a position
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Collision.GetMultiPos|GetMultiPos]]
| class="mtx-class-bk-both" | Returns the position to move Pos to so it does not collide with any other object - null if no collide
|-
|}
{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="3" align="center" class="mtx-class-bk-head" | Graphics
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.Redraw|Redraw]]
| class="mtx-class-bk-both" | Sends a redraw request to the given component
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.SetColor|SetColor]]
| class="mtx-class-bk-both" | Sets the draw colour for and subsequent graphics objects
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.SetColorRGB|SetColorRGB]]
| class="mtx-class-bk-both" | Sets the draw colour for and subsequent graphics objects
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.SetTextFont|SetTextFont]]
| class="mtx-class-bk-both" | Sets the text font for subsequent text objects
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.SetTextScale|SetTextScale]]
| class="mtx-class-bk-both" | Sets the text scale for subsequent text objects
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.SetLineThickness|SetLineThickness]]
| class="mtx-class-bk-both" | Sets the thinkness when drawing lines and points
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.DrawCreate|DrawCreate]]
| class="mtx-class-bk-both" | Creates a drawing area on a shape
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.DrawBegin|DrawBegin]]
| class="mtx-class-bk-both" | Begins drawing on a given shape
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.DrawEnd|DrawEnd]]
| class="mtx-class-bk-both" | Ends drawing started with DrawBegin()
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.DrawDelete|DrawDelete]]
| class="mtx-class-bk-both" | Deletes a drawing area for a shape
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.DrawText|DrawText]]
| class="mtx-class-bk-both" | Draws a line of text texture
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.DrawPoint|DrawPoint]]
| class="mtx-class-bk-both" | Draws a point on a texture
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.DrawLine|DrawLine]]
| class="mtx-class-bk-both" | Draws a line on a texture
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.DrawLineA|DrawLineA]]
| class="mtx-class-bk-both" | Draws a smooth line on a texture
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.DrawRect|DrawRect]]
| class="mtx-class-bk-both" | Draws a rectangle on a texture
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.DrawCircle|DrawCircle]]
| class="mtx-class-bk-both" | Draws a circle on a texture
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.Clear|Clear]]
| class="mtx-class-bk-both" | Clear texture to the given component
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.Shape|Shape]]
| class="mtx-class-bk-both" | Routines to change the last drawn shape
|-
|}
</tab>

<tab name="Mouse">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API Mouse.GetButtons|GetButtons]]
| class="mtx-class-bk-both" | Gets the button state from the mouse: 4 for left, 1 for right
|-
| colspan="2" class="mtx-class-bk-both" | [[API Mouse.GetFocus|GetFocus]]
| class="mtx-class-bk-both" | Gets the handle of the component under the mouse
|-
| colspan="2" class="mtx-class-bk-both" | [[API Mouse.GetPosition|GetPosition]]
| class="mtx-class-bk-both" | Gets the position of the mouse, intersecting with a component or the viewing plane
|-
| colspan="2" class="mtx-class-bk-both" | [[API Mouse.GetPosition2D|GetPosition2D]]
| class="mtx-class-bk-both" | Gets the X/Y position of the mouse in screen coords
|-
| colspan="2" class="mtx-class-bk-both" | [[API Mouse.GetClickSide|GetClickSide]]
| class="mtx-class-bk-both" | Gets the side of the component clicked on, 0 to 5
|-
| colspan="2" class="mtx-class-bk-both" | [[API Mouse.SimClick|SimClick]]
| class="mtx-class-bk-both" | Simulates a click on an object
|-
| colspan="2" class="mtx-class-bk-both" | [[API Mouse.SimDrag|SimDrag]]
| class="mtx-class-bk-both" | Simulates a click-drag on an object
|-
| colspan="2" class="mtx-class-bk-both" | [[API Mouse.SimRelease|SimRelease]]
| class="mtx-class-bk-both" | Simulates a click-release on an object
|-
|}

</tab>

<tab name="Keyboard">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API Keyboard.KeyDown|KeyDown]]
| class="mtx-class-bk-both" | Simulates a key-press on an object
|-
| colspan="2" class="mtx-class-bk-both" | [[API Keyboard.KeyUp|KeyUp]]
| class="mtx-class-bk-both" | Simulates a key-release on an object
|-
|}

</tab>

<tab name="FCD">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API FCD.GetItemValue|GetItemValue]]
| class="mtx-class-bk-both" | Gets a paths item value from the FCD document
|-
| colspan="2" class="mtx-class-bk-both" | [[API FCD.GetItemHandle|GetItemHandle]]
| class="mtx-class-bk-both" | Gets a FCD items handle, suitable for traversal with the Tree API
|-
| colspan="2" class="mtx-class-bk-both" | [[API FCD.GetPathHandle|GetPathHandle]]
| class="mtx-class-bk-both" | Gets a FCD paths handle, suitable for traversal with the Tree API
|-
| colspan="2" class="mtx-class-bk-both" | [[API FCD.SetItemValue|SetItemValue]]
| class="mtx-class-bk-both" | Override item value from the FCD document from path
|-
| colspan="2" class="mtx-class-bk-both" | [[API FCD.ResetItemValue|ResetItemValue]]
| class="mtx-class-bk-both" | Reset paths item value from the FCD document
|-
|}

</tab>

<tab name="Sound">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API Sound.Play|Play]]
| class="mtx-class-bk-both" | Plays a formatted file sound, returns true if the sound played OK
|-
| colspan="2" class="mtx-class-bk-both" | [[API Sound.LoadWav|LoadWav]]
| class="mtx-class-bk-both" | Loads a wave file into memory, providing the values needed to play it
|-
| colspan="2" class="mtx-class-bk-both" | [[API Sound.Create|Create]]
| class="mtx-class-bk-both" | Creates a sound object that data can be played through
|-
| colspan="2" class="mtx-class-bk-both" | [[API Sound.SetVolume|SetVolume]]
| class="mtx-class-bk-both" | Sets the volume of playbacks for this sound
|-
| colspan="2" class="mtx-class-bk-both" | [[API Sound.GetVolume|GetVolume]]
| class="mtx-class-bk-both" | Gets the volume of playbacks for this sound in the range 0 to 1
|-
| colspan="2" class="mtx-class-bk-both" | [[API Sound.GetBits|GetBits]]
| class="mtx-class-bk-both" | Gets the number of bits per sample for the sound
|-
| colspan="2" class="mtx-class-bk-both" | [[API Sound.GetRate|GetRate]]
| class="mtx-class-bk-both" | Gets the current sample rate for the sound
|-
| colspan="2" class="mtx-class-bk-both" | [[API Sound.SetRate|SetRate]]
| class="mtx-class-bk-both" | Sets the current sample rate for the sound - this will stop the playing sound
|-
| colspan="2" class="mtx-class-bk-both" | [[API Sound.Queue|Queue]]
| class="mtx-class-bk-both" | Queues a sound for playing
|-
| colspan="2" class="mtx-class-bk-both" | [[API Sound.QueueEx|QueueEx]]
| class="mtx-class-bk-both" | Queues a sound for playing, with the format provided
|-
| colspan="2" class="mtx-class-bk-both" | [[API Sound.Flush|Flush]]
| class="mtx-class-bk-both" | Stops all playing and queued sounds
|-
| colspan="2" class="mtx-class-bk-both" | [[API Sound.GetPending|GetPending]]
| class="mtx-class-bk-both" | Gets the number of sample blocks queued or playing for the sound
|-
|}

</tab>

<tab name="DataRecorder">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.AddGroup|AddGroup]]
| class="mtx-class-bk-both" | Adds a group to the scope to which streams may be added
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.ShowGroup|ShowGroup]]
| class="mtx-class-bk-both" | Sets the visibility of the given group
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.AddStream|AddStream]]
| class="mtx-class-bk-both" | Adds a stream to the given group suitable for inputs and operations
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.AddBuffer|AddBuffer]]
| class="mtx-class-bk-both" | Adds a fixed-view stream to the given group suitable for inputs and operations
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.Rename|Rename]]
| class="mtx-class-bk-both" | Renames the given scope group, stream or buffer
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.SetYAxisLabels|SetYAxisLabels]]
| class="mtx-class-bk-both" | Sets the labels for the Y-axis of the given stream
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.SetLineColor|SetLineColor]]
| class="mtx-class-bk-both" | Sets the group, stream or buffers line colour
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.GetLineColor|GetLineColor]]
| class="mtx-class-bk-both" | Gets the streams line colour
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.SetBackColor|SetBackColor]]
| class="mtx-class-bk-both" | Sets the groups background colour
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.GetBackColor|GetBackColor]]
| class="mtx-class-bk-both" | Gets the stream groups background colour
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.SetDecodable|SetDecodable]]
| class="mtx-class-bk-both" | Sets whether a stream can be decoded via the components event - defaults to 'true'
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.GetDecodable|GetDecodable]]
| class="mtx-class-bk-both" | Gets whether a stream can be decoded via the components event - defaults to 'true'
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.AddPort|AddPort]]
| class="mtx-class-bk-both" | Adds an input to the stream from a port
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.AddAnalog|AddAnalog]]
| class="mtx-class-bk-both" | Adds an input to the stream from an analog channel
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.AddCustom|AddCustom]]
| class="mtx-class-bk-both" | Adds an input to the stream from a custom injection
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.AddOp|AddOp]]
| class="mtx-class-bk-both" | Adds an operation to act on the inputs of the stream
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.ClearOps|ClearOps]]
| class="mtx-class-bk-both" | Clears all inputs and operations from the given stream
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.SetBuffer|SetBuffer]]
| class="mtx-class-bk-both" | Sets the contents of a snapshot stream
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.SetCustom|SetCustom]]
| class="mtx-class-bk-both" | Sets one of 32 custom analog values for the group
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.GetSnapshot|GetSnapshot]]
| class="mtx-class-bk-both" | Gets a block of the output stream with each input sample operated on, returns number of samples read
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.FindOutput|FindOutput]]
| class="mtx-class-bk-both" | Searches back through the output history for a value, returns offset of found sample from TimeUS, 0 if not found
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.FindPeriod|FindPeriod]]
| class="mtx-class-bk-both" | Attempts to calculate the wave period given a series of transitions for the stream, returns calculated period
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.SetPacketFmt|SetPacketFmt]]
| class="mtx-class-bk-both" | Sets the graphical format of the packets added with AddPacket and Add...Packets
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.GetPacketFmt|GetPacketFmt]]
| class="mtx-class-bk-both" | Returns the graphical format of the packets added with AddPacket and Add...Packets
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.AddPacket|AddPacket]]
| class="mtx-class-bk-both" | Adds an overlay packet to the stream at a given offset from the current time
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.AddStepPackets|AddStepPackets]]
| class="mtx-class-bk-both" | Adds overlay packets to the stream by decoding the stream contents with a fixed period rate
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.AddSyncPackets|AddSyncPackets]]
| class="mtx-class-bk-both" | Adds overlay packets to the stream by decoding the stream contents with a variable period rate
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.ClearPackets|ClearPackets]]
| class="mtx-class-bk-both" | Clears existing overlay packets from the stream
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.ClearAllPackets|ClearAllPackets]]
| class="mtx-class-bk-both" | Clears all existing overlay packets from the stream
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.TicksToSecs|TicksToSecs]]
| class="mtx-class-bk-both" | Converts a duration in ticks into a time in seconds
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.SecsToTicks|SecsToTicks]]
| class="mtx-class-bk-both" | Converts a time in seconds into a duration in ticks
|-
|}

</tab>

<tab name="Calculations">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API Calculations.FloatToStorageULong|FloatToStorageULong]]
| class="mtx-class-bk-both" | Converts a float to an array containing 4 bytes
|-
| colspan="2" class="mtx-class-bk-both" | [[API Calculations.StorageULongToFloat|StorageULongToFloat]]
| class="mtx-class-bk-both" | Returns a float value from an unsigned long representation (used to store or transfer it)
|-
| colspan="2" class="mtx-class-bk-both" | [[API Calculations.GetFrequencyArray|GetFrequencyArray]]
| class="mtx-class-bk-both" | Calculates the frequency from an array of data.
|-
| colspan="2" class="mtx-class-bk-both" | [[API Calculations.GetAmplitudeArray|GetAmplitudeArray]]
| class="mtx-class-bk-both" | Calculates the amplitude from an array of data.
|-
|}

</tab>

<tab name="Console">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API Console.AddText|AddText]]
| class="mtx-class-bk-both" | Adds a window to the list of consoles available
|-
| colspan="2" class="mtx-class-bk-both" | [[API Console.AddMemory|AddMemory]]
| class="mtx-class-bk-both" | Adds a window to the list of consoles available
|-
| colspan="2" class="mtx-class-bk-both" | [[API Console.GetDefault|GetDefault]]
| class="mtx-class-bk-both" | Gets the default (read-only) console window
|-
| colspan="2" class="mtx-class-bk-both" | [[API Console.GetConsole|GetConsole]]
| class="mtx-class-bk-both" | Gets a console window
|-
| colspan="2" class="mtx-class-bk-both" | [[API Console.GetName|GetName]]
| class="mtx-class-bk-both" | Returns the name of a console
|-
| colspan="2" class="mtx-class-bk-both" | [[API Console.Rename|Rename]]
| class="mtx-class-bk-both" | Renames the given console
|-
| colspan="2" class="mtx-class-bk-both" | [[API Console.SetMemMode|SetMemMode]]
| class="mtx-class-bk-both" | Sets whether to show address and bytes for the console
|-
| colspan="2" class="mtx-class-bk-both" | [[API Console.SetInputRGB|SetInputRGB]]
| class="mtx-class-bk-both" | Sets the colour of text inserted by the user from now on
|-
| colspan="2" class="mtx-class-bk-both" | [[API Console.SetOutputRGB|SetOutputRGB]]
| class="mtx-class-bk-both" | Sets the colour of text inserted by the component from now on
|-
| colspan="2" class="mtx-class-bk-both" | [[API Console.WriteText|WriteText]]
| class="mtx-class-bk-both" | Adds a block of text to the console window
|-
| colspan="2" class="mtx-class-bk-both" | [[API Console.GetLineText|GetLineText]]
| class="mtx-class-bk-both" | Reads a line of text from the given console, pass -1 for final line
|-
| colspan="2" class="mtx-class-bk-both" | [[API Console.SetLineText|SetLineText]]
| class="mtx-class-bk-both" | Writes a line of text from the given console, pass -1 for final line
|-
| colspan="2" class="mtx-class-bk-both" | [[API Console.GetLineBytes|GetLineBytes]]
| class="mtx-class-bk-both" | Reads a line of bytes from the given console extending the array if needed
|-
| colspan="2" class="mtx-class-bk-both" | [[API Console.SetLineBytes|SetLineBytes]]
| class="mtx-class-bk-both" | Writes a line of bytes from the given console, pass -1 for final line
|-
| colspan="2" class="mtx-class-bk-both" | [[API Console.CountLines|CountLines]]
| class="mtx-class-bk-both" | Counts the number of lines in the console
|-
| colspan="2" class="mtx-class-bk-both" | [[API Console.ClearText|ClearText]]
| class="mtx-class-bk-both" | Clears all the text in the console
|-
|}

</tab>

<tab name="Connection">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API Connection.GetPort|GetPort]]
| class="mtx-class-bk-both" | Gets a ports value from its index
|-
| colspan="2" class="mtx-class-bk-both" | [[API Connection.SetPort|SetPort]]
| class="mtx-class-bk-both" | Sets a ports value from its index
|-
| colspan="2" class="mtx-class-bk-both" | [[API Connection.GetAn|GetAn]]
| class="mtx-class-bk-both" | Gets an analog value from its channel index
|-
| colspan="2" class="mtx-class-bk-both" | [[API Connection.SetAn|SetAn]]
| class="mtx-class-bk-both" | Sets an analog value from its index, range 0->1
|-
| colspan="2" class="mtx-class-bk-both" | [[API Connection.DecodePort|DecodePort]]
| class="mtx-class-bk-both" | Gets a ports details from its name or index
|-
|}

</tab>

<tab name="Expand">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API Expand.PathName|PathName]]
| class="mtx-class-bk-both" | Expands a string using the built-in pathname expansion variables
|-
| colspan="2" class="mtx-class-bk-both" | [[API Expand.MacroName|MacroName]]
| class="mtx-class-bk-both" | Expands a string to the name of a macro used in the generated code
|-
| colspan="2" class="mtx-class-bk-both" | [[API Expand.VarName|VarName]]
| class="mtx-class-bk-both" | Expands a string to the name of a global variable used in the generated code
|-
| colspan="2" class="mtx-class-bk-both" | [[API Expand.Property|Property]]
| class="mtx-class-bk-both" | Expands a string to the name of a property used in the generated code
|-
| colspan="2" class="mtx-class-bk-both" | [[API Expand.MacroHead|MacroHead]]
| class="mtx-class-bk-both" | Expands a macro name to the code generated for the header of that macro
|-
| colspan="2" class="mtx-class-bk-both" | [[API Expand.MacroBody|MacroBody]]
| class="mtx-class-bk-both" | Expands a macro name to the code generated for the body of that macro
|-
| colspan="2" class="mtx-class-bk-both" | [[API Expand.MacroTail|MacroTail]]
| class="mtx-class-bk-both" | Expands a macro name to the code generated for the tail of that macro
|-
|}

</tab>

<tab name="Tree">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.GetValue|GetValue]]
| class="mtx-class-bk-both" | Gets the value of the given object, if available
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.GetName|GetName]]
| class="mtx-class-bk-both" | Gets the name of the given object
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.GetPath|GetPath]]
| class="mtx-class-bk-both" | Gets the full '.' separated name of the given object
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.GetSubValue|GetSubValue]]
| class="mtx-class-bk-both" | Gets the value of a named sub-item of the given object, if available
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.Traverse|Traverse]]
| class="mtx-class-bk-both" | Updates the object to step depth-first through the tree
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.StepNext|StepNext]]
| class="mtx-class-bk-both" | Updates the object to point to the next (younger) sibling
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.StepNamedNext|StepNamedNext]]
| class="mtx-class-bk-both" | Updates the object to point to the next (younger) sibling matching the name
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.StepNamedIndex|StepNamedIndex]]
| class="mtx-class-bk-both" | Updates the object to point to the Nth next (younger) sibling matching the name
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.StepLast|StepLast]]
| class="mtx-class-bk-both" | Updates the object to point to the last (elder) sibling
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.StepParent|StepParent]]
| class="mtx-class-bk-both" | Updates the object to point to its parent object
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.StepRoot|StepRoot]]
| class="mtx-class-bk-both" | Updates the object to point to the root of the tree
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.StepChildHead|StepChildHead]]
| class="mtx-class-bk-both" | Updates the object to point to the head (eldest) child
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.StepChildTail|StepChildTail]]
| class="mtx-class-bk-both" | Updates the object to point to the tail (youngest) child
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.StepChildPath|StepChildPath]]
| class="mtx-class-bk-both" | Updates the object to point to the '.' separated named child path
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.CountChildren|CountChildren]]
| class="mtx-class-bk-both" | Returns the number of immediate children present for the object
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.CheckChildren|CheckChildren]]
| class="mtx-class-bk-both" | Returns true if the object has children, else false
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.CountNamedChildren|CountNamedChildren]]
| class="mtx-class-bk-both" | Returns the number of immediate children present for the object
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.CheckParent|CheckParent]]
| class="mtx-class-bk-both" | Returns true if the object has a parent, else false if it is the root
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.StepSubHead|StepSubHead]]
| class="mtx-class-bk-both" | Updates the object to point to the head (eldest) attribute, if any
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.StepSubTail|StepSubTail]]
| class="mtx-class-bk-both" | Updates the object to point to the tail (youngest) attribute, if any
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.StepSubName|StepSubName]]
| class="mtx-class-bk-both" | Updates the object to point to the named attribute, if any
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.GetCopy|GetCopy]]
| class="mtx-class-bk-both" | Creates a copy of the handle and returns the copy
|-
|}

</tab>

<tab name="File">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.AbsPath|AbsPath]]
| class="mtx-class-bk-both" | Gets an absolute path from a relative filename
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.RelPath|RelPath]]
| class="mtx-class-bk-both" | Gets an relative path from an absolute filename
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.CreateDir|CreateDir]]
| class="mtx-class-bk-both" | Creates a directory structure
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.GetType|GetType]]
| class="mtx-class-bk-both" | Finds the type of a file: 0=Unknown, 1=File, 2=Dir, 4=Disk
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.GetSize|GetSize]]
| class="mtx-class-bk-both" | Gets the number of bytes in the file, by handle or name
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.Delete|Delete]]
| class="mtx-class-bk-both" | Deletes the file or directory structure
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.Create|Create]]
| class="mtx-class-bk-both" | Creates the new file as a standard stream
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.Open|Open]]
| class="mtx-class-bk-both" | Opens the existing file as a standard stream
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.ReadArray|ReadArray]]
| class="mtx-class-bk-both" | Reads an array from the file, returns elements read
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.WriteArray|WriteArray]]
| class="mtx-class-bk-both" | Writes an array to the file
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.SetPos|SetPos]]
| class="mtx-class-bk-both" | Sets the position of the next read or write in the file
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.GetPos|GetPos]]
| class="mtx-class-bk-both" | Gets the position of the next read or write in the file
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.Flush|Flush]]
| class="mtx-class-bk-both" | Writes all unwritten data to the file in one block
|-
|}
{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="3" align="center" class="mtx-class-bk-head" | Buffer
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.Buffer.Open|Open]]
| class="mtx-class-bk-both" | Opens the existing file as a circular buffer
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.Buffer.Create|Create]]
| class="mtx-class-bk-both" | Creates the new file as a circular buffer
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.Buffer.ReadByte|ReadByte]]
| class="mtx-class-bk-both" | Reads a single byte from the input stream, -1 if empty
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.Buffer.WriteByte|WriteByte]]
| class="mtx-class-bk-both" | Writes a single byte to the input stream
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.Buffer.ReadArray|ReadArray]]
| class="mtx-class-bk-both" | Reads an array from the input stream, returns elements read
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.Buffer.WriteArray|WriteArray]]
| class="mtx-class-bk-both" | Writes an array to the input stream
|-
|}
{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="3" align="center" class="mtx-class-bk-head" | NVM
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.NVM.Open|Open]]
| class="mtx-class-bk-both" | Opens the existing file as a block of non-volatile memory
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.NVM.Create|Create]]
| class="mtx-class-bk-both" | Creates the new file as a block of non-volatile memory
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.NVM.ReadByte|ReadByte]]
| class="mtx-class-bk-both" | Reads a single byte from the NVM, -1 if empty
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.NVM.WriteByte|WriteByte]]
| class="mtx-class-bk-both" | Writes a single byte to the NVM multiple times
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.NVM.ReadArray|ReadArray]]
| class="mtx-class-bk-both" | Reads an array from the NVM, returns elements read
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.NVM.WriteArray|WriteArray]]
| class="mtx-class-bk-both" | Writes an array to the NVM
|-
|}
</tab>

<tab name="UI">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API UI.SimpleMsgBox|SimpleMsgBox]]
| class="mtx-class-bk-both" | Displays a simple 'Ok' message box
|-
| colspan="2" class="mtx-class-bk-both" | [[API UI.Win32MsgBox|Win32MsgBox]]
| class="mtx-class-bk-both" | Invokes the Win32 API MessageBox function
|-
| colspan="2" class="mtx-class-bk-both" | [[API UI.YesNoMsgBox|YesNoMsgBox]]
| class="mtx-class-bk-both" | Displays a simple 'Yes/No' message box
|-
| colspan="2" class="mtx-class-bk-both" | [[API UI.YesNoCancelMsgBox|YesNoCancelMsgBox]]
| class="mtx-class-bk-both" | Displays a simple 'Yes/No/Cancel' message box (0 == Cancel, 1 == No, 2 == Yes)
|-
| colspan="2" class="mtx-class-bk-both" | [[API UI.InputMsgBox|InputMsgBox]]
| class="mtx-class-bk-both" | Displays a message box that allows the user to input text. Returns true if 'Ok' clicked, false otherwise
|-
|}

</tab>

<tab name="Time">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API Time.GetMillisecs|GetMillisecs]]
| class="mtx-class-bk-both" | Returns the value of a monotonic non-decrementing millisecond counter
|-
| colspan="2" class="mtx-class-bk-both" | [[API Time.GetUTC|GetUTC]]
| class="mtx-class-bk-both" | Returns the current UTC Modified Julian Date value
|-
| colspan="2" class="mtx-class-bk-both" | [[API Time.GetLocal|GetLocal]]
| class="mtx-class-bk-both" | Returns the current local time as a Modified Julian Date value
|-
| colspan="2" class="mtx-class-bk-both" | [[API Time.AddMJD|AddMJD]]
| class="mtx-class-bk-both" | Increments or decrements a Modified Julian Date and millisecond value
|-
| colspan="2" class="mtx-class-bk-both" | [[API Time.MJDToDate|MJDToDate]]
| class="mtx-class-bk-both" | Converts a Modified Julian Date into a Gregorian calendar date
|-
| colspan="2" class="mtx-class-bk-both" | [[API Time.DateToMJD|DateToMJD]]
| class="mtx-class-bk-both" | Converts a Gregorian calendar date into a Modified Julian Date
|-
| colspan="2" class="mtx-class-bk-both" | [[API Time.MJDToSeconds|MJDToSeconds]]
| class="mtx-class-bk-both" | Converts a Modified Julian Date into a number of seconds since a specified epoch
|-
| colspan="2" class="mtx-class-bk-both" | [[API Time.SecondsToMJD|SecondsToMJD]]
| class="mtx-class-bk-both" | Returns the Modified Julian Date given by the number of seconds since a specified epoch
|-
| colspan="2" class="mtx-class-bk-both" | [[API Time.MJDToWeekday|MJDToWeekday]]
| class="mtx-class-bk-both" | Gets the day of the week that the MJD represents
|-
| colspan="2" class="mtx-class-bk-both" | [[API Time.GetLeapYear|GetLeapYear]]
| class="mtx-class-bk-both" | Returns true if the given year is a leap year, else false
|-
| colspan="2" class="mtx-class-bk-both" | [[API Time.GetMonthDays|GetMonthDays]]
| class="mtx-class-bk-both" | Returns the number of days in the given month
|-
|}

</tab>

<tab name="Language">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API Language.Translate|Translate]]
| class="mtx-class-bk-both" | Takes English text and optional hint and converts to the current language
|-
|}

</tab>

<tab name="System">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.Notify|Notify]]
| class="mtx-class-bk-both" | Sends a System.User message to the targeted component
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.Forward|Forward]]
| class="mtx-class-bk-both" | Sends the currently processing message to the target
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.MacroExists|MacroExists]]
| class="mtx-class-bk-both" | Returns true if the macro exists
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.CallMacro|CallMacro]]
| class="mtx-class-bk-both" | Calls a macro
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.ShowHandle|ShowHandle]]
| class="mtx-class-bk-both" | Given a handle to an object with viewable presence, shows that object on screen
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.CreateHandle|CreateHandle]]
| class="mtx-class-bk-both" | Creates a general-purpose garbage collected handle for resource management
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.SetHandleWord|SetHandleWord]]
| class="mtx-class-bk-both" | Sets a general purpose word in the handle for use by its owner
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.GetHandleWord|GetHandleWord]]
| class="mtx-class-bk-both" | Gets a general-purpose word set by the owner of a custom handle
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.DeleteHandle|DeleteHandle]]
| class="mtx-class-bk-both" | Deletes any handle created by the component
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.GetSender|GetSender]]
| class="mtx-class-bk-both" | Gets the handle of the component that posted this event - 0 for system
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.TimerStart|TimerStart]]
| class="mtx-class-bk-both" | Calls the Component.Timer event with Ident as an argument after Millisecs time
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.TimerStop|TimerStop]]
| class="mtx-class-bk-both" | Kills any timers with the given ident for this component
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.WDTEnable|WDTEnable]]
| class="mtx-class-bk-both" | Enables or disables the software watchdog during long operations
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.ClaimEvent|ClaimEvent]]
| class="mtx-class-bk-both" | Claims an event message by name, returns true if claimed
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.ReleaseEvent|ReleaseEvent]]
| class="mtx-class-bk-both" | Releases a previously claimed an event message by name, returns true if released
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.EnableEvent|EnableEvent]]
| class="mtx-class-bk-both" | Allows an event to be fired or removes the ability for an event to fire - this may be nested
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.ClaimMouse|ClaimMouse]]
| class="mtx-class-bk-both" | Claims mouse clicks for the target object
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.ReleaseMouse|ReleaseMouse]]
| class="mtx-class-bk-both" | Releases mouse clicks for the target object
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.RedirectMacros|RedirectMacros]]
| class="mtx-class-bk-both" | Allows calls to one of your children to be redirected to another component
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.StartSim|StartSim]]
| class="mtx-class-bk-both" | Start the simulation engine
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.StopSim|StopSim]]
| class="mtx-class-bk-both" | Stop the simulation engine
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.SetSimSpeed|SetSimSpeed]]
| class="mtx-class-bk-both" | Sets the speed the simulation engine
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.SetClipboardData|SetClipboardData]]
| class="mtx-class-bk-both" | Sets the clipboard with text data
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.ReadClipboardData|ReadClipboardData]]
| class="mtx-class-bk-both" | Reads text data from the clipboard
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.GetHasFocus|GetHasFocus]]
| class="mtx-class-bk-both" | Checks to see if a Flowcode window has the focus
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.ShellExecute|ShellExecute]]
| class="mtx-class-bk-both" | Launches an external file or program on this computer
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.WriteRegistryInt|WriteRegistryInt]]
| class="mtx-class-bk-both" | Writes an integer value to the registry
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.WriteRegistryString|WriteRegistryString]]
| class="mtx-class-bk-both" | Writes a string value to the registry
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.ReadRegistryInt|ReadRegistryInt]]
| class="mtx-class-bk-both" | Reads an integer value from the registry
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.ReadRegistryString|ReadRegistryString]]
| class="mtx-class-bk-both" | Reads a string value from the registry
|-
|}

</tab>

<tab name="Debug">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API Debug.Print|Print]]
| class="mtx-class-bk-both" | Prints out the string or value on a line in the debug window
|-
| colspan="2" class="mtx-class-bk-both" | [[API Debug.PrintLn|PrintLn]]
| class="mtx-class-bk-both" | Prints out the string or value with a new-line in the debug window
|-
| colspan="2" class="mtx-class-bk-both" | [[API Debug.TestFunction|TestFunction]]
| class="mtx-class-bk-both" | Temporary debug function
|-
|}

</tab>

</tabs>

==Events==

A Flowcode simulation event is similar to an Interrupt but aimed at performing a specific job. The events will not be referenced at all for downloaded microcontroller code but may be used in the generation of such code.

The events available in Flowcode are listed here:

<tabs>

<tab name="Compile">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Compile.Preprocess|Preprocess]]
| class="mtx-class-bk-both" | Broadcast to all components immediately before compilation is started
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Compile.AddProperty|AddProperty]]
| class="mtx-class-bk-both" | Sent to a component to allow dynamic amendment of global property declarations
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Compile.AddConst|AddConst]]
| class="mtx-class-bk-both" | Sent to a component to allow dynamic amendment of global variable declarations
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Compile.AddVarSize|AddVarSize]]
| class="mtx-class-bk-both" | Sent to a component to allow dynamic amendment of global array-size declarations
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Compile.AddVar|AddVar]]
| class="mtx-class-bk-both" | Sent to a component to allow dynamic amendment of global constant declarations
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Compile.AddHeader|AddHeader]]
| class="mtx-class-bk-both" | Sent to a component to allow dynamic amendment of header code
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Compile.AddInterrupts|AddInterrupts]]
| class="mtx-class-bk-both" | Sent to a component to allow dynamic amendment of the interrupts for a component
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Compile.AddInterrupt|AddInterrupt]]
| class="mtx-class-bk-both" | Sent to a component to allow dynamic amendment of a single interrupts code
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Compile.Start|Start]]
| class="mtx-class-bk-both" | Broadcast to all components that compilation is starting
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Compile.Stop|Stop]]
| class="mtx-class-bk-both" | Broadcast to all components that compilation has stopped
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Compile.GetVarSize|GetVarSize]]
| class="mtx-class-bk-both" | Sent to a component to amend the size of the expected array
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Compile.HtmlBodyInfo|HtmlBodyInfo]]
| class="mtx-class-bk-both" | Sent to a component to retrieve tags to be placed in the html body
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Compile.HtmlScriptHeader|HtmlScriptHeader]]
| class="mtx-class-bk-both" | Sent to a component to retrieve script code to be placed in the html header section
|-
|}

</tab>

<tab name="Components">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Components.PropertyEx|PropertyEx]]
| class="mtx-class-bk-both" | Sent when a property has been changed by the User (specific property and value identified)
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Components.Property|Property]]
| class="mtx-class-bk-both" | Sent when a property has been changed by the User
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Components.ProjectClosedown|ProjectClosedown]]
| class="mtx-class-bk-both" | Sent to the component when the project is closing
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Components.Added|Added]]
| class="mtx-class-bk-both" | Broadcast to all existing components once a new component has been added
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Components.Adding|Adding]]
| class="mtx-class-bk-both" | Broadcast to all existing components when a new component is about to be added
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Components.Resize|Resize]]
| class="mtx-class-bk-both" | Sent to the mouse target when the user has altered the position of a component child
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Components.Removed|Removed]]
| class="mtx-class-bk-both" | Broadcast to all remaining components after a component has been removed
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Components.Removing|Removing]]
| class="mtx-class-bk-both" | Broadcast to all existing components when a component is about to be removed
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Components.Renamed|Renamed]]
| class="mtx-class-bk-both" | Sent to the component when the component is renamed
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Components.Deleted|Deleted]]
| class="mtx-class-bk-both" | Closedown routine for the component
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Components.Deleting|Deleting]]
| class="mtx-class-bk-both" | Send to a component when it is being deleted
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Components.Initialise|Initialise]]
| class="mtx-class-bk-both" | Initialisation routine for the component once the component is linked to its parent
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Components.Initialising|Initialising]]
| class="mtx-class-bk-both" | Initialisation routine before the component is linked to its parent
|-
|}

</tab>

<tab name="Console">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Console.AddLine|AddLine]]
| class="mtx-class-bk-both" | Post to the owning component when a line is inserted by the user
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Console.TextChanged|TextChanged]]
| class="mtx-class-bk-both" | Post when the console text is changed by the user in some way
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Console.MemChanged|MemChanged]]
| class="mtx-class-bk-both" | Post when the console memory is changed by the user in some way
|-
|}

</tab>

<tab name="Connection">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Connection.PinPopulate|PinPopulate]]
| class="mtx-class-bk-both" | Sent when auto-populate of digital connections is requested
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Connection.PinChange|PinChange]]
| class="mtx-class-bk-both" | Sent during simulation if a connected port pin changes
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Connection.AnPopulate|AnPopulate]]
| class="mtx-class-bk-both" | Sent when auto-populate of analog connections is requested
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Connection.AnChange|AnChange]]
| class="mtx-class-bk-both" | Sent during simulation if a connected ADC channel changes
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Connection.ChipChange|ChipChange]]
| class="mtx-class-bk-both" | Sent when the target device has changed
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Connection.Unconnected|Unconnected]]
| class="mtx-class-bk-both" | Sent when the component is compiled with unconnected pins
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Connection.FCDChange|FCDChange]]
| class="mtx-class-bk-both" | Sent when some settings of the target device have changed
|-
|}

</tab>

<tab name="Simulation">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Simulation.Pause|Pause]]
| class="mtx-class-bk-both" | Broadcast to all components that simulation has paused
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Simulation.Resume|Resume]]
| class="mtx-class-bk-both" | Broadcast to all components that simulation has resumed
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Simulation.Start|Start]]
| class="mtx-class-bk-both" | Broadcast to all components that simulation is starting
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Simulation.Stop|Stop]]
| class="mtx-class-bk-both" | Broadcast to all components that simulation has stopped
|-
|}

</tab>

<tab name="System">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[Event System.CleanHandle|CleanHandle]]
| class="mtx-class-bk-both" | Called when a custom handle is deleted to allow cleanup of resources
|-
| colspan="2" class="mtx-class-bk-both" | [[Event System.Timer|Timer]]
| class="mtx-class-bk-both" | Called back on the panel command System.TimerStart
|-
| colspan="2" class="mtx-class-bk-both" | [[Event System.User|User]]
| class="mtx-class-bk-both" | Called back on the panel command System.Notify
|-
| colspan="2" class="mtx-class-bk-both" | [[Event System.LoadComplete|LoadComplete]]
| class="mtx-class-bk-both" | Broadcast after a project has finished loading
|-
|}

</tab>

<tab name="Sound">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Sound.Complete|Complete]]
| class="mtx-class-bk-both" | Sent when a sound queued by the component has finished playing
|-
|}

</tab>

<tab name="DataRecorder">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[Event DataRecorder.ResyncPacket|ResyncPacket]]
| class="mtx-class-bk-both" | Sent when Packet_ResyncEv is specified in scope decoding
|-
| colspan="2" class="mtx-class-bk-both" | [[Event DataRecorder.Decode|Decode]]
| class="mtx-class-bk-both" | Sent when a block of the stream is to be decoded into packets
|-
| colspan="2" class="mtx-class-bk-both" | [[Event DataRecorder.FmtPacket|FmtPacket]]
| class="mtx-class-bk-both" | Sent when a %e is read in a format string when decoding a packet
|-
| colspan="2" class="mtx-class-bk-both" | [[Event DataRecorder.Overlay|Overlay]]
| class="mtx-class-bk-both" | Sent when the mouse hovers over a scope stream
|-
|}

</tab>

<tab name="Tooltip">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Tooltip.GraphicPoll|GraphicPoll]]
| class="mtx-class-bk-both" | Called when a tooltip graphic is updating with the draw image already pushed
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Tooltip.GetText|GetText]]
| class="mtx-class-bk-both" | Called when a tooltip text string can be displayed
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Tooltip.GetGraphic|GetGraphic]]
| class="mtx-class-bk-both" | Called when a tooltip graphic can be displayed with the draw image already pushed
|-
|}

</tab>

<tab name="File">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[Event File.Changed|Changed]]
| class="mtx-class-bk-both" | Sent when a file being watched has changed
|-
| colspan="2" class="mtx-class-bk-both" | [[Event File.Closed|Closed]]
| class="mtx-class-bk-both" | Sent when a file monitor is being closed
|-
|}

</tab>

<tab name="Graphics">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Graphics.Animated|Animated]]
| class="mtx-class-bk-both" | Notification than an animation has finished
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Graphics.Background|Background]]
| class="mtx-class-bk-both" | Updates the background container of the 2d panel
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Graphics.Redraw|Redraw]]
| class="mtx-class-bk-both" | Reconstructs and redraws the target component
|-
|}

</tab>

<tab name="Keyboard">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Keyboard.ButtonName|ButtonName]]
| class="mtx-class-bk-both" | Sent to give a meaningful name to a button on a simulated mouse-click
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Keyboard.KeyMapDown|KeyMapDown]]
| class="mtx-class-bk-both" | Post when a mapped key is pressed for the component
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Keyboard.KeyMapUp|KeyMapUp]]
| class="mtx-class-bk-both" | Post when a mapped key is released for the component
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Keyboard.MappingKeys|MappingKeys]]
| class="mtx-class-bk-both" | Sent to find out how many keys it is possible to map to the component during simulation
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Keyboard.MappingName|MappingName]]
| class="mtx-class-bk-both" | Sent to give a meaningful name to a custom key-map event for a component
|-
|}

</tab>

<tab name="Mouse">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Mouse.Release|Release]]
| class="mtx-class-bk-both" | Post when the mouse is released on a child of the component during simulation
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Mouse.Click|Click]]
| class="mtx-class-bk-both" | Post when the mouse is clicked on a child of the component during simulation
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Mouse.Drag|Drag]]
| class="mtx-class-bk-both" | Post when the mouse is dragged on a child of the component during simulation
|-
|}

</tab>

</tabs>

Overview of Simulation

2026-07-23T16:07:33Z

SteveT:

<sidebar>Sidebar: Flowcode Help Overview</sidebar>
Flowcode can simulate advanced systems and replicate applications by using the [[Dashboard Panel]] and [[System Panel]] in combination with [[Simulation Events]] and [[Simulation Functions|Built-in Simulation Functions]] in a flowchart project to instruct the simulation.

{| class="wikitable" style="width: 70%; margin:auto; text-align:center;"
|-
! colspan="2" | [[Exercise - Simulating a Program]]
|-
| width="40%" align="center" | [[Starting Flowchart Simulation]]
|How to start simulation and information explaining simulation
|-
| width="40%" align="center" | [[Simulating Icons Step by Step]]
|Step by step simulation and changing variables during simulation
|-
| width="40%" align="center" | [[Changing the Speed of a Simulation]]
|Changing the simulation and clock speed using 'Project Options'
|-
| width="40%" align="center" | [[Simulation Debugger]]
|Display and control variable values, macro calls and simulation speed
|-
| width="40%" align="center" | [[Component Debugger]]
|Allows you to monitor API calls, functions, events and timers in simulation
|}

Simulation Functionality

2026-07-23T16:04:38Z

SteveT:

In Flowcode, simulation allows you to test and debug your embedded system designs without needing physical hardware. It provides a visual environment where you can run your program, interact with components, and observe their behavior in real-time. The simulation includes features like breakpoints, variable tracking, and real-time data display, helping you identify issues and optimize your design before uploading it to the actual hardware.

Flowcode's simulation feature offers a powerful environment for testing and debugging embedded system designs. Here’s more detail on its capabilities:

* Real-Time Simulation: You can run your design as if it were on actual hardware, with real-time updates on how components like LEDs, sensors, or motors behave in response to the programmed logic.
* Interactive Testing: Many components allow user interaction during the simulation. For example, you can press virtual buttons, adjust sensor values, or modify inputs to see how the system responds.
* Debugging Tools: The simulation includes essential debugging features like breakpoints, step-by-step execution, and variable tracking. This lets you pause and inspect your program at specific points to identify issues or optimize performance.
* Graphical Feedback: Data like sensor readings or communication signals can be visualized using built-in graphs and data monitors, making it easier to observe trends and behaviors over time.
* Component Visualization: Physical components, such as displays or motors, are visually represented, so you can see how they would react in a real-world scenario, enhancing understanding and design verification.
* Error Checking: Flowcode provides error messages and warnings during simulation, helping catch issues like incorrect component configurations or logical errors in the code.

Simulation in Flowcode helps streamline the development process by allowing thorough testing before deployment to hardware, reducing errors and saving time in the prototyping phase.

__TOC__

==Built in functions==
Flowcode provides a set of built-in functions (also known as the API or ''application programming interface'') to help writing simulation and PC-side programs.

This API is a list of macros built in to Flowcode with each group, or class, of macros dealing with a specific area of the system.

Use of this API is limited to simulation only - when downloaded to the chip these calls will be omitted, so if need be they can be interleaved in downloadable code.

A reference to the classes and macros available can be found here:

<tabs>

<tab name="Component">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="3" align="center" class="mtx-class-bk-head" | Property
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.GetValue|GetValue]]
| class="mtx-class-bk-both" | Gets the value of a property as a string
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.SetColor|SetColor]]
| class="mtx-class-bk-both" | Sets a components 'color' property as a R,G,B value
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.SetValue|SetValue]]
| class="mtx-class-bk-both" | Sets a components property as a string
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.CopyValue|CopyValue]]
| class="mtx-class-bk-both" | Copies a property value from one target to another
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.SetChildValues|SetChildValues]]
| class="mtx-class-bk-both" | Sets all child components property as a string
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.CopyChildValues|CopyChildValues]]
| class="mtx-class-bk-both" | Copies the values of a properties children from the source to dest
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.SetVisible|SetVisible]]
| class="mtx-class-bk-both" | Sets whether the property is visible or not
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.SetWritable|SetWritable]]
| class="mtx-class-bk-both" | Sets whether the property can be edited in the UI or not
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.GetVisible|GetVisible]]
| class="mtx-class-bk-both" | Gets whether the property is visible or not
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.GetWritable|GetWritable]]
| class="mtx-class-bk-both" | Gets whether the property can be edited in the UI or not
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.GetFilter|GetFilter]]
| class="mtx-class-bk-both" | Gets a components property filter string for lists, files, etc
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.SetFilter|SetFilter]]
| class="mtx-class-bk-both" | Sets a components property filter string for lists, files, etc
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.CopyFilter|CopyFilter]]
| class="mtx-class-bk-both" | Copies a property filter from one target to another
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.GetListIndex|GetListIndex]]
| class="mtx-class-bk-both" | Gets a single lists index value from a property by line number
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.GetListItem|GetListItem]]
| class="mtx-class-bk-both" | Gets a single list entry from a property by named index
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.SetListItem|SetListItem]]
| class="mtx-class-bk-both" | Sets an existing list entries text for the property by named index
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Property.AddListItem|AddListItem]]
| class="mtx-class-bk-both" | Alters or appends a list entries text for the property by named index
|-
|}
{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.GetPanel|GetPanel]]
| class="mtx-class-bk-both" | Returns the id of the panel hosting the component
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.SetInteractive|SetInteractive]]
| class="mtx-class-bk-both" | Sets whether a component can interact with the mouse
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.GetInteractive|GetInteractive]]
| class="mtx-class-bk-both" | Gets whether a component can interact with the mouse
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.SetVisible|SetVisible]]
| class="mtx-class-bk-both" | Sets whether a component can be seen on the panel
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.GetVisible|GetVisible]]
| class="mtx-class-bk-both" | Gets whether a component can be seen on the panel
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.SetSolid|SetSolid]]
| class="mtx-class-bk-both" | Sets whether a component is checked in collision detections
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.GetSolid|GetSolid]]
| class="mtx-class-bk-both" | Gets whether a component is checked in collision detections
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.SetCompile|SetCompile]]
| class="mtx-class-bk-both" | Sets whether a component is considered for compilation or not
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.GetCompile|GetCompile]]
| class="mtx-class-bk-both" | Gets whether a component will be compiled or not
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.GetInstance|GetInstance]]
| class="mtx-class-bk-both" | Gets the type-instance of the component, >= 1 is valid
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.FindChild|FindChild]]
| class="mtx-class-bk-both" | Finds a named object that is part of the component
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.GetRoot|GetRoot]]
| class="mtx-class-bk-both" | Gets the root component handle
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.GetTopParent|GetTopParent]]
| class="mtx-class-bk-both" | Gets the top-level owner of the component
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.GetParent|GetParent]]
| class="mtx-class-bk-both" | Gets the owner of the component
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.GetNext|GetNext]]
| class="mtx-class-bk-both" | Gets the next (younger) sibling of the components handle
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.GetLast|GetLast]]
| class="mtx-class-bk-both" | Gets the previous (elder) sibling of the components handle
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.GetChildHead|GetChildHead]]
| class="mtx-class-bk-both" | Gets the first (eldest) child of the component
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.GetChildTail|GetChildTail]]
| class="mtx-class-bk-both" | Gets the last (youngest) child of the component
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.GetOriginal|GetOriginal]]
| class="mtx-class-bk-both" | Gets the original definition of the component, returns Current if no original copy
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Clone|Clone]]
| class="mtx-class-bk-both" | Clones an existing object to another position on the panel
|-
| colspan="2" class="mtx-class-bk-both" | [[API Component.Delete|Delete]]
| class="mtx-class-bk-both" | Deletes an existing object, removing it from the panel
|-
|}

</tab>

<tab name="Panel">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.GetPanelName|GetPanelName]]
| class="mtx-class-bk-both" | Returns the name of the panel from the id
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.GetPanelBkColour|GetPanelBkColour]]
| class="mtx-class-bk-both" | Returns the main background colour of the panel
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Get2dPanelCount|Get2dPanelCount]]
| class="mtx-class-bk-both" | Gets the number of 2d panels
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Create2dPanel|Create2dPanel]]
| class="mtx-class-bk-both" | Creates a new 2d panel
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.AddNewComponent|AddNewComponent]]
| class="mtx-class-bk-both" | Adds a new component to a panel
|-
|}
{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="3" align="center" class="mtx-class-bk-head" | Position
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.GetWorldPosition|GetWorldPosition]]
| class="mtx-class-bk-both" | Returns the positions coordinates in (X,Y,Z) array
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.GetWorldSize|GetWorldSize]]
| class="mtx-class-bk-both" | Returns the component size in (X,Y,Z) array
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.SetWorldPosition|SetWorldPosition]]
| class="mtx-class-bk-both" | Moves the object to the given coordinates in World coordinates
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.SetWorldSize|SetWorldSize]]
| class="mtx-class-bk-both" | Sets the objects size to a value
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.Get|Get]]
| class="mtx-class-bk-both" | Gets a handle to an object representing the components current position
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.GetOrigin|GetOrigin]]
| class="mtx-class-bk-both" | Gets a handle to an empty position
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.Set|Set]]
| class="mtx-class-bk-both" | Sets an objects position based on a component or pre-defined position
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.SetCoords|SetCoords]]
| class="mtx-class-bk-both" | Sets an objects coordinates based on a position
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.SetScale|SetScale]]
| class="mtx-class-bk-both" | Sets an objects scale based on a position
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.SetRotation|SetRotation]]
| class="mtx-class-bk-both" | Sets an objects orientation based on a position
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.GetBox|GetBox]]
| class="mtx-class-bk-both" | Gets a handle to an object representing the components bounding box position
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.GetLineNodes|GetLineNodes]]
| class="mtx-class-bk-both" | Returns the position of a line's nodes as a comma-separated list
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.SetLineNodes|SetLineNodes]]
| class="mtx-class-bk-both" | Sets the nodes of a line
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.Morph|Morph]]
| class="mtx-class-bk-both" | Blends positions from two sources to a destination
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.Animate|Animate]]
| class="mtx-class-bk-both" | Blends positions from two sources to a destination over time
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.StopAnimate|StopAnimate]]
| class="mtx-class-bk-both" | Stops all animations started by this component
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.MoveAlong|MoveAlong]]
| class="mtx-class-bk-both" | Moves the object by the given offset relative to its parent along an axis
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.MoveBy|MoveBy]]
| class="mtx-class-bk-both" | Moves the object by the given offset relative to its parent
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.MoveTo|MoveTo]]
| class="mtx-class-bk-both" | Moves the object to the given coordinates relative to its parent
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.ScaleTo|ScaleTo]]
| class="mtx-class-bk-both" | Sets the objects scale to a value
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.ScaleUp|ScaleUp]]
| class="mtx-class-bk-both" | Multiplies the objects scale by a value
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.ScaleDown|ScaleDown]]
| class="mtx-class-bk-both" | Divides the objects scale by a value
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.RotateTo|RotateTo]]
| class="mtx-class-bk-both" | Rotates the object to the given rotation
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.RotateAlong|RotateAlong]]
| class="mtx-class-bk-both" | Rotates the object by the given rotation along an axis
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.RotateX|RotateX]]
| class="mtx-class-bk-both" | Rotates the object around the X axis
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.RotateY|RotateY]]
| class="mtx-class-bk-both" | Rotates the object around the Y axis
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.RotateZ|RotateZ]]
| class="mtx-class-bk-both" | Rotates the object around the Z axis
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.GetCoords|GetCoords]]
| class="mtx-class-bk-both" | Returns the positions coordinates in (X,Y,Z) array
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.GetScale|GetScale]]
| class="mtx-class-bk-both" | Returns the positions scale in (X,Y,Z) array
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.GetQuat|GetQuat]]
| class="mtx-class-bk-both" | Returns the positions quaternion in (X,Y,Z,W) array
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.GetEuler|GetEuler]]
| class="mtx-class-bk-both" | Returns the positions euler angles in (P,Y,R) array
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.Math|Math]]
| class="mtx-class-bk-both" | Coordinate maths functions
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.Panel2D|Panel2D]]
| class="mtx-class-bk-both" | 2D Panel functions
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Position.Camera|Camera]]
| class="mtx-class-bk-both" | Camera positioning for 3D panel
|-
|}
{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="3" align="center" class="mtx-class-bk-head" | PCloud
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.Create|Create]]
| class="mtx-class-bk-both" | Creates a new point cloud tied to a position handle
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.SetVisible|SetVisible]]
| class="mtx-class-bk-both" | Sets whether the point cloud is displayed or not
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.SetPos|SetPos]]
| class="mtx-class-bk-both" | Sets the position for the point cloud to be located at
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.GetPos|GetPos]]
| class="mtx-class-bk-both" | Gets the position the point cloud is located at
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.SetPoints|SetPoints]]
| class="mtx-class-bk-both" | Sets the X,Y,Z point lists
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.SetPointsEx|SetPointsEx]]
| class="mtx-class-bk-both" | Sets the X,Y,Z point lists
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.SetGrid|SetGrid]]
| class="mtx-class-bk-both" | Sets the X,Y,Z point lists in a height-map grid
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.SetGridEx|SetGridEx]]
| class="mtx-class-bk-both" | Sets the X,Y,Z point lists in a height-map grid
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.SetGridFlat|SetGridFlat]]
| class="mtx-class-bk-both" | Sets the X,Y,Z point lists in a flat height-map grid
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.SetGridPoint|SetGridPoint]]
| class="mtx-class-bk-both" | Given an XY on the grid, sets the vertex value at that point
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.UnitScale|UnitScale]]
| class="mtx-class-bk-both" | Creates a unit scaled axis (X, Y or Z) with a center of zero and a range of two
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.SetColor|SetColor]]
| class="mtx-class-bk-both" | Sets the RGB colour of the entire cloud
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.SetColors|SetColors]]
| class="mtx-class-bk-both" | Sets the RGB colour of the individual points in the cloud
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.SetGridColor|SetGridColor]]
| class="mtx-class-bk-both" | Given an XY on the grid, sets the vertex colour at that point
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.SetMode|SetMode]]
| class="mtx-class-bk-both" | Sets the rendering mode of the point cloud
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.SetPointLight|SetPointLight]]
| class="mtx-class-bk-both" | Enables or disables simple lighting for point mode, providing a normal passing through the point and (0,0,0)
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.PCloud.Update|Update]]
| class="mtx-class-bk-both" | Manually refresh the screen the point cloud exists on
|-
|}
{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="3" align="center" class="mtx-class-bk-head" | LinkBar
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.LinkBar.Create|Create]]
| class="mtx-class-bk-both" | Creates a new bar linking a pair of position handles
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.LinkBar.SetVisible|SetVisible]]
| class="mtx-class-bk-both" | Sets whether the link is displayed or not
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.LinkBar.SetStartPos|SetStartPos]]
| class="mtx-class-bk-both" | Sets the position for the start point of the bar
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.LinkBar.SetEndPos|SetEndPos]]
| class="mtx-class-bk-both" | Sets the position for the end point of the bar
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.LinkBar.SetStartAdjustment|SetStartAdjustment]]
| class="mtx-class-bk-both" | Sets the clipping adjustments for the beginning of the link
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.LinkBar.SetEndAdjustment|SetEndAdjustment]]
| class="mtx-class-bk-both" | Sets the clipping adjustments for the end of the link
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.LinkBar.SetStartGfx|SetStartGfx]]
| class="mtx-class-bk-both" | Sets the graphic for the start point of the bar
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.LinkBar.SetBarGfx|SetBarGfx]]
| class="mtx-class-bk-both" | Sets the graphic for the main line of the bar
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.LinkBar.SetEndGfx|SetEndGfx]]
| class="mtx-class-bk-both" | Sets the graphic for the end point of the bar
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.LinkBar.GetStartPos|GetStartPos]]
| class="mtx-class-bk-both" | Gets the position the bars start point is located at
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.LinkBar.GetBarPos|GetBarPos]]
| class="mtx-class-bk-both" | Gets the position the bar is located at
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.LinkBar.GetEndPos|GetEndPos]]
| class="mtx-class-bk-both" | Gets the position the bars end point is located at
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.LinkBar.Update|Update]]
| class="mtx-class-bk-both" | Manually refresh the screen the bar exists on
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.LinkBar.EnableAuto|EnableAuto]]
| class="mtx-class-bk-both" | Sets whether Flowcode should automatically draw links for component object property types
|-
|}
{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="3" align="center" class="mtx-class-bk-head" | TextLabel
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.TextLabel.Create|Create]]
| class="mtx-class-bk-both" | Creates a new text label that always faces the camera
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.TextLabel.SetVisible|SetVisible]]
| class="mtx-class-bk-both" | Sets whether the label is displayed or not
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.TextLabel.SetPos|SetPos]]
| class="mtx-class-bk-both" | Sets the position for the point to draw the text at
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.TextLabel.SetOffset|SetOffset]]
| class="mtx-class-bk-both" | Sets the offset from the SetPos() position for the label
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.TextLabel.SetText|SetText]]
| class="mtx-class-bk-both" | Sets the text for the label
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.TextLabel.SetScale|SetScale]]
| class="mtx-class-bk-both" | Sets the multipliers for the width and height of the label
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.TextLabel.SetColors|SetColors]]
| class="mtx-class-bk-both" | Sets the foreground and background colours for the label
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.TextLabel.SetViewMode|SetViewMode]]
| class="mtx-class-bk-both" | Sets whether to draw at a fixed size or to scale based on distance from the camera
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.TextLabel.GetPos|GetPos]]
| class="mtx-class-bk-both" | Gets the position the label is located at
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.TextLabel.Update|Update]]
| class="mtx-class-bk-both" | Manually refresh the screen the label exists on
|-
|}
{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="3" align="center" class="mtx-class-bk-head" | Collision
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Collision.TestTable|TestTable]]
| class="mtx-class-bk-both" | Tests whether an object collides with the table top, returns Z distance to move to rest on the table
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Collision.TestSingle|TestSingle]]
| class="mtx-class-bk-both" | Tests whether an object collides with a position
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Collision.GetSingleAxis|GetSingleAxis]]
| class="mtx-class-bk-both" | Tests whether an object collides with a position
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Collision.GetSinglePos|GetSinglePos]]
| class="mtx-class-bk-both" | Returns the position to move Pos to so it does not collide with Test - null if no collide
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Collision.GetMultiAxis|GetMultiAxis]]
| class="mtx-class-bk-both" | Tests whether an object collides with a position
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Collision.GetMultiPos|GetMultiPos]]
| class="mtx-class-bk-both" | Returns the position to move Pos to so it does not collide with any other object - null if no collide
|-
|}
{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="3" align="center" class="mtx-class-bk-head" | Graphics
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.Redraw|Redraw]]
| class="mtx-class-bk-both" | Sends a redraw request to the given component
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.SetColor|SetColor]]
| class="mtx-class-bk-both" | Sets the draw colour for and subsequent graphics objects
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.SetColorRGB|SetColorRGB]]
| class="mtx-class-bk-both" | Sets the draw colour for and subsequent graphics objects
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.SetTextFont|SetTextFont]]
| class="mtx-class-bk-both" | Sets the text font for subsequent text objects
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.SetTextScale|SetTextScale]]
| class="mtx-class-bk-both" | Sets the text scale for subsequent text objects
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.SetLineThickness|SetLineThickness]]
| class="mtx-class-bk-both" | Sets the thinkness when drawing lines and points
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.DrawCreate|DrawCreate]]
| class="mtx-class-bk-both" | Creates a drawing area on a shape
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.DrawBegin|DrawBegin]]
| class="mtx-class-bk-both" | Begins drawing on a given shape
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.DrawEnd|DrawEnd]]
| class="mtx-class-bk-both" | Ends drawing started with DrawBegin()
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.DrawDelete|DrawDelete]]
| class="mtx-class-bk-both" | Deletes a drawing area for a shape
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.DrawText|DrawText]]
| class="mtx-class-bk-both" | Draws a line of text texture
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.DrawPoint|DrawPoint]]
| class="mtx-class-bk-both" | Draws a point on a texture
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.DrawLine|DrawLine]]
| class="mtx-class-bk-both" | Draws a line on a texture
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.DrawLineA|DrawLineA]]
| class="mtx-class-bk-both" | Draws a smooth line on a texture
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.DrawRect|DrawRect]]
| class="mtx-class-bk-both" | Draws a rectangle on a texture
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.DrawCircle|DrawCircle]]
| class="mtx-class-bk-both" | Draws a circle on a texture
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.Clear|Clear]]
| class="mtx-class-bk-both" | Clear texture to the given component
|-
| colspan="2" class="mtx-class-bk-both" | [[API Panel.Graphics.Shape|Shape]]
| class="mtx-class-bk-both" | Routines to change the last drawn shape
|-
|}
</tab>

<tab name="Mouse">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API Mouse.GetButtons|GetButtons]]
| class="mtx-class-bk-both" | Gets the button state from the mouse: 4 for left, 1 for right
|-
| colspan="2" class="mtx-class-bk-both" | [[API Mouse.GetFocus|GetFocus]]
| class="mtx-class-bk-both" | Gets the handle of the component under the mouse
|-
| colspan="2" class="mtx-class-bk-both" | [[API Mouse.GetPosition|GetPosition]]
| class="mtx-class-bk-both" | Gets the position of the mouse, intersecting with a component or the viewing plane
|-
| colspan="2" class="mtx-class-bk-both" | [[API Mouse.GetPosition2D|GetPosition2D]]
| class="mtx-class-bk-both" | Gets the X/Y position of the mouse in screen coords
|-
| colspan="2" class="mtx-class-bk-both" | [[API Mouse.GetClickSide|GetClickSide]]
| class="mtx-class-bk-both" | Gets the side of the component clicked on, 0 to 5
|-
| colspan="2" class="mtx-class-bk-both" | [[API Mouse.SimClick|SimClick]]
| class="mtx-class-bk-both" | Simulates a click on an object
|-
| colspan="2" class="mtx-class-bk-both" | [[API Mouse.SimDrag|SimDrag]]
| class="mtx-class-bk-both" | Simulates a click-drag on an object
|-
| colspan="2" class="mtx-class-bk-both" | [[API Mouse.SimRelease|SimRelease]]
| class="mtx-class-bk-both" | Simulates a click-release on an object
|-
|}

</tab>

<tab name="Keyboard">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API Keyboard.KeyDown|KeyDown]]
| class="mtx-class-bk-both" | Simulates a key-press on an object
|-
| colspan="2" class="mtx-class-bk-both" | [[API Keyboard.KeyUp|KeyUp]]
| class="mtx-class-bk-both" | Simulates a key-release on an object
|-
|}

</tab>

<tab name="FCD">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API FCD.GetItemValue|GetItemValue]]
| class="mtx-class-bk-both" | Gets a paths item value from the FCD document
|-
| colspan="2" class="mtx-class-bk-both" | [[API FCD.GetItemHandle|GetItemHandle]]
| class="mtx-class-bk-both" | Gets a FCD items handle, suitable for traversal with the Tree API
|-
| colspan="2" class="mtx-class-bk-both" | [[API FCD.GetPathHandle|GetPathHandle]]
| class="mtx-class-bk-both" | Gets a FCD paths handle, suitable for traversal with the Tree API
|-
| colspan="2" class="mtx-class-bk-both" | [[API FCD.SetItemValue|SetItemValue]]
| class="mtx-class-bk-both" | Override item value from the FCD document from path
|-
| colspan="2" class="mtx-class-bk-both" | [[API FCD.ResetItemValue|ResetItemValue]]
| class="mtx-class-bk-both" | Reset paths item value from the FCD document
|-
|}

</tab>

<tab name="Sound">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API Sound.Play|Play]]
| class="mtx-class-bk-both" | Plays a formatted file sound, returns true if the sound played OK
|-
| colspan="2" class="mtx-class-bk-both" | [[API Sound.LoadWav|LoadWav]]
| class="mtx-class-bk-both" | Loads a wave file into memory, providing the values needed to play it
|-
| colspan="2" class="mtx-class-bk-both" | [[API Sound.Create|Create]]
| class="mtx-class-bk-both" | Creates a sound object that data can be played through
|-
| colspan="2" class="mtx-class-bk-both" | [[API Sound.SetVolume|SetVolume]]
| class="mtx-class-bk-both" | Sets the volume of playbacks for this sound
|-
| colspan="2" class="mtx-class-bk-both" | [[API Sound.GetVolume|GetVolume]]
| class="mtx-class-bk-both" | Gets the volume of playbacks for this sound in the range 0 to 1
|-
| colspan="2" class="mtx-class-bk-both" | [[API Sound.GetBits|GetBits]]
| class="mtx-class-bk-both" | Gets the number of bits per sample for the sound
|-
| colspan="2" class="mtx-class-bk-both" | [[API Sound.GetRate|GetRate]]
| class="mtx-class-bk-both" | Gets the current sample rate for the sound
|-
| colspan="2" class="mtx-class-bk-both" | [[API Sound.SetRate|SetRate]]
| class="mtx-class-bk-both" | Sets the current sample rate for the sound - this will stop the playing sound
|-
| colspan="2" class="mtx-class-bk-both" | [[API Sound.Queue|Queue]]
| class="mtx-class-bk-both" | Queues a sound for playing
|-
| colspan="2" class="mtx-class-bk-both" | [[API Sound.QueueEx|QueueEx]]
| class="mtx-class-bk-both" | Queues a sound for playing, with the format provided
|-
| colspan="2" class="mtx-class-bk-both" | [[API Sound.Flush|Flush]]
| class="mtx-class-bk-both" | Stops all playing and queued sounds
|-
| colspan="2" class="mtx-class-bk-both" | [[API Sound.GetPending|GetPending]]
| class="mtx-class-bk-both" | Gets the number of sample blocks queued or playing for the sound
|-
|}

</tab>

<tab name="DataRecorder">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.AddGroup|AddGroup]]
| class="mtx-class-bk-both" | Adds a group to the scope to which streams may be added
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.ShowGroup|ShowGroup]]
| class="mtx-class-bk-both" | Sets the visibility of the given group
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.AddStream|AddStream]]
| class="mtx-class-bk-both" | Adds a stream to the given group suitable for inputs and operations
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.AddBuffer|AddBuffer]]
| class="mtx-class-bk-both" | Adds a fixed-view stream to the given group suitable for inputs and operations
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.Rename|Rename]]
| class="mtx-class-bk-both" | Renames the given scope group, stream or buffer
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.SetYAxisLabels|SetYAxisLabels]]
| class="mtx-class-bk-both" | Sets the labels for the Y-axis of the given stream
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.SetLineColor|SetLineColor]]
| class="mtx-class-bk-both" | Sets the group, stream or buffers line colour
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.GetLineColor|GetLineColor]]
| class="mtx-class-bk-both" | Gets the streams line colour
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.SetBackColor|SetBackColor]]
| class="mtx-class-bk-both" | Sets the groups background colour
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.GetBackColor|GetBackColor]]
| class="mtx-class-bk-both" | Gets the stream groups background colour
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.SetDecodable|SetDecodable]]
| class="mtx-class-bk-both" | Sets whether a stream can be decoded via the components event - defaults to 'true'
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.GetDecodable|GetDecodable]]
| class="mtx-class-bk-both" | Gets whether a stream can be decoded via the components event - defaults to 'true'
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.AddPort|AddPort]]
| class="mtx-class-bk-both" | Adds an input to the stream from a port
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.AddAnalog|AddAnalog]]
| class="mtx-class-bk-both" | Adds an input to the stream from an analog channel
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.AddCustom|AddCustom]]
| class="mtx-class-bk-both" | Adds an input to the stream from a custom injection
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.AddOp|AddOp]]
| class="mtx-class-bk-both" | Adds an operation to act on the inputs of the stream
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.ClearOps|ClearOps]]
| class="mtx-class-bk-both" | Clears all inputs and operations from the given stream
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.SetBuffer|SetBuffer]]
| class="mtx-class-bk-both" | Sets the contents of a snapshot stream
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.SetCustom|SetCustom]]
| class="mtx-class-bk-both" | Sets one of 32 custom analog values for the group
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.GetSnapshot|GetSnapshot]]
| class="mtx-class-bk-both" | Gets a block of the output stream with each input sample operated on, returns number of samples read
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.FindOutput|FindOutput]]
| class="mtx-class-bk-both" | Searches back through the output history for a value, returns offset of found sample from TimeUS, 0 if not found
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.FindPeriod|FindPeriod]]
| class="mtx-class-bk-both" | Attempts to calculate the wave period given a series of transitions for the stream, returns calculated period
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.SetPacketFmt|SetPacketFmt]]
| class="mtx-class-bk-both" | Sets the graphical format of the packets added with AddPacket and Add...Packets
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.GetPacketFmt|GetPacketFmt]]
| class="mtx-class-bk-both" | Returns the graphical format of the packets added with AddPacket and Add...Packets
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.AddPacket|AddPacket]]
| class="mtx-class-bk-both" | Adds an overlay packet to the stream at a given offset from the current time
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.AddStepPackets|AddStepPackets]]
| class="mtx-class-bk-both" | Adds overlay packets to the stream by decoding the stream contents with a fixed period rate
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.AddSyncPackets|AddSyncPackets]]
| class="mtx-class-bk-both" | Adds overlay packets to the stream by decoding the stream contents with a variable period rate
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.ClearPackets|ClearPackets]]
| class="mtx-class-bk-both" | Clears existing overlay packets from the stream
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.ClearAllPackets|ClearAllPackets]]
| class="mtx-class-bk-both" | Clears all existing overlay packets from the stream
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.TicksToSecs|TicksToSecs]]
| class="mtx-class-bk-both" | Converts a duration in ticks into a time in seconds
|-
| colspan="2" class="mtx-class-bk-both" | [[API DataRecorder.SecsToTicks|SecsToTicks]]
| class="mtx-class-bk-both" | Converts a time in seconds into a duration in ticks
|-
|}

</tab>

<tab name="Calculations">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API Calculations.FloatToStorageULong|FloatToStorageULong]]
| class="mtx-class-bk-both" | Converts a float to an array containing 4 bytes
|-
| colspan="2" class="mtx-class-bk-both" | [[API Calculations.StorageULongToFloat|StorageULongToFloat]]
| class="mtx-class-bk-both" | Returns a float value from an unsigned long representation (used to store or transfer it)
|-
| colspan="2" class="mtx-class-bk-both" | [[API Calculations.GetFrequencyArray|GetFrequencyArray]]
| class="mtx-class-bk-both" | Calculates the frequency from an array of data.
|-
| colspan="2" class="mtx-class-bk-both" | [[API Calculations.GetAmplitudeArray|GetAmplitudeArray]]
| class="mtx-class-bk-both" | Calculates the amplitude from an array of data.
|-
|}

</tab>

<tab name="Console">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API Console.AddText|AddText]]
| class="mtx-class-bk-both" | Adds a window to the list of consoles available
|-
| colspan="2" class="mtx-class-bk-both" | [[API Console.AddMemory|AddMemory]]
| class="mtx-class-bk-both" | Adds a window to the list of consoles available
|-
| colspan="2" class="mtx-class-bk-both" | [[API Console.GetDefault|GetDefault]]
| class="mtx-class-bk-both" | Gets the default (read-only) console window
|-
| colspan="2" class="mtx-class-bk-both" | [[API Console.GetConsole|GetConsole]]
| class="mtx-class-bk-both" | Gets a console window
|-
| colspan="2" class="mtx-class-bk-both" | [[API Console.GetName|GetName]]
| class="mtx-class-bk-both" | Returns the name of a console
|-
| colspan="2" class="mtx-class-bk-both" | [[API Console.Rename|Rename]]
| class="mtx-class-bk-both" | Renames the given console
|-
| colspan="2" class="mtx-class-bk-both" | [[API Console.SetMemMode|SetMemMode]]
| class="mtx-class-bk-both" | Sets whether to show address and bytes for the console
|-
| colspan="2" class="mtx-class-bk-both" | [[API Console.SetInputRGB|SetInputRGB]]
| class="mtx-class-bk-both" | Sets the colour of text inserted by the user from now on
|-
| colspan="2" class="mtx-class-bk-both" | [[API Console.SetOutputRGB|SetOutputRGB]]
| class="mtx-class-bk-both" | Sets the colour of text inserted by the component from now on
|-
| colspan="2" class="mtx-class-bk-both" | [[API Console.WriteText|WriteText]]
| class="mtx-class-bk-both" | Adds a block of text to the console window
|-
| colspan="2" class="mtx-class-bk-both" | [[API Console.GetLineText|GetLineText]]
| class="mtx-class-bk-both" | Reads a line of text from the given console, pass -1 for final line
|-
| colspan="2" class="mtx-class-bk-both" | [[API Console.SetLineText|SetLineText]]
| class="mtx-class-bk-both" | Writes a line of text from the given console, pass -1 for final line
|-
| colspan="2" class="mtx-class-bk-both" | [[API Console.GetLineBytes|GetLineBytes]]
| class="mtx-class-bk-both" | Reads a line of bytes from the given console extending the array if needed
|-
| colspan="2" class="mtx-class-bk-both" | [[API Console.SetLineBytes|SetLineBytes]]
| class="mtx-class-bk-both" | Writes a line of bytes from the given console, pass -1 for final line
|-
| colspan="2" class="mtx-class-bk-both" | [[API Console.CountLines|CountLines]]
| class="mtx-class-bk-both" | Counts the number of lines in the console
|-
| colspan="2" class="mtx-class-bk-both" | [[API Console.ClearText|ClearText]]
| class="mtx-class-bk-both" | Clears all the text in the console
|-
|}

</tab>

<tab name="Connection">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API Connection.GetPort|GetPort]]
| class="mtx-class-bk-both" | Gets a ports value from its index
|-
| colspan="2" class="mtx-class-bk-both" | [[API Connection.SetPort|SetPort]]
| class="mtx-class-bk-both" | Sets a ports value from its index
|-
| colspan="2" class="mtx-class-bk-both" | [[API Connection.GetAn|GetAn]]
| class="mtx-class-bk-both" | Gets an analog value from its channel index
|-
| colspan="2" class="mtx-class-bk-both" | [[API Connection.SetAn|SetAn]]
| class="mtx-class-bk-both" | Sets an analog value from its index, range 0->1
|-
| colspan="2" class="mtx-class-bk-both" | [[API Connection.DecodePort|DecodePort]]
| class="mtx-class-bk-both" | Gets a ports details from its name or index
|-
|}

</tab>

<tab name="Expand">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API Expand.PathName|PathName]]
| class="mtx-class-bk-both" | Expands a string using the built-in pathname expansion variables
|-
| colspan="2" class="mtx-class-bk-both" | [[API Expand.MacroName|MacroName]]
| class="mtx-class-bk-both" | Expands a string to the name of a macro used in the generated code
|-
| colspan="2" class="mtx-class-bk-both" | [[API Expand.VarName|VarName]]
| class="mtx-class-bk-both" | Expands a string to the name of a global variable used in the generated code
|-
| colspan="2" class="mtx-class-bk-both" | [[API Expand.Property|Property]]
| class="mtx-class-bk-both" | Expands a string to the name of a property used in the generated code
|-
| colspan="2" class="mtx-class-bk-both" | [[API Expand.MacroHead|MacroHead]]
| class="mtx-class-bk-both" | Expands a macro name to the code generated for the header of that macro
|-
| colspan="2" class="mtx-class-bk-both" | [[API Expand.MacroBody|MacroBody]]
| class="mtx-class-bk-both" | Expands a macro name to the code generated for the body of that macro
|-
| colspan="2" class="mtx-class-bk-both" | [[API Expand.MacroTail|MacroTail]]
| class="mtx-class-bk-both" | Expands a macro name to the code generated for the tail of that macro
|-
|}

</tab>

<tab name="Tree">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.GetValue|GetValue]]
| class="mtx-class-bk-both" | Gets the value of the given object, if available
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.GetName|GetName]]
| class="mtx-class-bk-both" | Gets the name of the given object
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.GetPath|GetPath]]
| class="mtx-class-bk-both" | Gets the full '.' separated name of the given object
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.GetSubValue|GetSubValue]]
| class="mtx-class-bk-both" | Gets the value of a named sub-item of the given object, if available
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.Traverse|Traverse]]
| class="mtx-class-bk-both" | Updates the object to step depth-first through the tree
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.StepNext|StepNext]]
| class="mtx-class-bk-both" | Updates the object to point to the next (younger) sibling
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.StepNamedNext|StepNamedNext]]
| class="mtx-class-bk-both" | Updates the object to point to the next (younger) sibling matching the name
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.StepNamedIndex|StepNamedIndex]]
| class="mtx-class-bk-both" | Updates the object to point to the Nth next (younger) sibling matching the name
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.StepLast|StepLast]]
| class="mtx-class-bk-both" | Updates the object to point to the last (elder) sibling
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.StepParent|StepParent]]
| class="mtx-class-bk-both" | Updates the object to point to its parent object
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.StepRoot|StepRoot]]
| class="mtx-class-bk-both" | Updates the object to point to the root of the tree
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.StepChildHead|StepChildHead]]
| class="mtx-class-bk-both" | Updates the object to point to the head (eldest) child
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.StepChildTail|StepChildTail]]
| class="mtx-class-bk-both" | Updates the object to point to the tail (youngest) child
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.StepChildPath|StepChildPath]]
| class="mtx-class-bk-both" | Updates the object to point to the '.' separated named child path
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.CountChildren|CountChildren]]
| class="mtx-class-bk-both" | Returns the number of immediate children present for the object
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.CheckChildren|CheckChildren]]
| class="mtx-class-bk-both" | Returns true if the object has children, else false
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.CountNamedChildren|CountNamedChildren]]
| class="mtx-class-bk-both" | Returns the number of immediate children present for the object
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.CheckParent|CheckParent]]
| class="mtx-class-bk-both" | Returns true if the object has a parent, else false if it is the root
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.StepSubHead|StepSubHead]]
| class="mtx-class-bk-both" | Updates the object to point to the head (eldest) attribute, if any
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.StepSubTail|StepSubTail]]
| class="mtx-class-bk-both" | Updates the object to point to the tail (youngest) attribute, if any
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.StepSubName|StepSubName]]
| class="mtx-class-bk-both" | Updates the object to point to the named attribute, if any
|-
| colspan="2" class="mtx-class-bk-both" | [[API Tree.GetCopy|GetCopy]]
| class="mtx-class-bk-both" | Creates a copy of the handle and returns the copy
|-
|}

</tab>

<tab name="File">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.AbsPath|AbsPath]]
| class="mtx-class-bk-both" | Gets an absolute path from a relative filename
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.RelPath|RelPath]]
| class="mtx-class-bk-both" | Gets an relative path from an absolute filename
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.CreateDir|CreateDir]]
| class="mtx-class-bk-both" | Creates a directory structure
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.GetType|GetType]]
| class="mtx-class-bk-both" | Finds the type of a file: 0=Unknown, 1=File, 2=Dir, 4=Disk
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.GetSize|GetSize]]
| class="mtx-class-bk-both" | Gets the number of bytes in the file, by handle or name
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.Delete|Delete]]
| class="mtx-class-bk-both" | Deletes the file or directory structure
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.Create|Create]]
| class="mtx-class-bk-both" | Creates the new file as a standard stream
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.Open|Open]]
| class="mtx-class-bk-both" | Opens the existing file as a standard stream
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.ReadArray|ReadArray]]
| class="mtx-class-bk-both" | Reads an array from the file, returns elements read
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.WriteArray|WriteArray]]
| class="mtx-class-bk-both" | Writes an array to the file
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.SetPos|SetPos]]
| class="mtx-class-bk-both" | Sets the position of the next read or write in the file
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.GetPos|GetPos]]
| class="mtx-class-bk-both" | Gets the position of the next read or write in the file
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.Flush|Flush]]
| class="mtx-class-bk-both" | Writes all unwritten data to the file in one block
|-
|}
{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="3" align="center" class="mtx-class-bk-head" | Buffer
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.Buffer.Open|Open]]
| class="mtx-class-bk-both" | Opens the existing file as a circular buffer
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.Buffer.Create|Create]]
| class="mtx-class-bk-both" | Creates the new file as a circular buffer
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.Buffer.ReadByte|ReadByte]]
| class="mtx-class-bk-both" | Reads a single byte from the input stream, -1 if empty
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.Buffer.WriteByte|WriteByte]]
| class="mtx-class-bk-both" | Writes a single byte to the input stream
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.Buffer.ReadArray|ReadArray]]
| class="mtx-class-bk-both" | Reads an array from the input stream, returns elements read
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.Buffer.WriteArray|WriteArray]]
| class="mtx-class-bk-both" | Writes an array to the input stream
|-
|}
{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="3" align="center" class="mtx-class-bk-head" | NVM
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.NVM.Open|Open]]
| class="mtx-class-bk-both" | Opens the existing file as a block of non-volatile memory
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.NVM.Create|Create]]
| class="mtx-class-bk-both" | Creates the new file as a block of non-volatile memory
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.NVM.ReadByte|ReadByte]]
| class="mtx-class-bk-both" | Reads a single byte from the NVM, -1 if empty
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.NVM.WriteByte|WriteByte]]
| class="mtx-class-bk-both" | Writes a single byte to the NVM multiple times
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.NVM.ReadArray|ReadArray]]
| class="mtx-class-bk-both" | Reads an array from the NVM, returns elements read
|-
| colspan="2" class="mtx-class-bk-both" | [[API File.NVM.WriteArray|WriteArray]]
| class="mtx-class-bk-both" | Writes an array to the NVM
|-
|}
</tab>

<tab name="UI">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API UI.SimpleMsgBox|SimpleMsgBox]]
| class="mtx-class-bk-both" | Displays a simple 'Ok' message box
|-
| colspan="2" class="mtx-class-bk-both" | [[API UI.Win32MsgBox|Win32MsgBox]]
| class="mtx-class-bk-both" | Invokes the Win32 API MessageBox function
|-
| colspan="2" class="mtx-class-bk-both" | [[API UI.YesNoMsgBox|YesNoMsgBox]]
| class="mtx-class-bk-both" | Displays a simple 'Yes/No' message box
|-
| colspan="2" class="mtx-class-bk-both" | [[API UI.YesNoCancelMsgBox|YesNoCancelMsgBox]]
| class="mtx-class-bk-both" | Displays a simple 'Yes/No/Cancel' message box (0 == Cancel, 1 == No, 2 == Yes)
|-
| colspan="2" class="mtx-class-bk-both" | [[API UI.InputMsgBox|InputMsgBox]]
| class="mtx-class-bk-both" | Displays a message box that allows the user to input text. Returns true if 'Ok' clicked, false otherwise
|-
|}

</tab>

<tab name="Time">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API Time.GetMillisecs|GetMillisecs]]
| class="mtx-class-bk-both" | Returns the value of a monotonic non-decrementing millisecond counter
|-
| colspan="2" class="mtx-class-bk-both" | [[API Time.GetUTC|GetUTC]]
| class="mtx-class-bk-both" | Returns the current UTC Modified Julian Date value
|-
| colspan="2" class="mtx-class-bk-both" | [[API Time.GetLocal|GetLocal]]
| class="mtx-class-bk-both" | Returns the current local time as a Modified Julian Date value
|-
| colspan="2" class="mtx-class-bk-both" | [[API Time.AddMJD|AddMJD]]
| class="mtx-class-bk-both" | Increments or decrements a Modified Julian Date and millisecond value
|-
| colspan="2" class="mtx-class-bk-both" | [[API Time.MJDToDate|MJDToDate]]
| class="mtx-class-bk-both" | Converts a Modified Julian Date into a Gregorian calendar date
|-
| colspan="2" class="mtx-class-bk-both" | [[API Time.DateToMJD|DateToMJD]]
| class="mtx-class-bk-both" | Converts a Gregorian calendar date into a Modified Julian Date
|-
| colspan="2" class="mtx-class-bk-both" | [[API Time.MJDToSeconds|MJDToSeconds]]
| class="mtx-class-bk-both" | Converts a Modified Julian Date into a number of seconds since a specified epoch
|-
| colspan="2" class="mtx-class-bk-both" | [[API Time.SecondsToMJD|SecondsToMJD]]
| class="mtx-class-bk-both" | Returns the Modified Julian Date given by the number of seconds since a specified epoch
|-
| colspan="2" class="mtx-class-bk-both" | [[API Time.MJDToWeekday|MJDToWeekday]]
| class="mtx-class-bk-both" | Gets the day of the week that the MJD represents
|-
| colspan="2" class="mtx-class-bk-both" | [[API Time.GetLeapYear|GetLeapYear]]
| class="mtx-class-bk-both" | Returns true if the given year is a leap year, else false
|-
| colspan="2" class="mtx-class-bk-both" | [[API Time.GetMonthDays|GetMonthDays]]
| class="mtx-class-bk-both" | Returns the number of days in the given month
|-
|}

</tab>

<tab name="Language">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API Language.Translate|Translate]]
| class="mtx-class-bk-both" | Takes English text and optional hint and converts to the current language
|-
|}

</tab>

<tab name="System">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.Notify|Notify]]
| class="mtx-class-bk-both" | Sends a System.User message to the targeted component
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.Forward|Forward]]
| class="mtx-class-bk-both" | Sends the currently processing message to the target
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.MacroExists|MacroExists]]
| class="mtx-class-bk-both" | Returns true if the macro exists
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.CallMacro|CallMacro]]
| class="mtx-class-bk-both" | Calls a macro
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.ShowHandle|ShowHandle]]
| class="mtx-class-bk-both" | Given a handle to an object with viewable presence, shows that object on screen
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.CreateHandle|CreateHandle]]
| class="mtx-class-bk-both" | Creates a general-purpose garbage collected handle for resource management
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.SetHandleWord|SetHandleWord]]
| class="mtx-class-bk-both" | Sets a general purpose word in the handle for use by its owner
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.GetHandleWord|GetHandleWord]]
| class="mtx-class-bk-both" | Gets a general-purpose word set by the owner of a custom handle
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.DeleteHandle|DeleteHandle]]
| class="mtx-class-bk-both" | Deletes any handle created by the component
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.GetSender|GetSender]]
| class="mtx-class-bk-both" | Gets the handle of the component that posted this event - 0 for system
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.TimerStart|TimerStart]]
| class="mtx-class-bk-both" | Calls the Component.Timer event with Ident as an argument after Millisecs time
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.TimerStop|TimerStop]]
| class="mtx-class-bk-both" | Kills any timers with the given ident for this component
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.WDTEnable|WDTEnable]]
| class="mtx-class-bk-both" | Enables or disables the software watchdog during long operations
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.ClaimEvent|ClaimEvent]]
| class="mtx-class-bk-both" | Claims an event message by name, returns true if claimed
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.ReleaseEvent|ReleaseEvent]]
| class="mtx-class-bk-both" | Releases a previously claimed an event message by name, returns true if released
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.EnableEvent|EnableEvent]]
| class="mtx-class-bk-both" | Allows an event to be fired or removes the ability for an event to fire - this may be nested
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.ClaimMouse|ClaimMouse]]
| class="mtx-class-bk-both" | Claims mouse clicks for the target object
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.ReleaseMouse|ReleaseMouse]]
| class="mtx-class-bk-both" | Releases mouse clicks for the target object
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.RedirectMacros|RedirectMacros]]
| class="mtx-class-bk-both" | Allows calls to one of your children to be redirected to another component
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.StartSim|StartSim]]
| class="mtx-class-bk-both" | Start the simulation engine
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.StopSim|StopSim]]
| class="mtx-class-bk-both" | Stop the simulation engine
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.SetSimSpeed|SetSimSpeed]]
| class="mtx-class-bk-both" | Sets the speed the simulation engine
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.SetClipboardData|SetClipboardData]]
| class="mtx-class-bk-both" | Sets the clipboard with text data
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.ReadClipboardData|ReadClipboardData]]
| class="mtx-class-bk-both" | Reads text data from the clipboard
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.GetHasFocus|GetHasFocus]]
| class="mtx-class-bk-both" | Checks to see if a Flowcode window has the focus
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.ShellExecute|ShellExecute]]
| class="mtx-class-bk-both" | Launches an external file or program on this computer
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.WriteRegistryInt|WriteRegistryInt]]
| class="mtx-class-bk-both" | Writes an integer value to the registry
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.WriteRegistryString|WriteRegistryString]]
| class="mtx-class-bk-both" | Writes a string value to the registry
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.ReadRegistryInt|ReadRegistryInt]]
| class="mtx-class-bk-both" | Reads an integer value from the registry
|-
| colspan="2" class="mtx-class-bk-both" | [[API System.ReadRegistryString|ReadRegistryString]]
| class="mtx-class-bk-both" | Reads a string value from the registry
|-
|}

</tab>

<tab name="Debug">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[API Debug.Print|Print]]
| class="mtx-class-bk-both" | Prints out the string or value on a line in the debug window
|-
| colspan="2" class="mtx-class-bk-both" | [[API Debug.PrintLn|PrintLn]]
| class="mtx-class-bk-both" | Prints out the string or value with a new-line in the debug window
|-
| colspan="2" class="mtx-class-bk-both" | [[API Debug.TestFunction|TestFunction]]
| class="mtx-class-bk-both" | Temporary debug function
|-
|}

</tab>

</tabs>

==Events==

A Flowcode simulation event is similar to an Interrupt but aimed at performing a specific job. The events will not be referenced at all for downloaded microcontroller code but may be used in the generation of such code.

The events available in Flowcode are listed here:

<tabs>

<tab name="Compile">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Compile.Preprocess|Preprocess]]
| class="mtx-class-bk-both" | Broadcast to all components immediately before compilation is started
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Compile.AddProperty|AddProperty]]
| class="mtx-class-bk-both" | Sent to a component to allow dynamic amendment of global property declarations
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Compile.AddConst|AddConst]]
| class="mtx-class-bk-both" | Sent to a component to allow dynamic amendment of global variable declarations
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Compile.AddVarSize|AddVarSize]]
| class="mtx-class-bk-both" | Sent to a component to allow dynamic amendment of global array-size declarations
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Compile.AddVar|AddVar]]
| class="mtx-class-bk-both" | Sent to a component to allow dynamic amendment of global constant declarations
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Compile.AddHeader|AddHeader]]
| class="mtx-class-bk-both" | Sent to a component to allow dynamic amendment of header code
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Compile.AddInterrupts|AddInterrupts]]
| class="mtx-class-bk-both" | Sent to a component to allow dynamic amendment of the interrupts for a component
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Compile.AddInterrupt|AddInterrupt]]
| class="mtx-class-bk-both" | Sent to a component to allow dynamic amendment of a single interrupts code
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Compile.Start|Start]]
| class="mtx-class-bk-both" | Broadcast to all components that compilation is starting
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Compile.Stop|Stop]]
| class="mtx-class-bk-both" | Broadcast to all components that compilation has stopped
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Compile.GetVarSize|GetVarSize]]
| class="mtx-class-bk-both" | Sent to a component to amend the size of the expected array
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Compile.HtmlBodyInfo|HtmlBodyInfo]]
| class="mtx-class-bk-both" | Sent to a component to retrieve tags to be placed in the html body
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Compile.HtmlScriptHeader|HtmlScriptHeader]]
| class="mtx-class-bk-both" | Sent to a component to retrieve script code to be placed in the html header section
|-
|}

</tab>

<tab name="Components">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Components.PropertyEx|PropertyEx]]
| class="mtx-class-bk-both" | Sent when a property has been changed by the User (specific property and value identified)
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Components.Property|Property]]
| class="mtx-class-bk-both" | Sent when a property has been changed by the User
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Components.ProjectClosedown|ProjectClosedown]]
| class="mtx-class-bk-both" | Sent to the component when the project is closing
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Components.Added|Added]]
| class="mtx-class-bk-both" | Broadcast to all existing components once a new component has been added
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Components.Adding|Adding]]
| class="mtx-class-bk-both" | Broadcast to all existing components when a new component is about to be added
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Components.Resize|Resize]]
| class="mtx-class-bk-both" | Sent to the mouse target when the user has altered the position of a component child
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Components.Removed|Removed]]
| class="mtx-class-bk-both" | Broadcast to all remaining components after a component has been removed
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Components.Removing|Removing]]
| class="mtx-class-bk-both" | Broadcast to all existing components when a component is about to be removed
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Components.Renamed|Renamed]]
| class="mtx-class-bk-both" | Sent to the component when the component is renamed
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Components.Deleted|Deleted]]
| class="mtx-class-bk-both" | Closedown routine for the component
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Components.Deleting|Deleting]]
| class="mtx-class-bk-both" | Send to a component when it is being deleted
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Components.Initialise|Initialise]]
| class="mtx-class-bk-both" | Initialisation routine for the component once the component is linked to its parent
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Components.Initialising|Initialising]]
| class="mtx-class-bk-both" | Initialisation routine before the component is linked to its parent
|-
|}

</tab>

<tab name="Console">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Console.AddLine|AddLine]]
| class="mtx-class-bk-both" | Post to the owning component when a line is inserted by the user
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Console.TextChanged|TextChanged]]
| class="mtx-class-bk-both" | Post when the console text is changed by the user in some way
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Console.MemChanged|MemChanged]]
| class="mtx-class-bk-both" | Post when the console memory is changed by the user in some way
|-
|}

</tab>

<tab name="Connection">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Connection.PinPopulate|PinPopulate]]
| class="mtx-class-bk-both" | Sent when auto-populate of digital connections is requested
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Connection.PinChange|PinChange]]
| class="mtx-class-bk-both" | Sent during simulation if a connected port pin changes
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Connection.AnPopulate|AnPopulate]]
| class="mtx-class-bk-both" | Sent when auto-populate of analog connections is requested
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Connection.AnChange|AnChange]]
| class="mtx-class-bk-both" | Sent during simulation if a connected ADC channel changes
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Connection.ChipChange|ChipChange]]
| class="mtx-class-bk-both" | Sent when the target device has changed
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Connection.Unconnected|Unconnected]]
| class="mtx-class-bk-both" | Sent when the component is compiled with unconnected pins
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Connection.FCDChange|FCDChange]]
| class="mtx-class-bk-both" | Sent when some settings of the target device have changed
|-
|}

</tab>

<tab name="Simulation">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Simulation.Pause|Pause]]
| class="mtx-class-bk-both" | Broadcast to all components that simulation has paused
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Simulation.Resume|Resume]]
| class="mtx-class-bk-both" | Broadcast to all components that simulation has resumed
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Simulation.Start|Start]]
| class="mtx-class-bk-both" | Broadcast to all components that simulation is starting
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Simulation.Stop|Stop]]
| class="mtx-class-bk-both" | Broadcast to all components that simulation has stopped
|-
|}

</tab>

<tab name="System">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[Event System.CleanHandle|CleanHandle]]
| class="mtx-class-bk-both" | Called when a custom handle is deleted to allow cleanup of resources
|-
| colspan="2" class="mtx-class-bk-both" | [[Event System.Timer|Timer]]
| class="mtx-class-bk-both" | Called back on the panel command System.TimerStart
|-
| colspan="2" class="mtx-class-bk-both" | [[Event System.User|User]]
| class="mtx-class-bk-both" | Called back on the panel command System.Notify
|-
| colspan="2" class="mtx-class-bk-both" | [[Event System.LoadComplete|LoadComplete]]
| class="mtx-class-bk-both" | Broadcast after a project has finished loading
|-
|}

</tab>

<tab name="Sound">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Sound.Complete|Complete]]
| class="mtx-class-bk-both" | Sent when a sound queued by the component has finished playing
|-
|}

</tab>

<tab name="DataRecorder">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[Event DataRecorder.ResyncPacket|ResyncPacket]]
| class="mtx-class-bk-both" | Sent when Packet_ResyncEv is specified in scope decoding
|-
| colspan="2" class="mtx-class-bk-both" | [[Event DataRecorder.Decode|Decode]]
| class="mtx-class-bk-both" | Sent when a block of the stream is to be decoded into packets
|-
| colspan="2" class="mtx-class-bk-both" | [[Event DataRecorder.FmtPacket|FmtPacket]]
| class="mtx-class-bk-both" | Sent when a %e is read in a format string when decoding a packet
|-
| colspan="2" class="mtx-class-bk-both" | [[Event DataRecorder.Overlay|Overlay]]
| class="mtx-class-bk-both" | Sent when the mouse hovers over a scope stream
|-
|}

</tab>

<tab name="Tooltip">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Tooltip.GraphicPoll|GraphicPoll]]
| class="mtx-class-bk-both" | Called when a tooltip graphic is updating with the draw image already pushed
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Tooltip.GetText|GetText]]
| class="mtx-class-bk-both" | Called when a tooltip text string can be displayed
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Tooltip.GetGraphic|GetGraphic]]
| class="mtx-class-bk-both" | Called when a tooltip graphic can be displayed with the draw image already pushed
|-
|}

</tab>

<tab name="File">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[Event File.Changed|Changed]]
| class="mtx-class-bk-both" | Sent when a file being watched has changed
|-
| colspan="2" class="mtx-class-bk-both" | [[Event File.Closed|Closed]]
| class="mtx-class-bk-both" | Sent when a file monitor is being closed
|-
|}

</tab>

<tab name="Graphics">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Graphics.Animated|Animated]]
| class="mtx-class-bk-both" | Notification than an animation has finished
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Graphics.Background|Background]]
| class="mtx-class-bk-both" | Updates the background container of the 2d panel
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Graphics.Redraw|Redraw]]
| class="mtx-class-bk-both" | Reconstructs and redraws the target component
|-
|}

</tab>

<tab name="Keyboard">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Keyboard.ButtonName|ButtonName]]
| class="mtx-class-bk-both" | Sent to give a meaningful name to a button on a simulated mouse-click
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Keyboard.KeyMapDown|KeyMapDown]]
| class="mtx-class-bk-both" | Post when a mapped key is pressed for the component
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Keyboard.KeyMapUp|KeyMapUp]]
| class="mtx-class-bk-both" | Post when a mapped key is released for the component
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Keyboard.MappingKeys|MappingKeys]]
| class="mtx-class-bk-both" | Sent to find out how many keys it is possible to map to the component during simulation
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Keyboard.MappingName|MappingName]]
| class="mtx-class-bk-both" | Sent to give a meaningful name to a custom key-map event for a component
|-
|}

</tab>

<tab name="Mouse">

{| class="wikitable" style="width: 800px; background-color: transparent;"
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Mouse.Release|Release]]
| class="mtx-class-bk-both" | Post when the mouse is released on a child of the component during simulation
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Mouse.Click|Click]]
| class="mtx-class-bk-both" | Post when the mouse is clicked on a child of the component during simulation
|-
| colspan="2" class="mtx-class-bk-both" | [[Event Mouse.Drag|Drag]]
| class="mtx-class-bk-both" | Post when the mouse is dragged on a child of the component during simulation
|-
|}

</tab>

</tabs>

API Overview

2026-07-23T15:58:41Z

SteveT:

API Overview

2026-07-23T15:04:43Z

SteveT:

Flowcode provides an ''application programming interface'' to help writing simulation and PC-side programs.

This API is a list of macros built in to Flowcode with each group, or class, of macros dealing with a specific area of the system.

Use of this API is limited to simulation only - when downloaded to the chip these calls will be omitted, so if need be they can be interleaved in downloadable code.

Below is a reference to the classes available.
A complete list of [[Simulation Functionality|classes and macros]] is also available.
{| class="wikitable" width="85%"
|-
! width="45%" | Class path
! width="55%" | Description
|-
| [[API Component|Component]]
| Component traversal functions
|-
| [[API Component.Property|Component.Property]]
| Property manipulation functions
|-
| [[API Panel|Panel]]
| Panel object manipulations
|-
| [[API Panel.Position|Panel.Position]]
| Coordinate manipulation functions
|-
| [[API Panel.Position.Math|Panel.Position.Math]]
| Coordinate maths functions
|-
| [[API Panel.Position.Camera|Panel.Position.Camera]]
| Camera positioning
|-
| [[API Panel.PCloud|Panel.PCloud]]
| Point cloud manipulation
|-
| [[API Panel.LinkBar|Panel.LinkBar]]
| Position linkage management
|-
| [[API Panel.Collision|Panel.Collision]]
| Collision detection functions
|-
| [[API Panel.Graphics|Panel.Graphics]]
| Direct drawing routines for a single frame
|-
| [[API Panel.Graphics.Shape|Panel.Graphics.Shape]]
| Routines to change the last drawn shape
|-
| [[API Mouse|Mouse]]
| Mouse reading interface
|-
| [[API Keyboard|Keyboard]]
| Keyboard reading interface
|-
| [[API FCD|FCD]]
| Flowcode Chip Definition reading routines
|-
| [[API Sound|Sound]]
| Audio streaming interface
|-
| [[API Scope|DataRecorder]]
| Data scope additions
|-
| [[API Calculations|Calculations]]
| Miscellaneous calculations
|-
| [[API Console|Console]]
| Text console additions
|-
| [[API Connection|Connection]]
| Analog and digital connections
|-
| [[API Expand|Expand]]
| Various variable and code expansion routines
|-
| [[API Tree|Tree]]
| Data-tree traversal type routines
|-
| [[API File|File]]
| File reading and writing operations
|-
| [[API File.Buffer|File.Buffer]]
| Reads writes and monitors circular buffers
|-
| [[API File.NVM|File.NVM]]
| Reads from a file as though a block of NVM
|-
| [[API UI|UI]]
| Display message boxes and alerts
|-
| [[API Time|Time]]
| Helps read and manage clock counters
|-
| [[API System|System]]
| General system operations
|-
| [[API Debug|Debug]]
| Debug and diagnostic
|}

API Reference

2026-07-23T14:57:56Z

SteveT: removed API table and provided a link instead

Version Updates

2026-07-23T14:55:09Z

SteveT: Updated API link

==Flowcode 11==

=====Licensing changes=====

Licence model has been changed to [[Software_Assurance|Software Assurance]]

=====Graphical Display Design Tools=====
New for version 11 is a full library of components for driving touch screen graphical displays: display drivers for the most popular touch screens, graphics widgets, graph widgets, touch screen components, WYSIWYG graphical display designer and menu control subroutines. These allow you to design touch screen graphical displays based on any 8, 16, or 32 bit microcontroller.

=====Web Mirror=====
The Web Mirror features allows you to mirror the functionality of you touch screen system on any browser anywhere in the world. This is only available on the E-Blocks 3 hardware for now. The great benefit is that you can use your mobile phone to control your electronic projects.

No coding is needed. It's just a couple of settings on the Graphical display component. Flowcode takes care of all the details.

=====New Project Wizard and Auto-detect=====
Getting started is so hard. So many options, choices, settings in our beautiful complex world. The [[Creating_Project|new project wizard]] provides a menu system that makes this easier for all users showing options and guiding users through choices.

If you have E-Blocks 3 hardware then it is even easier: Flowcode sees what upstream and downstream boards you have connected and sets up the program for you.

=====Serial Debugging on Hardware=====
Serial debugging allows you to pause your program as it runs in hardware and see the status of variables in your project. You can set breakpoints in your code and change the values of variables while program execution is paused.

Serial debugging was only available on Matrix hardware in V10. In V11, Serial debugging now works on third party hardware that has a serial COM port available via USB. This includes many Arduino, ESP32 and PIC boards.

=====E-Blocks 3 and Auto-id=====
The goal is simple: create the best environment for developing electronic projects. Its hard to separate the hardware from the software sometimes. The combination of Flowcode and E-Blocks 3 provides an amazing development platform for both educators and industrial engineers.

Each E-blocks downstream board has a small microcontroller on it. These communicate to the upstream board to inform Flowcode what hardware is connected. This allows Flowcode to put the appropriate components on the 2D panel with all the right settings, making project setup much easier!

=====New Microcontrollers=====
The world does not stand still. Manufacturers are constantly adding new microcontrollers with more features, smaller silicon areas, faster clock rates and so on.

We constantly add new microcontrollers to the chip lists. A lot of work has been done recently to add the Microchip PIC8 Q range.

Flowcode is now compatible with 1,789 microcontrollers.

=====2D Panel Updates=====
The 2D panel has been upgraded so that it is now possible to zoom in and out on all component views.

A new rich text components adds formatted text to components and panels, and all panel objects now can be anchored to the panel sides or even set to display completely in the panel (e.g. for showing charts in a separate window).

New features include:

*[[2d_Panels#Other_features_of_2D_panels|2D Panel zoom]]
*[[Component:_ID_component:GdiRichText|Richtext primitive]]
*Component anchoring
*Fill panel window

=====New Coding Features=====
A variety of new features have been added to make coding in Flowcode v11 even simpler than before.

Direct string comparisons can now be made in decision icons, the loop command has a "loop forever" option and several new operators (e.g. increment/decrement and assignment) have been added to make Flowcode calculations more representative of C code.

*Direct string comparisons
*[[Loop_Icon_Properties|Loop forever]]
*Increment and decrement operators
*Assignment operators (e.g. myval += 10)

=====Other improvements=====
*Dynamic menus and web-based windows added
*Anchors and 'fit component' options for panel objects
*Group icon contents can be viewed without needing to ungroup
*User is now warned when openign a project that is already open
*Flowcode now has separate icons for Embedded, Web Developer and PC Developer project files
*Macros can now be shown as a different graphical/text view direct from the macro tab
*Library version log file shows which versions of library files are used in compiled project
*Colour options available on macro descriptions
*Position anchors for components
*New richtext primitive for component panels
*View group icon contents
*Access variables in simulated component code
*Direct access to variable manager
*Warn when opening a project that is already open
*New file extensions for Flowcode project types
*Change macro view types on the fly
*Advanced component profiling and debugging
*Clear All Breakpoints no longer ignores the loop command
*Digital i/o panel now updated correctly when PORT property change iterates through subcomponents
*Digital i/o panel now updated correctly when pane is first opened
*Caption bar now shows project type
*Dropping icons onto overlapped macro views correctly drops onto topmost window
*Non-flowchart macros can now be exported as image
*New state diagram macro menu item added
*Web Developer projects do not show state diagram icons
*List Occurrences check is now case-insensitive
*Improvements to dark colour scheme
*Added ability to show and hide component macros via API command
*Fixed read-only nature of component properties
*Fixed the sim control speed slider
*Fixed 'corrupt macro' error message text that got lost during an exception
*Mouse events now triggered at the dead area at the top of Project Explorer
*Component major/minor versions now 0-999 (was 0-100)
*Hidden option to show '!=' as '<>'
*Fixed MatrixLight/MatrixDark inbuilt colour schemes for charts
*2d panels now hide toolbar when simulating
*FCDChange event is fired when chip stays the same but clock speed changes
*Fixed longstanding bug with broadcast message parameter corruption
*Moved components on 2d panel now redraw their vacated areas too
*Subcomponents of a group now get unique names when copying/pasting
*Added GetActual2dPosition/GetActual2dPosition API commands
*Context menu for component panels stops renames, deletion, etc, when simulating
*Wndhost comps (button, combobox and textbox) now update when resized on the panel
*Text primitives now redraw their actual text area too
*Improved visual styling for dark mode, and fixed styling issues with combo boxes, etc.
*Removed redundant colour and code-customisation information from saved project files
*Fixed SIGNED/UNSIGNED casting
*Fixed simulation of Decision tail icon
*Search now finds ports/pins
*Added logical AND, OR and NOT (&&, ||, !) to maths functions list
*Improved tooltip help for maths and string functions
*Function lists now categorised
*Call stack view width can be altered using mouse wheel in Simulation Debugger window
*Component panel zoom level now shown on status bar
*Improved component toolbar display on non-100% DPI systems
*New variables are given default initialisers
*Macro parameters can have default values for parameters
*Macro tabs have 'close' and 'close other' menu item
*Added CallMacro in-built functions
*Added in-built functions to manipulate text-based property lists
*Fixed flicker in IOC chip view in interrupt prpoperties dialog
*Components and macros now available to add to expressions in icon dialogs
*List properties can now be auto-sorted
*Flowcode now uses a 'ping' to ensure web-based dialogs retain current information

[https://flowcode.co.uk/forums/viewtopic.php?p=23397#p23397 Update v11.0.1.14]

==Flowcode 10==

=====Licensing changes=====

*Flowcode V10 is now free for makers and hobbyists with full functionality for a limited range of devices which include; '''[[Supported_Chips#Free_Targets|Arduino Uno & Nano, RPI etc. ]]'''

=====Components=====
*Can now view component code

*'''[[Components|Components]]''' are now free and open-sourced so you can use existing components and tailor them to your own requirements.

*Dedicated 2D primitive components

=====2D panels=====
New [[2d_Panels|2D panels]] provide clearer graphics, customisation of all panels with your own drawings, notes and much more printer friendly options available.

Add an unlimited number of 2D panels into your project.

Unlocks a host of new 2D panel only panel options such as graphing tools.

====Simulation====

*Improved ''[[Variable_Types|variable values]]'' display on simulation – view and edit ''[[Variable_Types|variable values]]'' during simulation and '''[[Ghost_Technology|ICD]]

*Interrupt on Change diagram visual improvements

*View and step through the simulation of component code (Pro Licence only)

*Ghost support for EB0058 ESP board

*Icon lists now show disabled icons in a muted colour

*Show variables on ''[[Oscilloscope|oscilloscope]]'' and ''[[Using_the_Data_Recorder|data recorder]]''

*The text colour of flowchart icons can be altered

=====Application=====
*Create separate .c and .h files

*Show help/wiki in separate browser

=====UI Trees=====

*New ''UI Trees'' tab within ''[[Global_Settings|Global Settings]]'' for customising ''[[Project Explorer|Project Explorer]]'' and Icon Lists

=====User Tools=====

*New ''User Tools'' tab within ''[[Global_Settings|Global Settings]]'' for setting up User Tools to be used within the ''Build ribbon''

=====I/O ports=====

*Connected components lists on analogue/digital windows

*When using Calculation icons (etc), pins can be dragged to the expression
=====Variables=====
*Combines global and local ''[[Creating_Variables|variables]]'' (which are also available separately)

*Show''[[Using_the_Project_Explorer| values]]'' during ''[[Starting_Flowchart_Simulation|simulation]]''

*Float ''[[Variable_Types|variables]]'' are now shown to a user-defined precision (defaults to “%g”)

=====Built-in Functions=====

*Single-dimension arrays show individual elements in Watch and Project Explorer lists

*There are some new built-in functions available

''[[Simulation Functionality|New API calls]]'' : GetPanel and GetPanelName, SetSimSpeed and GetBackgroundColour

[[String_Manipulation_Functions|New String Functions routines]]'' : Contains$, SplitString$, ExplodeToIntArray$, ImplodeFromIntArray$, ExplodeToFloatArray$, ImplodeFromFloatArray$, Int2FormattedString$, Float2FormattedString$, InsertString$, RemoveFromString$, SearchAndReplace$

[[Mathematical_Functions|New Mathematical Functions]]'' : cosh, sinh, tanh, arraydims, arraysize, GetOriginalScale

=====Events=====
*There are some new events available

====Miscellaneous====

*TODO list - auto generated icon list based on icons containing TODO in the comment. For example. TODO this icon needs work or TODO this will need changing.

*''[[Auto_Documentation|Project Report improvements]]''

==Flowcode 9==

Here are some of the new features added in Flowcode 9. Please click on a feature to learn more about it.

===App Developer===
* '''[[App_Developer|Flowcode App Developer]]'''

A completely new piece of software - based on Flowcode - that allows you to create fantastic distributed control and data gathering systems with intuitive Human Machine interfaces for Windows PCs and tablets.

This comes with a suite of Application Programming Interfaces for low cost hardware including Arduino, Raspberry Pi, ESP32 and PIC which allows you to create powerful smart embedded + PC devices with Windows HMI displays that can be freely distributed.

===State Diagrams===
* '''[[State_diagrams|State diagrams]]'''

New graphical programming icons allows you to make use of this powerful programming paradigm.

Create new state machine projects or enhance your existing ones and mix and match with flow chart icons, C code, blocks etc.

===New ESP32 Toolchain===
* '''[[Compiler_Toolchains#ESP32_Toolchain|ESP32 toolchain]]'''

Flowcode now supports a range of new devices for this powerful 80MHz board level device with integrated TCP/IP stack, and Wi-fi.

This allows you to create great web-interconnected projects with this incredibly low cost hardware platform from Espressif semiconductors in China.

===Data flow programming===
* '''[[DSP|Data flow programming]]'''
Now you can use data flow programming icons in your projects. This is a really great programming technique for projects including communications systems and Digital Signal Processing.

===New Components===
* '''[[Components|New components]]'''
New components include new DSP components, new Mechatronics parts, Easy Internet Of Things components, more sensors, and new test injectors.
We have updated our forums and now have sections to post your projects for both App Developer and Embedded. There are already a few posted. Why not come and replicate these projects to learn some interesting new things?

===New Website===
* '''[https://flowcode.co.uk/ New website]'''

Flowcode now has its own web site.
Here, you can find more information on Flowcode Embedded, Flowcode App Developer, a new Wiki, and a host of new courses on developing advanced communications systems from Mobile phone technology to CAN bus technology in automotive.

==Flowcode 8==

===Features Added===

Here are some of the new features added in Flowcode 8. Please click on a feature to learn more about it.

* '''[[Code_Folding|Code Folding]]'''

* '''[[Icon_Grouping|Icon Grouping]]'''

* '''[[C_Code_Simulation|Simulating Custom C Code]]'''

* '''[[C_Code_to_Flowchart_Conversion|Custom C Code to Flowchart Conversion]]'''

* '''[[Code_Paradigms|Coding Paradigms - Flowchart, Blocks, Pseudocode, C Code]]'''

* '''[[Tab Tear Off - Multi Monitor Support]]'''

* '''[[Dynamic_Updates|Dynamic Updates]]'''

* '''[[Raspberry_Pi_Chip_Pack|Raspberry Pi Chip Pack]]'''

* '''[[E-blocks2_Auto_ID|E-blocks2 Auto ID]]'''

* '''[[Matrix_SCADA | Matrix SCADA]]'''

===Component changes and additions===

CAL components such as ADC, I2C, PWM, SPI and UART are now free to allow for more user-based component creation and library generation.

High-level components created by Matrix are still licensed under the various component feature packs.

We also have made a large selection of component, CAL and FCD updates.

====New components====

Some of the new components include:

*FAT Based GLCD Bitmap Drawer
*New sensor components
*Network abstraction component for TCP/IP and WIFI modules
*E-block specific categories
*Scenario simulation components and wiki based curriculum
*Graphical LCD Graph drawer
*Arduino style serial terminal - via the console
*Raspberry Pi specific - Console Text Generation, TCP/IP
*Raspberry Pi HDMI gLCD
*Modbus TCP - Master and Slave
*DAC MCP48x1
*HTS221
*ESP12S
*PCF8575
*SHT31 Humidity Sensor
*WAV Playback and Record
*RealSpeak
*Bluetooth RN4677
*Various new Grove sensors
*HBridge CAL

====Component improvements====

*CAL components are more usable and stand alone, injector, scope and console functionality is now built in making it much easier to build into your own components
*Bitmap Drawer component - more bitmap file formats (Mono, 16-Colour, 256-Colour, 24-bit) and up to ten bitmaps per component
*Servo motor 16-bit mode
*PWM Frequency based Period and Prescaler calculator

==Flowcode 7==

===Performance improvements===
* Code Profiling - See which icons are 'hit' or 'missed', and the frequency of execution, to determine bugs/ redundancy in your code

* New 2 channel integrated oscilloscope, with triggering

* New template files for Microchip devices - get you up and running with your projects faster

===Visual enhancments===
* New modern UI with a choice of dark/ light themes

* Ability to colour code individual flowchart icons for ease of viewing, or select from pre-made colour schemes

* Create, save and load colour schemes for icons

* Overhaul of user interface

* 3D engine graphical improvements

===New Toolchain and Compilers===
* Support for 32bit PIC microcontrollers

* Support for Microchip XC8, XC16 and XC32 compilers.

* Significantly faster compilation of 8bit Microchip devices (approximately 10 times faster compilation than previous versions)

===Licensing structure===
* Flexible licensing structure - build a bespoke license exactly to your requirements

* License upgradable at any point to add new features

* Free version available - for a limited number of microcontrollers and feature set

===Mechanical Support Improvements===
* Users can now import 3D assemblies, rather than individual parts only.

* Support for industry standard file types; STEP and IGES

===Testing===
* Access readings and data from external instruments using DLL support. Display data with dashboard HMIs or third party software.

* Use our EB006 multiprogrammer, EB091 or Flowkit v2 to monitor every pin on your PICmicro design, and monitor and interpret serial data I/O using Ghost Technology.

==Flowcode 6==

===Component Creator===
* Now you can design your own electronic components and add them to your component library. You can use simulation API calls to define the electrical behaviour and mechanical behaviour in simulation.

* The component library has been expanded considerably to include many new electronic components and simulation components. Components can be designed and shared on our website.

* In addition to PCB style components you now have access to panel mounted switches, meters and displays for industrial control.

* Customise or create Dashboard components like graphs, dials and meters to allow you to monitor how your system is functioning in simulation and In-Circuit Test.

===Simulation===
* Improvements in simulation speed means that your simulation works close to real time which allows you to verify your design ‘live’.

* The powerful API allows control of simulation events and components providing a wide range of PC-side functions.

* Human Machine Interface components show your system parameters during simulation and In-Circuit-Test using intuitive displays including meters, graphs, oscillograms and tables.

* Use text based consoles to see data passing around your system: perfect for designing systems with digital communications.

===Mechanical Support===
* Import 3D models and characterise the movement and simulation using API.

* Use the system panel to design your own simple 3D model. View your design from different angles whilst it simulates.

* Create low cost parts with laser cutters and 3D printers and see the parts working with your electronics on-screen.

* Create simulations of your model which move in 3D space under electrical stimulus from a microcontroller and other components in your system. Use 2D dashboard controls to monitor your system in real time.

===Testing===
* Access readings and data from external instruments using DLL support. Display data with dashboard HMIs or third party software.

* Use our new EB006 multiprogrammer to monitor every pin on your PICmicro design, and monitor and interpret serial data I/O.

* Monitor how your system is functioning in simulation and In-Circuit-Test. Use new components like graphs, meters, consoles and scrolling text boxes to verify your design.

* Use Softscope and Consoles to see data in waveform or textual formats. Use the API to translate incoming data to hex or ASCII equivalent. Link Softscope and consoles to third party hardware using DLLs to create a full SCADA system.

API Overview

2026-07-23T14:53:49Z

SteveT:

<sidebar>API Contents</sidebar>
Flowcode provides an ''application programming interface'' to help writing simulation and PC-side programs.

This API is a list of macros built in to Flowcode with each group, or class, of macros dealing with a specific area of the system.

Use of this API is limited to simulation only - when downloaded to the chip these calls will be omitted, so if need be they can be interleaved in downloadable code.

Below is a reference to the classes available.
A complete list of [[Simulation Functionality|classes and macros]] is also available.
{| class="wikitable" width="85%"
|-
! width="45%" | Class path
! width="55%" | Description
|-
| [[API Component|Component]]
| Component traversal functions
|-
| [[API Component.Property|Component.Property]]
| Property manipulation functions
|-
| [[API Panel|Panel]]
| Panel object manipulations
|-
| [[API Panel.Position|Panel.Position]]
| Coordinate manipulation functions
|-
| [[API Panel.Position.Math|Panel.Position.Math]]
| Coordinate maths functions
|-
| [[API Panel.Position.Camera|Panel.Position.Camera]]
| Camera positioning
|-
| [[API Panel.PCloud|Panel.PCloud]]
| Point cloud manipulation
|-
| [[API Panel.LinkBar|Panel.LinkBar]]
| Position linkage management
|-
| [[API Panel.Collision|Panel.Collision]]
| Collision detection functions
|-
| [[API Panel.Graphics|Panel.Graphics]]
| Direct drawing routines for a single frame
|-
| [[API Panel.Graphics.Shape|Panel.Graphics.Shape]]
| Routines to change the last drawn shape
|-
| [[API Mouse|Mouse]]
| Mouse reading interface
|-
| [[API FCD|FCD]]
| Flowcode Chip Definition reading routines
|-
| [[API Sound|Sound]]
| Audio streaming interface
|-
| [[API Scope|Scope]]
| Data scope additions
|-
| [[API Console|Console]]
| Text console additions
|-
| [[API Connection|Connection]]
| Analog and digital connections
|-
| [[API Expand|Expand]]
| Various variable and code expansion routines
|-
| [[API Tree|Tree]]
| Data-tree traversal type routines
|-
| [[API File|File]]
| File reading and writing operations
|-
| [[API File.Buffer|File.Buffer]]
| Reads writes and monitors circular buffers
|-
| [[API File.NVM|File.NVM]]
| Reads from a file as though a block of NVM
|-
| [[API Time|Time]]
| Helps read and manage clock counters
|-
| [[API Language|Language]]
| Foreign language support
|-
| [[API System|System]]
| General system operations
|-
| [[API Debug|Debug]]
| Debug and diangostic
|}

Auto Documentation

2026-07-23T14:53:21Z

SteveT:

Simulation Macro Icon Properties

2026-07-23T14:42:55Z

SteveT: Updated API link

[[File:IconBuiltinFunction.png|border]]

Simulation-only macros for advanced Flowcode use such as component creation.

==Old Versions==
This page is current for Flowcode v9 and later. Earlier versions can be found below:
{| class="wikitable"
|+
|-
| [[Special:PermanentLink/11926|Flowcode v8]]
|}

==Details==
{| style="margin:0px; text-align:center;"
|-
|[[File:IconBuiltinFunction.png|border]]
| width="50px" |→
|[[File:Gen_Simulation_Macro_Flowchart_Icon_01.png]]
|width="50px" |→
|[[File:Properties_ApiMacro.png]]
|}

Built-in functions (sometimes called API or Simulation Macros) consist of a wide range of [[Simulation_Functionality|Simulation Functions]] that provide enhanced features for software simulation of your Flowcode project. This means that no code is produced when a project is built (with the exception of a few Web Developer functions).

These internal functions are used to produce advanced systems on software to accurately replicate and simulate existing systems and even demonstrate new concepts by creating simulation-only programs to test the capabilities of potential systems. They are used mainly in the creation of Flowcode components and are rarely suitable for general Flowcode projects.

'''Adding a call to a Built-in Function'''

The functions are listed under various categories. Expand each category to manually locate the required function, or right-click near the top of the list and select "Search" to enter a search term.

Select the macro and fill in the parameters required and select a return value if required.

'''Parameters'''

If the device macro requires any parameters then these can be entered in this field. Each can be a literal value or an existing variable. Clicking on the down arrow [[File:Btn_Arrow.png]] brings up the variables dialog window allowing you to select an existing variable or to [[Creating Variables|create a new one]].

The parameter details will list the parameter type. Parameters must be of a compatible type to be accepted.

Note that a full set of parameters must be provided.

'''Return value'''

If the device macro returns a value then you can assign that value to an existing variable for use later in the flowchart. If the function returns a value but you do not wish to retrieve it then leave this field empty.

The [[Variable Types|variable type]] of the return value will be listed. A variable of compatible type must be used to accept the return value.

==Macro types==
Macros are 3 types of macro that can be called using this command icon:

{| class="wikitable"
|+
|-
| [[Macro_Icon_Properties|Macros]]
| Macros designed and created by the user that are created as part of this project.
|-
| [[Component_Macro_Icon_Properties|Components]]
| Pre-defined macros supplied with the components. Only components that have been added to this project are available.
|-
| [[Simulation_Macro_Icon_Properties|Built-in Functions]]
| Simulation-only macros for advanced Flowcode use such as component creation.
|}

==Video==

Watch the [http://www.youtube.com/watch?v=LSz0p0NqMBw&list=PLQDWBb7bxuCgg6aJgPJcfXBMzZdLILceQ Download and Simulation code] video for a demonstration, example and explanation of downloadable and simulation only code and the difference between the two.

See the [http://www.youtube.com/watch?v=B_tOeSTeAbw&list=PLQDWBb7bxuCgg6aJgPJcfXBMzZdLILceQ Simulation Icon] video for information on the simulation functions available, the video highlights how they are organised and presented and how they can be used.

{| style="margin:auto;"
|-
|{{#ev:youtube|LSz0p0NqMBw}}
| width="100px" |
|{{#ev:youtube|B_tOeSTeAbw}}
|}

Object Scale

2026-07-23T14:41:32Z

SteveT: /* Flowcodes representation of scale */

This article refers to the representation of an object drawn on either the [[2d_Panels|2D panels]] or the [[System_Panel|3D system panel]]. It is aimed at readers who are looking to program components which require a degree of movement on the panel. For most uses of Flowcode ''world space'' is all that is required.

__NOTOC__
==Flowcodes representation of scale==

Flowcode represents an objects [[Object Position|position]] in terms of [[Object Coordinates|coordinates]], '''scale''' and [[Object Rotation|rotation]].

Internally an objects scale is kept as a ''scale factor'' in the X, Y and Z axis of the object. When accessing the [[Simulation_Functionality|SIM API]] this is the value that is altered, and relates to the diagonal of a transform matrix:

::[[File:Eg Object Scale.png]]

This is a transformation applied to the object which alters the size of it, and when rendered on the panel of all its child objects.

All API functions deal with this scale - this is mainly because the calculations involved in converting to other representations and back every time scale needs to be set would slow the programs down, but also because conversion to other representations can result in rounding errors and inaccuracies when combined with rotation.

== Scale vs Size==
For all its internal maths, Flowcode deals with ''scale''.

However, there are a number of representations of the size of an object, and this can cause confusion.

Imagine all objects start off with a size of 1x1x1 (a unit box). The ''scale'' of any object can be thought of as its ''magnification'' from this unit.

For example, take a marble. If it starts off at 1x1x1, the size of the marble is also its scale (magnification) from this starting point. Double the scale and you will double the ''size'' of the marble. In this case, the terms '''size''' and '''scale''' are interchangeable - they mean exactly the same thing. All objects in Flowcode have a base size of 1x1x1.
{|
|-
| [[File:Eg Marble.png|thumb|none|Marble at unit scale|50px]]
| [[File:Eg Marble.png|thumb|none|Marble at double scale|100px]]
|}

===Local size===
OK, so if they are the same, why do we need them both? This relationship holds OK for the marble, but now imagine you have a handful of marbles and you put them all in a bag.

The '''scale''' of the bag (its magnification) is 1:1. But its '''size''' is dependant on the number and size of the marbles inside it. In the case of the bag, size and scale are ''not'' the same. We refer to the size of the bag when considering everything inside it as its ''local size''.
{|
|-
| [[File:Eg Marblebag.png|thumb|none|Marble bag at unit scale|100px]]
| [[File:Eg Marblebag.png|thumb|none|Marble bag at double scale|200px]]
|}

===World size===
Now, it is worth noting that although doubling the scale of the bag will appear to us to double the size of all the marbles in it, in relation to each other they are still the same. Following the definition of ''local size'' above (so consider the scale of the marble and everything in it) none of the marbles sizes have changed.

This is clearly not true from our point of view. We see things in ''world size'', so doubling the scale of the bag doubles the size of everything in it. That is, the ''world size'' of the object considers not only the scale of an object and everything inside it, but also the scale of ''everything it is in''. Double the scale of the bag and you double the ''world size'' of the marbles ''and'' the bag.

===When do we use size and when do we use scale?===
There are no hard and fast rules, but usually we will use ''world size'' when positioning and measuring objects on the [[System_Panel|panels]] as this is easier for us to visualise, and use ''scale'' when dealing with the maths behind a component as this is the 'raw' value used by the system. We may use the ''local size'' of an object when calculating its size in relation to other objects in the same group (so we can position one marble next to another without worrying about the scale of the bag).

== Scale and rotation ==
Flowcode applies rotation before scale to an object. This means that rotating an object 90 degrees in X will make it appear that the height and depth of the object have ''switched''. This is not the case, however, as this rotation will essentially cause the object to be lying on its side, with its Z axis parallel with the ground. Changing the Z scale will therefore affect what the viewer perceives as the Y.
{|
|-
| [[File:Eg Object Scale Rotate 01.svg|thumb|150px|Object before rotation]]
| [[File:Eg Object Scale Rotate 02.svg|thumb|150px|Object after rotation]]
|}

=== Local and world space ==={{main|Local and World Space}}
When working with objects in the flowchart, local coordinates are always preferred over world coordinates. This is so that scaling an objects parent does not affect the 'coordinate space' of the program - moving to coordinates (1, 2, 3) will always move to the same point in the component, despite the users scaling of the component, which is out of the component authors control.

It is very difficult to program an object to behave as expected in all circumstances using the world position.

To calculate the world '''size''' from an objects local scale, this must be multiplied by the scales of all the objects children and parents in the [[Component Tree]].

Handles

2026-07-23T14:39:45Z

SteveT: Replaced link to API

An object handle is used to reference a more complicated piece of data (such as a file, Flowcode component or block of text) whose internal format is not known. Flowcode provides many [[Simulation_Functionality|simulation macros]] that use handles to easily pass data around.

In an embedded context, a handle can be thought of as a pointer to memory, except Flowcode manages the handles so referencing a non-existent handle will not cause any fatal errors.

A handle value of zero is considered ''null'' and invalid to Flowcode.

The handle [[Variable_Types|variable type]] can be used with the tree [[Simulation_Functionality|simulation macros]] to allow things like stepping through the [[Component_Tree|component tree]].

File:Fc9-type-18-icon.png

2026-07-13T16:38:55Z

SteveT: SteveT uploaded a new version of File:Fc9-type-18-icon.png

File:Fc9-type-15-icon.png

2026-07-13T16:38:11Z

SteveT: SteveT uploaded a new version of File:Fc9-type-15-icon.png

File:Fc9-type-12-icon.png

2026-07-13T16:37:26Z

SteveT: SteveT uploaded a new version of File:Fc9-type-12-icon.png

File:Fc9-type-4-icon.png

2026-07-13T16:36:15Z

SteveT: SteveT uploaded a new version of File:Fc9-type-4-icon.png

File:Fc9-type-3-icon.png

2026-07-13T16:35:27Z

SteveT: SteveT uploaded a new version of File:Fc9-type-3-icon.png

File:Fc9-type-20-icon.png

2026-07-13T16:34:50Z

SteveT: SteveT uploaded a new version of File:Fc9-type-20-icon.png

File:Fc9-type-22-icon.png

2026-07-13T16:34:06Z

SteveT: SteveT uploaded a new version of File:Fc9-type-22-icon.png

File:Fc9-type-23-icon.png

2026-07-13T16:33:18Z

SteveT: SteveT uploaded a new version of File:Fc9-type-23-icon.png

File:Fc9-type-24-icon.png

2026-07-13T16:31:23Z

SteveT: SteveT uploaded a new version of File:Fc9-type-24-icon.png

File:Fc9-type-17-icon.png

2026-07-13T16:29:05Z

SteveT: SteveT uploaded a new version of File:Fc9-type-17-icon.png

File:Fc9-type-21-icon.png

2026-07-13T16:27:42Z

SteveT: SteveT uploaded a new version of File:Fc9-type-21-icon.png

File:Fc9-type-13-icon.png

2026-07-13T16:26:34Z

SteveT: SteveT uploaded a new version of File:Fc9-type-13-icon.png

File:Fc9-type-8-icon.png

2026-07-13T16:25:49Z

SteveT: SteveT uploaded a new version of File:Fc9-type-8-icon.png

File:Fc9-type-2-icon.png

2026-07-13T16:24:40Z

SteveT: SteveT uploaded a new version of File:Fc9-type-2-icon.png

File:Fc9-type-1-icon.png

2026-07-13T16:23:32Z

SteveT: SteveT uploaded a new version of File:Fc9-type-1-icon.png

File:Fc9-type-11-icon.png

2026-07-13T16:22:25Z

SteveT: SteveT uploaded a new version of File:Fc9-type-11-icon.png

File:Fc9-type-19-icon.png

2026-07-13T16:21:34Z

SteveT: SteveT uploaded a new version of File:Fc9-type-19-icon.png

File:Fc9-type-6-icon.png

2026-07-13T16:20:15Z

SteveT: SteveT uploaded a new version of File:Fc9-type-6-icon.png

File:Fc9-type-5-icon.png

2026-07-13T16:18:33Z

SteveT: SteveT uploaded a new version of File:Fc9-type-5-icon.png

File:Fc9-type-7-icon.png

2026-07-13T16:17:06Z

SteveT: SteveT uploaded a new version of File:Fc9-type-7-icon.png

File:Fc9-type-10-icon.png

2026-07-13T16:15:49Z

SteveT: SteveT uploaded a new version of File:Fc9-type-10-icon.png

File:Fc9-type-14-icon.png

2026-07-13T16:14:50Z

SteveT: SteveT uploaded a new version of File:Fc9-type-14-icon.png

File:Fc9-type-16-icon.png

2026-07-13T16:10:50Z

SteveT: SteveT uploaded a new version of File:Fc9-type-16-icon.png