Simulation Macro Icon Properties

From Flowcode Help
Revision as of 10:20, 12 June 2026 by SteveT (talk | contribs)
Jump to navigationJump to search

IconBuiltinFunction.png

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


Details

IconBuiltinFunction.png Gen Simulation Macro Flowchart Icon 01.png Properties ApiMacro.png


Built-in functions (sometimes called API or Simulation Macros) consist of a wide range of 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 Btn Arrow.png brings up the variables dialog window allowing you to select an existing variable or to 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 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:

Macros Macros designed and created by the user that are created as part of this project.
Components Pre-defined macros supplied with the components. Only components that have been added to this project are available.
Built-in Functions Simulation-only macros for advanced Flowcode use such as component creation.


Video

Watch the 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 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.

LSz0p0NqMBw}} B_tOeSTeAbw}}