API Overview - Revision history

SteveT at 16:12, 23 July 2026

2026-07-23T16:12:44Z

← Older revision		Revision as of 16:12, 23 July 2026
Line 1:		Line 1:
	Flowcode provides an ''application programming interface'' to help writing simulation and PC-side programs.		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.		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.		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]].		A reference to the classes and macros available can be found [[Simulation_Functionality#Built-in_functions\|here]].

SteveT at 16:09, 23 July 2026

2026-07-23T16:09:44Z

← Older revision		Revision as of 16:09, 23 July 2026
Line 5:		Line 5:
	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.		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~~\|here]].		A reference to the classes and macros available can be found [[Simulation_Functionality#Built-in_functions\|here]].

SteveT at 15:58, 23 July 2026

2026-07-23T15:58:41Z

← Older revision		Revision as of 15:58, 23 July 2026
Line 5:		Line 5:
	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.		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 reference to the classes and macros available can be found [[Simulation Functionality\|here]].
	~~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~~
	\|}

SteveT at 15:04, 23 July 2026

2026-07-23T15:04:43Z

← Older revision		Revision as of 15:04, 23 July 2026
Line 1:		Line 1:
	~~<sidebar>API Contents</sidebar>~~
	Flowcode provides an ''application programming interface'' to help writing simulation and PC-side programs.		Flowcode provides an ''application programming interface'' to help writing simulation and PC-side programs.

Line 48:		Line 47:
	\| [[API Mouse\|Mouse]]		\| [[API Mouse\|Mouse]]
	\| Mouse reading interface		\| Mouse reading interface
			\|-
			\| [[API Keyboard\|Keyboard]]
			\| Keyboard reading interface
	\|-		\|-
	\| [[API FCD\|FCD]]		\| [[API FCD\|FCD]]
Line 55:		Line 57:
	\| Audio streaming interface		\| Audio streaming interface
	\|-		\|-
	\| [[API Scope\|~~Scope~~]]		\| [[API Scope\|DataRecorder]]
	\| Data scope additions		\| Data scope additions
			\|-
			\| [[API Calculations\|Calculations]]
			\| Miscellaneous calculations
	\|-		\|-
	\| [[API Console\|Console]]		\| [[API Console\|Console]]
Line 78:		Line 83:
	\| [[API File.NVM\|File.NVM]]		\| [[API File.NVM\|File.NVM]]
	\| Reads from a file as though a block of NVM		\| Reads from a file as though a block of NVM
			\|-
			\| [[API UI\|UI]]
			\| Display message boxes and alerts
	\|-		\|-
	\| [[API Time\|Time]]		\| [[API Time\|Time]]
	\| Helps read and manage clock counters		\| Helps read and manage clock counters
	\|-
	~~\| [[API Language\|Language]]~~
	~~\| Foreign language support~~
	\|-		\|-
	\| [[API System\|System]]		\| [[API System\|System]]
Line 89:		Line 94:
	\|-		\|-
	\| [[API Debug\|Debug]]		\| [[API Debug\|Debug]]
	\| Debug and ~~diangostic~~		\| Debug and diagnostic
	\|}		\|}

SteveT at 14:53, 23 July 2026

2026-07-23T14:53:49Z

← Older revision		Revision as of 14:53, 23 July 2026
Line 7:		Line 7:

	Below is a reference to the classes available.		Below is a reference to the classes available.
	A complete list of [[~~API Reference~~\|classes and macros]] is also available.		A complete list of [[Simulation Functionality\|classes and macros]] is also available.
	{\| class="wikitable" width="85%"		{\| class="wikitable" width="85%"
	\|-		\|-

JonnyW: XML import

2014-01-16T15:57:49Z

XML import

← Older revision		Revision as of 15:57, 16 January 2014
Line 1:		Line 1:


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

JonnyW: XML import for latest API

2013-11-12T16:15:31Z

XML import for latest API

← Older revision		Revision as of 16:15, 12 November 2013
Line 80:		Line 80:
	\| [[API File.NVM\|File.NVM]]		\| [[API File.NVM\|File.NVM]]
	\| Reads from a file as though a block of NVM		\| Reads from a file as though a block of NVM
			\|-
			\| [[API Time\|Time]]
			\| Helps read and manage clock counters
	\|-		\|-
	\| [[API Language\|Language]]		\| [[API Language\|Language]]

JonnyW: XML import of API documentation

2013-08-09T14:27:49Z

XML import of API documentation

New page

<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 [[API Reference|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 Language|Language]]
| Foreign language support
|-
| [[API System|System]]
| General system operations
|-
| [[API Debug|Debug]]
| Debug and diangostic
|}

← Older revision		Revision as of 15:58, 23 July 2026
Line 5:		Line 5:
	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.		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 reference to the classes and macros available can be found [[Simulation Functionality\|here]].
	~~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~~
	\|}