Difference between revisions of "Simulation Functionality"
From Flowcode Help
Jump to navigationJump to searchLine 11: | Line 11: | ||
| colspan="3" align="center" style="background-color:#EAE1EA;" | Property | | colspan="3" align="center" style="background-color:#EAE1EA;" | Property | ||
|- | |- | ||
− | | style="background-color:#f8e8ff;" | Gets the value of a property as a string | + | | style="background-color:#f8e8ff;" | Gets the value of a property as a string |
− | | style="background-color:#f8e8ff;" | Sets a components 'color' property as a R,G,B value | + | |- |
− | | style="background-color:#f8e8ff;" | Sets a components property as a string | + | | style="background-color:#f8e8ff;" | Sets a components 'color' property as a R,G,B value |
− | | style="background-color:#f8e8ff;" | Copies a property value from one target to another | + | |- |
− | | style="background-color:#f8e8ff;" | Sets all child components property as a string | + | | style="background-color:#f8e8ff;" | Sets a components property as a string |
− | | style="background-color:#f8e8ff;" | Copies the values of a properties children from the source to dest | + | |- |
− | | style="background-color:#f8e8ff;" | Sets whether the property is visible or not | + | | style="background-color:#f8e8ff;" | Copies a property value from one target to another |
− | | style="background-color:#f8e8ff;" | Sets whether the property can be edited in the UI or not | + | |- |
− | | style="background-color:#f8e8ff;" | Gets whether the property is visible or not | + | | style="background-color:#f8e8ff;" | Sets all child components property as a string |
− | | style="background-color:#f8e8ff;" | Gets whether the property can be edited in the UI or not | + | |- |
− | | style="background-color:#f8e8ff;" | Gets a components property filter string for lists, files, etc | + | | style="background-color:#f8e8ff;" | Copies the values of a properties children from the source to dest |
− | | style="background-color:#f8e8ff;" | Sets a components property filter string for lists, files, etc | + | |- |
− | | style="background-color:#f8e8ff;" | Copies a property filter from one target to another | + | | style="background-color:#f8e8ff;" | Sets whether the property is visible or not |
− | | style="background-color:#f8e8ff;" | Gets a single lists index value from a property by line number | + | |- |
− | | style="background-color:#f8e8ff;" | Gets a single list entry from a property by named index | + | | style="background-color:#f8e8ff;" | Sets whether the property can be edited in the UI or not |
− | | style="background-color:#f8e8ff;" | Sets an existing list entries text for the property by named index | + | |- |
− | | style="background-color:#f8e8ff;" | Alters or appends a list entries text for the property by named index | + | | style="background-color:#f8e8ff;" | Gets whether the property is visible or not |
− | | style="background-color:#f8e8ff;" | Returns the id of the panel hosting the component | + | |- |
− | | style="background-color:#f8e8ff;" | Sets whether a component can interact with the mouse | + | | style="background-color:#f8e8ff;" | Gets whether the property can be edited in the UI or not |
− | | style="background-color:#f8e8ff;" | Gets whether a component can interact with the mouse | + | |- |
− | | style="background-color:#f8e8ff;" | Sets whether a component can be seen on the panel | + | | style="background-color:#f8e8ff;" | Gets a components property filter string for lists, files, etc |
− | | style="background-color:#f8e8ff;" | Gets whether a component can be seen on the panel | + | |- |
− | | style="background-color:#f8e8ff;" | Sets whether a component is checked in collision detections | + | | style="background-color:#f8e8ff;" | Sets a components property filter string for lists, files, etc |
− | | style="background-color:#f8e8ff;" | Gets whether a component is checked in collision detections | + | |- |
− | | style="background-color:#f8e8ff;" | Sets whether a component is considered for compilation or not | + | | style="background-color:#f8e8ff;" | Copies a property filter from one target to another |
− | | style="background-color:#f8e8ff;" | Gets whether a component will be compiled or not | + | |- |
− | | style="background-color:#f8e8ff;" | Gets the type-instance of the component, >= 1 is valid | + | | style="background-color:#f8e8ff;" | Gets a single lists index value from a property by line number |
− | | style="background-color:#f8e8ff;" | Finds a named object that is part of the component | + | |- |
− | | style="background-color:#f8e8ff;" | Gets the root component handle | + | | style="background-color:#f8e8ff;" | Gets a single list entry from a property by named index |
− | | style="background-color:#f8e8ff;" | Gets the top-level owner of the component | + | |- |
− | | style="background-color:#f8e8ff;" | Gets the owner of the component | + | | style="background-color:#f8e8ff;" | Sets an existing list entries text for the property by named index |
− | | style="background-color:#f8e8ff;" | Gets the next (younger) sibling of the components handle | + | |- |
− | | style="background-color:#f8e8ff;" | Gets the previous (elder) sibling of the components handle | + | | style="background-color:#f8e8ff;" | Alters or appends a list entries text for the property by named index |
− | | style="background-color:#f8e8ff;" | Gets the first (eldest) child of the component | + | |- |
− | | style="background-color:#f8e8ff;" | Gets the last (youngest) child of the component | + | | style="background-color:#f8e8ff;" | Returns the id of the panel hosting the component |
− | | style="background-color:#f8e8ff;" | Gets the original definition of the component, returns Current if no original copy | + | |- |
− | | style="background-color:#f8e8ff;" | Clones an existing object to another position on the panel | + | | style="background-color:#f8e8ff;" | Sets whether a component can interact with the mouse |
− | | style="background-color:#f8e8ff;" | Deletes an existing object, removing it from the panel | + | |- |
+ | | style="background-color:#f8e8ff;" | Gets whether a component can interact with the mouse | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Sets whether a component can be seen on the panel | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Gets whether a component can be seen on the panel | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Sets whether a component is checked in collision detections | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Gets whether a component is checked in collision detections | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Sets whether a component is considered for compilation or not | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Gets whether a component will be compiled or not | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Gets the type-instance of the component, >= 1 is valid | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Finds a named object that is part of the component | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Gets the root component handle | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Gets the top-level owner of the component | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Gets the owner of the component | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Gets the next (younger) sibling of the components handle | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Gets the previous (elder) sibling of the components handle | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Gets the first (eldest) child of the component | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Gets the last (youngest) child of the component | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Gets the original definition of the component, returns Current if no original copy | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Clones an existing object to another position on the panel | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Deletes an existing object, removing it from the panel | ||
+ | |- | ||
|} | |} | ||
Line 57: | Line 95: | ||
{| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
− | | style="background-color:#f8e8ff;" | Returns the name of the panel from the id | + | | style="background-color:#f8e8ff;" | Returns the name of the panel from the id |
− | | style="background-color:#f8e8ff;" | Returns the main background colour of the panel | + | |- |
− | | style="background-color:#f8e8ff;" | Gets the number of 2d panels | + | | style="background-color:#f8e8ff;" | Returns the main background colour of the panel |
− | | style="background-color:#f8e8ff;" | Creates a new 2d panel | + | |- |
− | | style="background-color:#f8e8ff;" | Adds a new component to a panel | + | | style="background-color:#f8e8ff;" | Gets the number of 2d panels |
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Creates a new 2d panel | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Adds a new component to a panel | ||
+ | |- | ||
| colspan="3" align="center" style="background-color:#EAE1EA;" | Position | | colspan="3" align="center" style="background-color:#EAE1EA;" | Position | ||
|- | |- | ||
− | | style="background-color:#f8e8ff;" | Returns the positions coordinates in (X,Y,Z) array | + | | style="background-color:#f8e8ff;" | Returns the positions coordinates in (X,Y,Z) array |
− | | style="background-color:#f8e8ff;" | Returns the component size in (X,Y,Z) array | + | |- |
− | | style="background-color:#f8e8ff;" | Moves the object to the given coordinates in World coordinates | + | | style="background-color:#f8e8ff;" | Returns the component size in (X,Y,Z) array |
− | | style="background-color:#f8e8ff;" | Sets the objects size to a value | + | |- |
− | | style="background-color:#f8e8ff;" | Gets a handle to an object representing the components current position | + | | style="background-color:#f8e8ff;" | Moves the object to the given coordinates in World coordinates |
− | | style="background-color:#f8e8ff;" | Gets a handle to an empty position | + | |- |
− | | style="background-color:#f8e8ff;" | Sets an objects position based on a component or pre-defined position | + | | style="background-color:#f8e8ff;" | Sets the objects size to a value |
− | | style="background-color:#f8e8ff;" | Sets an objects coordinates based on a position | + | |- |
− | | style="background-color:#f8e8ff;" | Sets an objects scale based on a position | + | | style="background-color:#f8e8ff;" | Gets a handle to an object representing the components current position |
− | | style="background-color:#f8e8ff;" | Sets an objects orientation based on a position | + | |- |
− | | style="background-color:#f8e8ff;" | Gets a handle to an object representing the components bounding box position | + | | style="background-color:#f8e8ff;" | Gets a handle to an empty position |
− | | style="background-color:#f8e8ff;" | Returns the position of a line's nodes as a comma-separated list | + | |- |
− | | style="background-color:#f8e8ff;" | Sets the nodes of a line | + | | style="background-color:#f8e8ff;" | Sets an objects position based on a component or pre-defined position |
− | | style="background-color:#f8e8ff;" | Blends positions from two sources to a destination | + | |- |
− | | style="background-color:#f8e8ff;" | Blends positions from two sources to a destination over time | + | | style="background-color:#f8e8ff;" | Sets an objects coordinates based on a position |
− | | style="background-color:#f8e8ff;" | Stops all animations started by this component | + | |- |
− | | style="background-color:#f8e8ff;" | Moves the object by the given offset relative to its parent along an axis | + | | style="background-color:#f8e8ff;" | Sets an objects scale based on a position |
− | | style="background-color:#f8e8ff;" | Moves the object by the given offset relative to its parent | + | |- |
− | | style="background-color:#f8e8ff;" | Moves the object to the given coordinates relative to its parent | + | | style="background-color:#f8e8ff;" | Sets an objects orientation based on a position |
− | | style="background-color:#f8e8ff;" | Sets the objects scale to a value | + | |- |
− | | style="background-color:#f8e8ff;" | Multiplies the objects scale by a value | + | | style="background-color:#f8e8ff;" | Gets a handle to an object representing the components bounding box position |
− | | style="background-color:#f8e8ff;" | Divides the objects scale by a value | + | |- |
− | | style="background-color:#f8e8ff;" | Rotates the object to the given rotation | + | | style="background-color:#f8e8ff;" | Returns the position of a line's nodes as a comma-separated list |
− | | style="background-color:#f8e8ff;" | Rotates the object by the given rotation along an axis | + | |- |
− | | style="background-color:#f8e8ff;" | Rotates the object around the X axis | + | | style="background-color:#f8e8ff;" | Sets the nodes of a line |
− | | style="background-color:#f8e8ff;" | Rotates the object around the Y axis | + | |- |
− | | style="background-color:#f8e8ff;" | Rotates the object around the Z axis | + | | style="background-color:#f8e8ff;" | Blends positions from two sources to a destination |
− | | style="background-color:#f8e8ff;" | Returns the positions coordinates in (X,Y,Z) array | + | |- |
− | | style="background-color:#f8e8ff;" | Returns the positions scale in (X,Y,Z) array | + | | style="background-color:#f8e8ff;" | Blends positions from two sources to a destination over time |
− | | style="background-color:#f8e8ff;" | Returns the positions quaternion in (X,Y,Z,W) array | + | |- |
− | | style="background-color:#f8e8ff;" | Returns the positions euler angles in (P,Y,R) array | + | | style="background-color:#f8e8ff;" | Stops all animations started by this component |
− | | style="background-color:#f8e8ff;" | Coordinate maths functions | + | |- |
− | | style="background-color:#f8e8ff;" | 2D Panel functions | + | | style="background-color:#f8e8ff;" | Moves the object by the given offset relative to its parent along an axis |
− | | style="background-color:#f8e8ff;" | Camera positioning for 3D panel | + | |- |
+ | | style="background-color:#f8e8ff;" | Moves the object by the given offset relative to its parent | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Moves the object to the given coordinates relative to its parent | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Sets the objects scale to a value | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Multiplies the objects scale by a value | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Divides the objects scale by a value | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Rotates the object to the given rotation | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Rotates the object by the given rotation along an axis | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Rotates the object around the X axis | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Rotates the object around the Y axis | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Rotates the object around the Z axis | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Returns the positions coordinates in (X,Y,Z) array | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Returns the positions scale in (X,Y,Z) array | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Returns the positions quaternion in (X,Y,Z,W) array | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Returns the positions euler angles in (P,Y,R) array | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Coordinate maths functions | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | 2D Panel functions | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Camera positioning for 3D panel | ||
+ | |- | ||
| colspan="3" align="center" style="background-color:#EAE1EA;" | PCloud | | colspan="3" align="center" style="background-color:#EAE1EA;" | PCloud | ||
|- | |- | ||
− | | style="background-color:#f8e8ff;" | Creates a new point cloud tied to a position handle | + | | style="background-color:#f8e8ff;" | Creates a new point cloud tied to a position handle |
− | | style="background-color:#f8e8ff;" | Sets whether the point cloud is displayed or not | + | |- |
− | | style="background-color:#f8e8ff;" | Sets the position for the point cloud to be located at | + | | style="background-color:#f8e8ff;" | Sets whether the point cloud is displayed or not |
− | | style="background-color:#f8e8ff;" | Gets the position the point cloud is located at | + | |- |
− | | style="background-color:#f8e8ff;" | Sets the X,Y,Z point lists | + | | style="background-color:#f8e8ff;" | Sets the position for the point cloud to be located at |
− | | style="background-color:#f8e8ff;" | Sets the X,Y,Z point lists | + | |- |
− | | style="background-color:#f8e8ff;" | Sets the X,Y,Z point lists in a height-map grid | + | | style="background-color:#f8e8ff;" | Gets the position the point cloud is located at |
− | | style="background-color:#f8e8ff;" | Sets the X,Y,Z point lists in a height-map grid | + | |- |
− | | style="background-color:#f8e8ff;" | Sets the X,Y,Z point lists in a flat height-map grid | + | | style="background-color:#f8e8ff;" | Sets the X,Y,Z point lists |
− | | style="background-color:#f8e8ff;" | Given an XY on the grid, sets the vertex value at that point | + | |- |
− | | style="background-color:#f8e8ff;" | Creates a unit scaled axis (X, Y or Z) with a center of zero and a range of two | + | | style="background-color:#f8e8ff;" | Sets the X,Y,Z point lists |
− | | style="background-color:#f8e8ff;" | Sets the RGB colour of the entire cloud | + | |- |
− | | style="background-color:#f8e8ff;" | Sets the RGB colour of the individual points in the cloud | + | | style="background-color:#f8e8ff;" | Sets the X,Y,Z point lists in a height-map grid |
− | | style="background-color:#f8e8ff;" | Given an XY on the grid, sets the vertex colour at that point | + | |- |
− | | style="background-color:#f8e8ff;" | Sets the rendering mode of the point cloud | + | | style="background-color:#f8e8ff;" | Sets the X,Y,Z point lists in a height-map grid |
− | | style="background-color:#f8e8ff;" | Enables or disables simple lighting for point mode, providing a normal passing through the point and (0,0,0) | + | |- |
− | | style="background-color:#f8e8ff;" | Manually refresh the screen the point cloud exists on | + | | style="background-color:#f8e8ff;" | Sets the X,Y,Z point lists in a flat height-map grid |
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Given an XY on the grid, sets the vertex value at that point | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Creates a unit scaled axis (X, Y or Z) with a center of zero and a range of two | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Sets the RGB colour of the entire cloud | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Sets the RGB colour of the individual points in the cloud | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Given an XY on the grid, sets the vertex colour at that point | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Sets the rendering mode of the point cloud | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Enables or disables simple lighting for point mode, providing a normal passing through the point and (0,0,0) | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Manually refresh the screen the point cloud exists on | ||
+ | |- | ||
| colspan="3" align="center" style="background-color:#EAE1EA;" | LinkBar | | colspan="3" align="center" style="background-color:#EAE1EA;" | LinkBar | ||
|- | |- | ||
− | | style="background-color:#f8e8ff;" | Creates a new bar linking a pair of position handles | + | | style="background-color:#f8e8ff;" | Creates a new bar linking a pair of position handles |
− | | style="background-color:#f8e8ff;" | Sets whether the link is displayed or not | + | |- |
− | | style="background-color:#f8e8ff;" | Sets the position for the start point of the bar | + | | style="background-color:#f8e8ff;" | Sets whether the link is displayed or not |
− | | style="background-color:#f8e8ff;" | Sets the position for the end point of the bar | + | |- |
− | | style="background-color:#f8e8ff;" | Sets the clipping adjustments for the beginning of the link | + | | style="background-color:#f8e8ff;" | Sets the position for the start point of the bar |
− | | style="background-color:#f8e8ff;" | Sets the clipping adjustments for the end of the link | + | |- |
− | | style="background-color:#f8e8ff;" | Sets the graphic for the start point of the bar | + | | style="background-color:#f8e8ff;" | Sets the position for the end point of the bar |
− | | style="background-color:#f8e8ff;" | Sets the graphic for the main line of the bar | + | |- |
− | | style="background-color:#f8e8ff;" | Sets the graphic for the end point of the bar | + | | style="background-color:#f8e8ff;" | Sets the clipping adjustments for the beginning of the link |
− | | style="background-color:#f8e8ff;" | Gets the position the bars start point is located at | + | |- |
− | | style="background-color:#f8e8ff;" | Gets the position the bar is located at | + | | style="background-color:#f8e8ff;" | Sets the clipping adjustments for the end of the link |
− | | style="background-color:#f8e8ff;" | Gets the position the bars end point is located at | + | |- |
− | | style="background-color:#f8e8ff;" | Manually refresh the screen the bar exists on | + | | style="background-color:#f8e8ff;" | Sets the graphic for the start point of the bar |
− | | style="background-color:#f8e8ff;" | Sets whether Flowcode should automatically draw links for component object property types | + | |- |
+ | | style="background-color:#f8e8ff;" | Sets the graphic for the main line of the bar | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Sets the graphic for the end point of the bar | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Gets the position the bars start point is located at | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Gets the position the bar is located at | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Gets the position the bars end point is located at | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Manually refresh the screen the bar exists on | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Sets whether Flowcode should automatically draw links for component object property types | ||
+ | |- | ||
| colspan="3" align="center" style="background-color:#EAE1EA;" | TextLabel | | colspan="3" align="center" style="background-color:#EAE1EA;" | TextLabel | ||
|- | |- | ||
− | | style="background-color:#f8e8ff;" | Creates a new text label that always faces the camera | + | | style="background-color:#f8e8ff;" | Creates a new text label that always faces the camera |
− | | style="background-color:#f8e8ff;" | Sets whether the label is displayed or not | + | |- |
− | | style="background-color:#f8e8ff;" | Sets the position for the point to draw the text at | + | | style="background-color:#f8e8ff;" | Sets whether the label is displayed or not |
− | | style="background-color:#f8e8ff;" | Sets the offset from the SetPos() position for the label | + | |- |
− | | style="background-color:#f8e8ff;" | Sets the text for the label | + | | style="background-color:#f8e8ff;" | Sets the position for the point to draw the text at |
− | | style="background-color:#f8e8ff;" | Sets the multipliers for the width and height of the label | + | |- |
− | | style="background-color:#f8e8ff;" | Sets the foreground and background colours for the label | + | | style="background-color:#f8e8ff;" | Sets the offset from the SetPos() position for the label |
− | | style="background-color:#f8e8ff;" | Sets whether to draw at a fixed size or to scale based on distance from the camera | + | |- |
− | | style="background-color:#f8e8ff;" | Gets the position the label is located at | + | | style="background-color:#f8e8ff;" | Sets the text for the label |
− | | style="background-color:#f8e8ff;" | Manually refresh the screen the label exists on | + | |- |
+ | | style="background-color:#f8e8ff;" | Sets the multipliers for the width and height of the label | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Sets the foreground and background colours for the label | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Sets whether to draw at a fixed size or to scale based on distance from the camera | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Gets the position the label is located at | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Manually refresh the screen the label exists on | ||
+ | |- | ||
| colspan="3" align="center" style="background-color:#EAE1EA;" | Collision | | colspan="3" align="center" style="background-color:#EAE1EA;" | Collision | ||
|- | |- | ||
− | | style="background-color:#f8e8ff;" | Tests whether an object collides with the table top, returns Z distance to move to rest on the table | + | | style="background-color:#f8e8ff;" | Tests whether an object collides with the table top, returns Z distance to move to rest on the table |
− | | style="background-color:#f8e8ff;" | Tests whether an object collides with a position | + | |- |
− | | style="background-color:#f8e8ff;" | Tests whether an object collides with a position | + | | style="background-color:#f8e8ff;" | Tests whether an object collides with a position |
− | | style="background-color:#f8e8ff;" | Returns the position to move Pos to so it does not collide with Test - null if no collide | + | |- |
− | | style="background-color:#f8e8ff;" | Tests whether an object collides with a position | + | | style="background-color:#f8e8ff;" | Tests whether an object collides with a position |
− | | style="background-color:#f8e8ff;" | Returns the position to move Pos to so it does not collide with any other object - null if no collide | + | |- |
+ | | style="background-color:#f8e8ff;" | Returns the position to move Pos to so it does not collide with Test - null if no collide | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Tests whether an object collides with a position | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Returns the position to move Pos to so it does not collide with any other object - null if no collide | ||
+ | |- | ||
| colspan="3" align="center" style="background-color:#EAE1EA;" | Graphics | | colspan="3" align="center" style="background-color:#EAE1EA;" | Graphics | ||
|- | |- | ||
− | | style="background-color:#f8e8ff;" | Sends a redraw request to the given component | + | | style="background-color:#f8e8ff;" | Sends a redraw request to the given component |
− | | style="background-color:#f8e8ff;" | Sets the draw colour for and subsequent graphics objects | + | |- |
− | | style="background-color:#f8e8ff;" | Sets the draw colour for and subsequent graphics objects | + | | style="background-color:#f8e8ff;" | Sets the draw colour for and subsequent graphics objects |
− | | style="background-color:#f8e8ff;" | Sets the text font for subsequent text objects | + | |- |
− | | style="background-color:#f8e8ff;" | Sets the text scale for subsequent text objects | + | | style="background-color:#f8e8ff;" | Sets the draw colour for and subsequent graphics objects |
− | | style="background-color:#f8e8ff;" | Sets the thinkness when drawing lines and points | + | |- |
− | | style="background-color:#f8e8ff;" | Creates a drawing area on a shape | + | | style="background-color:#f8e8ff;" | Sets the text font for subsequent text objects |
− | | style="background-color:#f8e8ff;" | Begins drawing on a given shape | + | |- |
− | | style="background-color:#f8e8ff;" | Ends drawing started with DrawBegin() | + | | style="background-color:#f8e8ff;" | Sets the text scale for subsequent text objects |
− | | style="background-color:#f8e8ff;" | Deletes a drawing area for a shape | + | |- |
− | | style="background-color:#f8e8ff;" | Draws a line of text texture | + | | style="background-color:#f8e8ff;" | Sets the thinkness when drawing lines and points |
− | | style="background-color:#f8e8ff;" | Draws a point on a texture | + | |- |
− | | style="background-color:#f8e8ff;" | Draws a line on a texture | + | | style="background-color:#f8e8ff;" | Creates a drawing area on a shape |
− | | style="background-color:#f8e8ff;" | Draws a smooth line on a texture | + | |- |
− | | style="background-color:#f8e8ff;" | Draws a rectangle on a texture | + | | style="background-color:#f8e8ff;" | Begins drawing on a given shape |
− | | style="background-color:#f8e8ff;" | Draws a circle on a texture | + | |- |
− | | style="background-color:#f8e8ff;" | Clear texture to the given component | + | | style="background-color:#f8e8ff;" | Ends drawing started with DrawBegin() |
− | | style="background-color:#f8e8ff;" | Routines to change the last drawn shape | + | |- |
+ | | style="background-color:#f8e8ff;" | Deletes a drawing area for a shape | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Draws a line of text texture | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Draws a point on a texture | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Draws a line on a texture | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Draws a smooth line on a texture | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Draws a rectangle on a texture | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Draws a circle on a texture | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Clear texture to the given component | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Routines to change the last drawn shape | ||
+ | |- | ||
|} | |} | ||
Line 181: | Line 323: | ||
{| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
− | | style="background-color:#f8e8ff;" | Gets the button state from the mouse: 4 for left, 1 for right | + | | style="background-color:#f8e8ff;" | Gets the button state from the mouse: 4 for left, 1 for right |
− | | style="background-color:#f8e8ff;" | Gets the handle of the component under the mouse | + | |- |
− | | style="background-color:#f8e8ff;" | Gets the position of the mouse, intersecting with a component or the viewing plane | + | | style="background-color:#f8e8ff;" | Gets the handle of the component under the mouse |
− | | style="background-color:#f8e8ff;" | Gets the X/Y position of the mouse in screen coords | + | |- |
− | | style="background-color:#f8e8ff;" | Gets the side of the component clicked on, 0 to 5 | + | | style="background-color:#f8e8ff;" | Gets the position of the mouse, intersecting with a component or the viewing plane |
− | | style="background-color:#f8e8ff;" | Simulates a click on an object | + | |- |
− | | style="background-color:#f8e8ff;" | Simulates a click-drag on an object | + | | style="background-color:#f8e8ff;" | Gets the X/Y position of the mouse in screen coords |
− | | style="background-color:#f8e8ff;" | Simulates a click-release on an object | + | |- |
+ | | style="background-color:#f8e8ff;" | Gets the side of the component clicked on, 0 to 5 | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Simulates a click on an object | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Simulates a click-drag on an object | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Simulates a click-release on an object | ||
+ | |- | ||
|} | |} | ||
Line 197: | Line 347: | ||
{| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
− | | style="background-color:#f8e8ff;" | Simulates a key-press on an object | + | | style="background-color:#f8e8ff;" | Simulates a key-press on an object |
− | | style="background-color:#f8e8ff;" | Simulates a key-release on an object | + | |- |
+ | | style="background-color:#f8e8ff;" | Simulates a key-release on an object | ||
+ | |- | ||
|} | |} | ||
Line 207: | Line 359: | ||
{| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
− | | style="background-color:#f8e8ff;" | Gets a paths item value from the FCD document | + | | style="background-color:#f8e8ff;" | Gets a paths item value from the FCD document |
− | | style="background-color:#f8e8ff;" | Gets a FCD items handle, suitable for traversal with the Tree API | + | |- |
− | | style="background-color:#f8e8ff;" | Gets a FCD paths handle, suitable for traversal with the Tree API | + | | style="background-color:#f8e8ff;" | Gets a FCD items handle, suitable for traversal with the Tree API |
− | | style="background-color:#f8e8ff;" | Override item value from the FCD document from path | + | |- |
− | | style="background-color:#f8e8ff;" | Reset paths item value from the FCD document | + | | style="background-color:#f8e8ff;" | Gets a FCD paths handle, suitable for traversal with the Tree API |
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Override item value from the FCD document from path | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Reset paths item value from the FCD document | ||
+ | |- | ||
|} | |} | ||
Line 220: | Line 377: | ||
{| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
− | | style="background-color:#f8e8ff;" | Plays a formatted file sound, returns true if the sound played OK | + | | style="background-color:#f8e8ff;" | Plays a formatted file sound, returns true if the sound played OK |
− | | style="background-color:#f8e8ff;" | Loads a wave file into memory, providing the values needed to play it | + | |- |
− | | style="background-color:#f8e8ff;" | Creates a sound object that data can be played through | + | | style="background-color:#f8e8ff;" | Loads a wave file into memory, providing the values needed to play it |
− | | style="background-color:#f8e8ff;" | Sets the volume of playbacks for this sound | + | |- |
− | | style="background-color:#f8e8ff;" | Gets the volume of playbacks for this sound in the range 0 to 1 | + | | style="background-color:#f8e8ff;" | Creates a sound object that data can be played through |
− | | style="background-color:#f8e8ff;" | Gets the number of bits per sample for the sound | + | |- |
− | | style="background-color:#f8e8ff;" | Gets the current sample rate for the sound | + | | style="background-color:#f8e8ff;" | Sets the volume of playbacks for this sound |
− | | style="background-color:#f8e8ff;" | Sets the current sample rate for the sound - this will stop the playing sound | + | |- |
− | | style="background-color:#f8e8ff;" | Queues a sound for playing | + | | style="background-color:#f8e8ff;" | Gets the volume of playbacks for this sound in the range 0 to 1 |
− | | style="background-color:#f8e8ff;" | Queues a sound for playing, with the format provided | + | |- |
− | | style="background-color:#f8e8ff;" | Stops all playing and queued sounds | + | | style="background-color:#f8e8ff;" | Gets the number of bits per sample for the sound |
− | | style="background-color:#f8e8ff;" | Gets the number of sample blocks queued or playing for the sound | + | |- |
+ | | style="background-color:#f8e8ff;" | Gets the current sample rate for the sound | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Sets the current sample rate for the sound - this will stop the playing sound | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Queues a sound for playing | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Queues a sound for playing, with the format provided | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Stops all playing and queued sounds | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Gets the number of sample blocks queued or playing for the sound | ||
+ | |- | ||
|} | |} | ||
Line 240: | Line 409: | ||
{| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
− | | style="background-color:#f8e8ff;" | Adds a group to the scope to which streams may be added | + | | style="background-color:#f8e8ff;" | Adds a group to the scope to which streams may be added |
− | | style="background-color:#f8e8ff;" | Sets the visibility of the given group | + | |- |
− | | style="background-color:#f8e8ff;" | Adds a stream to the given group suitable for inputs and operations | + | | style="background-color:#f8e8ff;" | Sets the visibility of the given group |
− | | style="background-color:#f8e8ff;" | Adds a fixed-view stream to the given group suitable for inputs and operations | + | |- |
− | | style="background-color:#f8e8ff;" | Renames the given scope group, stream or buffer | + | | style="background-color:#f8e8ff;" | Adds a stream to the given group suitable for inputs and operations |
− | | style="background-color:#f8e8ff;" | Sets the labels for the Y-axis of the given stream | + | |- |
− | | style="background-color:#f8e8ff;" | Sets the group, stream or buffers line colour | + | | style="background-color:#f8e8ff;" | Adds a fixed-view stream to the given group suitable for inputs and operations |
− | | style="background-color:#f8e8ff;" | Gets the streams line colour | + | |- |
− | | style="background-color:#f8e8ff;" | Sets the groups background colour | + | | style="background-color:#f8e8ff;" | Renames the given scope group, stream or buffer |
− | | style="background-color:#f8e8ff;" | Gets the stream groups background colour | + | |- |
− | | style="background-color:#f8e8ff;" | Sets whether a stream can be decoded via the components event - defaults to 'true' | + | | style="background-color:#f8e8ff;" | Sets the labels for the Y-axis of the given stream |
− | | style="background-color:#f8e8ff;" | Gets whether a stream can be decoded via the components event - defaults to 'true' | + | |- |
− | | style="background-color:#f8e8ff;" | Adds an input to the stream from a port | + | | style="background-color:#f8e8ff;" | Sets the group, stream or buffers line colour |
− | | style="background-color:#f8e8ff;" | Adds an input to the stream from an analog channel | + | |- |
− | | style="background-color:#f8e8ff;" | Adds an input to the stream from a custom injection | + | | style="background-color:#f8e8ff;" | Gets the streams line colour |
− | | style="background-color:#f8e8ff;" | Adds an operation to act on the inputs of the stream | + | |- |
− | | style="background-color:#f8e8ff;" | Clears all inputs and operations from the given stream | + | | style="background-color:#f8e8ff;" | Sets the groups background colour |
− | | style="background-color:#f8e8ff;" | Sets the contents of a snapshot stream | + | |- |
− | | style="background-color:#f8e8ff;" | Sets one of 32 custom analog values for the group | + | | style="background-color:#f8e8ff;" | Gets the stream groups background colour |
− | | style="background-color:#f8e8ff;" | Gets a block of the output stream with each input sample operated on, returns number of samples read | + | |- |
− | | style="background-color:#f8e8ff;" | Searches back through the output history for a value, returns offset of found sample from TimeUS, 0 if not found | + | | style="background-color:#f8e8ff;" | Sets whether a stream can be decoded via the components event - defaults to 'true' |
− | | style="background-color:#f8e8ff;" | Attempts to calculate the wave period given a series of transitions for the stream, returns calculated period | + | |- |
− | | style="background-color:#f8e8ff;" | Sets the graphical format of the packets added with AddPacket and Add...Packets | + | | style="background-color:#f8e8ff;" | Gets whether a stream can be decoded via the components event - defaults to 'true' |
− | | style="background-color:#f8e8ff;" | Returns the graphical format of the packets added with AddPacket and Add...Packets | + | |- |
− | | style="background-color:#f8e8ff;" | Adds an overlay packet to the stream at a given offset from the current time | + | | style="background-color:#f8e8ff;" | Adds an input to the stream from a port |
− | | style="background-color:#f8e8ff;" | Adds overlay packets to the stream by decoding the stream contents with a fixed period rate | + | |- |
− | | style="background-color:#f8e8ff;" | Adds overlay packets to the stream by decoding the stream contents with a variable period rate | + | | style="background-color:#f8e8ff;" | Adds an input to the stream from an analog channel |
− | | style="background-color:#f8e8ff;" | Clears existing overlay packets from the stream | + | |- |
− | | style="background-color:#f8e8ff;" | Clears all existing overlay packets from the stream | + | | style="background-color:#f8e8ff;" | Adds an input to the stream from a custom injection |
− | | style="background-color:#f8e8ff;" | Converts a duration in ticks into a time in seconds | + | |- |
− | | style="background-color:#f8e8ff;" | Converts a time in seconds into a duration in ticks | + | | style="background-color:#f8e8ff;" | Adds an operation to act on the inputs of the stream |
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Clears all inputs and operations from the given stream | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Sets the contents of a snapshot stream | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Sets one of 32 custom analog values for the group | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Gets a block of the output stream with each input sample operated on, returns number of samples read | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Searches back through the output history for a value, returns offset of found sample from TimeUS, 0 if not found | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Attempts to calculate the wave period given a series of transitions for the stream, returns calculated period | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Sets the graphical format of the packets added with AddPacket and Add...Packets | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Returns the graphical format of the packets added with AddPacket and Add...Packets | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Adds an overlay packet to the stream at a given offset from the current time | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Adds overlay packets to the stream by decoding the stream contents with a fixed period rate | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Adds overlay packets to the stream by decoding the stream contents with a variable period rate | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Clears existing overlay packets from the stream | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Clears all existing overlay packets from the stream | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Converts a duration in ticks into a time in seconds | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Converts a time in seconds into a duration in ticks | ||
+ | |- | ||
|} | |} | ||
Line 279: | Line 479: | ||
{| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
− | | style="background-color:#f8e8ff;" | Converts a float to an array containing 4 bytes | + | | style="background-color:#f8e8ff;" | Converts a float to an array containing 4 bytes |
− | | style="background-color:#f8e8ff;" | Returns a float value from an unsigned long representation (used to store or transfer it) | + | |- |
− | | style="background-color:#f8e8ff;" | Calculates the frequency from an array of data. | + | | style="background-color:#f8e8ff;" | Returns a float value from an unsigned long representation (used to store or transfer it) |
− | | style="background-color:#f8e8ff;" | Calculates the amplitude from an array of data. | + | |- |
+ | | style="background-color:#f8e8ff;" | Calculates the frequency from an array of data. | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Calculates the amplitude from an array of data. | ||
+ | |- | ||
|} | |} | ||
Line 291: | Line 495: | ||
{| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
− | | style="background-color:#f8e8ff;" | Adds a window to the list of consoles available | + | | style="background-color:#f8e8ff;" | Adds a window to the list of consoles available |
− | | style="background-color:#f8e8ff;" | Adds a window to the list of consoles available | + | |- |
− | | style="background-color:#f8e8ff;" | Gets the default (read-only) console window | + | | style="background-color:#f8e8ff;" | Adds a window to the list of consoles available |
− | | style="background-color:#f8e8ff;" | Gets a console window | + | |- |
− | | style="background-color:#f8e8ff;" | Returns the name of a console | + | | style="background-color:#f8e8ff;" | Gets the default (read-only) console window |
− | | style="background-color:#f8e8ff;" | Renames the given console | + | |- |
− | | style="background-color:#f8e8ff;" | Sets whether to show address and bytes for the console | + | | style="background-color:#f8e8ff;" | Gets a console window |
− | | style="background-color:#f8e8ff;" | Sets the colour of text inserted by the user from now on | + | |- |
− | | style="background-color:#f8e8ff;" | Sets the colour of text inserted by the component from now on | + | | style="background-color:#f8e8ff;" | Returns the name of a console |
− | | style="background-color:#f8e8ff;" | Adds a block of text to the console window | + | |- |
− | | style="background-color:#f8e8ff;" | Reads a line of text from the given console, pass -1 for final line | + | | style="background-color:#f8e8ff;" | Renames the given console |
− | | style="background-color:#f8e8ff;" | Writes a line of text from the given console, pass -1 for final line | + | |- |
− | | style="background-color:#f8e8ff;" | Reads a line of bytes from the given console extending the array if needed | + | | style="background-color:#f8e8ff;" | Sets whether to show address and bytes for the console |
− | | style="background-color:#f8e8ff;" | Writes a line of bytes from the given console, pass -1 for final line | + | |- |
− | | style="background-color:#f8e8ff;" | Counts the number of lines in the console | + | | style="background-color:#f8e8ff;" | Sets the colour of text inserted by the user from now on |
− | | style="background-color:#f8e8ff;" | Clears all the text in the console | + | |- |
+ | | style="background-color:#f8e8ff;" | Sets the colour of text inserted by the component from now on | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Adds a block of text to the console window | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Reads a line of text from the given console, pass -1 for final line | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Writes a line of text from the given console, pass -1 for final line | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Reads a line of bytes from the given console extending the array if needed | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Writes a line of bytes from the given console, pass -1 for final line | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Counts the number of lines in the console | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Clears all the text in the console | ||
+ | |- | ||
|} | |} | ||
Line 315: | Line 535: | ||
{| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
− | | style="background-color:#f8e8ff;" | Gets a ports value from its index | + | | style="background-color:#f8e8ff;" | Gets a ports value from its index |
− | | style="background-color:#f8e8ff;" | Sets a ports value from its index | + | |- |
− | | style="background-color:#f8e8ff;" | Gets an analog value from its channel index | + | | style="background-color:#f8e8ff;" | Sets a ports value from its index |
− | | style="background-color:#f8e8ff;" | Sets an analog value from its index, range 0->1 | + | |- |
− | | style="background-color:#f8e8ff;" | Gets a ports details from its name or index | + | | style="background-color:#f8e8ff;" | Gets an analog value from its channel index |
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Sets an analog value from its index, range 0->1 | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Gets a ports details from its name or index | ||
+ | |- | ||
|} | |} | ||
Line 328: | Line 553: | ||
{| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
− | | style="background-color:#f8e8ff;" | Expands a string using the built-in pathname expansion variables | + | | style="background-color:#f8e8ff;" | Expands a string using the built-in pathname expansion variables |
− | | style="background-color:#f8e8ff;" | Expands a string to the name of a macro used in the generated code | + | |- |
− | | style="background-color:#f8e8ff;" | Expands a string to the name of a global variable used in the generated code | + | | style="background-color:#f8e8ff;" | Expands a string to the name of a macro used in the generated code |
− | | style="background-color:#f8e8ff;" | Expands a string to the name of a property used in the generated code | + | |- |
− | | style="background-color:#f8e8ff;" | Expands a macro name to the code generated for the header of that macro | + | | style="background-color:#f8e8ff;" | Expands a string to the name of a global variable used in the generated code |
− | | style="background-color:#f8e8ff;" | Expands a macro name to the code generated for the body of that macro | + | |- |
− | | style="background-color:#f8e8ff;" | Expands a macro name to the code generated for the tail of that macro | + | | style="background-color:#f8e8ff;" | Expands a string to the name of a property used in the generated code |
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Expands a macro name to the code generated for the header of that macro | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Expands a macro name to the code generated for the body of that macro | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Expands a macro name to the code generated for the tail of that macro | ||
+ | |- | ||
|} | |} | ||
Line 343: | Line 575: | ||
{| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
− | | style="background-color:#f8e8ff;" | Gets the value of the given object, if available | + | | style="background-color:#f8e8ff;" | Gets the value of the given object, if available |
− | | style="background-color:#f8e8ff;" | Gets the name of the given object | + | |- |
− | | style="background-color:#f8e8ff;" | Gets the full '.' separated name of the given object | + | | style="background-color:#f8e8ff;" | Gets the name of the given object |
− | | style="background-color:#f8e8ff;" | Gets the value of a named sub-item of the given object, if available | + | |- |
− | | style="background-color:#f8e8ff;" | Updates the object to step depth-first through the tree | + | | style="background-color:#f8e8ff;" | Gets the full '.' separated name of the given object |
− | | style="background-color:#f8e8ff;" | Updates the object to point to the next (younger) sibling | + | |- |
− | | style="background-color:#f8e8ff;" | Updates the object to point to the next (younger) sibling matching the name | + | | style="background-color:#f8e8ff;" | Gets the value of a named sub-item of the given object, if available |
− | | style="background-color:#f8e8ff;" | Updates the object to point to the Nth next (younger) sibling matching the name | + | |- |
− | | style="background-color:#f8e8ff;" | Updates the object to point to the last (elder) sibling | + | | style="background-color:#f8e8ff;" | Updates the object to step depth-first through the tree |
− | | style="background-color:#f8e8ff;" | Updates the object to point to its parent object | + | |- |
− | | style="background-color:#f8e8ff;" | Updates the object to point to the root of the tree | + | | style="background-color:#f8e8ff;" | Updates the object to point to the next (younger) sibling |
− | | style="background-color:#f8e8ff;" | Updates the object to point to the head (eldest) child | + | |- |
− | | style="background-color:#f8e8ff;" | Updates the object to point to the tail (youngest) child | + | | style="background-color:#f8e8ff;" | Updates the object to point to the next (younger) sibling matching the name |
− | | style="background-color:#f8e8ff;" | Updates the object to point to the '.' separated named child path | + | |- |
− | | style="background-color:#f8e8ff;" | Returns the number of immediate children present for the object | + | | style="background-color:#f8e8ff;" | Updates the object to point to the Nth next (younger) sibling matching the name |
− | | style="background-color:#f8e8ff;" | Returns true if the object has children, else false | + | |- |
− | | style="background-color:#f8e8ff;" | Returns the number of immediate children present for the object | + | | style="background-color:#f8e8ff;" | Updates the object to point to the last (elder) sibling |
− | | style="background-color:#f8e8ff;" | Returns true if the object has a parent, else false if it is the root | + | |- |
− | | style="background-color:#f8e8ff;" | Updates the object to point to the head (eldest) attribute, if any | + | | style="background-color:#f8e8ff;" | Updates the object to point to its parent object |
− | | style="background-color:#f8e8ff;" | Updates the object to point to the tail (youngest) attribute, if any | + | |- |
− | | style="background-color:#f8e8ff;" | Updates the object to point to the named attribute, if any | + | | style="background-color:#f8e8ff;" | Updates the object to point to the root of the tree |
− | | style="background-color:#f8e8ff;" | Creates a copy of the handle and returns the copy | + | |- |
+ | | style="background-color:#f8e8ff;" | Updates the object to point to the head (eldest) child | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Updates the object to point to the tail (youngest) child | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Updates the object to point to the '.' separated named child path | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Returns the number of immediate children present for the object | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Returns true if the object has children, else false | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Returns the number of immediate children present for the object | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Returns true if the object has a parent, else false if it is the root | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Updates the object to point to the head (eldest) attribute, if any | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Updates the object to point to the tail (youngest) attribute, if any | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Updates the object to point to the named attribute, if any | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Creates a copy of the handle and returns the copy | ||
+ | |- | ||
|} | |} | ||
Line 373: | Line 627: | ||
{| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
− | | style="background-color:#f8e8ff;" | Gets an absolute path from a relative filename | + | | style="background-color:#f8e8ff;" | Gets an absolute path from a relative filename |
− | | style="background-color:#f8e8ff;" | Gets an relative path from an absolute filename | + | |- |
− | | style="background-color:#f8e8ff;" | Creates a directory structure | + | | style="background-color:#f8e8ff;" | Gets an relative path from an absolute filename |
− | | style="background-color:#f8e8ff;" | Finds the type of a file: 0=Unknown, 1=File, 2=Dir, 4=Disk | + | |- |
− | | style="background-color:#f8e8ff;" | Gets the number of bytes in the file, by handle or name | + | | style="background-color:#f8e8ff;" | Creates a directory structure |
− | | style="background-color:#f8e8ff;" | Deletes the file or directory structure | + | |- |
− | | style="background-color:#f8e8ff;" | Creates the new file as a standard stream | + | | style="background-color:#f8e8ff;" | Finds the type of a file: 0=Unknown, 1=File, 2=Dir, 4=Disk |
− | | style="background-color:#f8e8ff;" | Opens the existing file as a standard stream | + | |- |
− | | style="background-color:#f8e8ff;" | Reads an array from the file, returns elements read | + | | style="background-color:#f8e8ff;" | Gets the number of bytes in the file, by handle or name |
− | | style="background-color:#f8e8ff;" | Writes an array to the file | + | |- |
− | | style="background-color:#f8e8ff;" | Sets the position of the next read or write in the file | + | | style="background-color:#f8e8ff;" | Deletes the file or directory structure |
− | | style="background-color:#f8e8ff;" | Gets the position of the next read or write in the file | + | |- |
− | | style="background-color:#f8e8ff;" | Writes all unwritten data to the file in one block | + | | style="background-color:#f8e8ff;" | Creates the new file as a standard stream |
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Opens the existing file as a standard stream | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Reads an array from the file, returns elements read | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Writes an array to the file | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Sets the position of the next read or write in the file | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Gets the position of the next read or write in the file | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Writes all unwritten data to the file in one block | ||
+ | |- | ||
| colspan="3" align="center" style="background-color:#EAE1EA;" | Buffer | | colspan="3" align="center" style="background-color:#EAE1EA;" | Buffer | ||
|- | |- | ||
− | | style="background-color:#f8e8ff;" | Opens the existing file as a circular buffer | + | | style="background-color:#f8e8ff;" | Opens the existing file as a circular buffer |
− | | style="background-color:#f8e8ff;" | Creates the new file as a circular buffer | + | |- |
− | | style="background-color:#f8e8ff;" | Reads a single byte from the input stream, -1 if empty | + | | style="background-color:#f8e8ff;" | Creates the new file as a circular buffer |
− | | style="background-color:#f8e8ff;" | Writes a single byte to the input stream | + | |- |
− | | style="background-color:#f8e8ff;" | Reads an array from the input stream, returns elements read | + | | style="background-color:#f8e8ff;" | Reads a single byte from the input stream, -1 if empty |
− | | style="background-color:#f8e8ff;" | Writes an array to the input stream | + | |- |
+ | | style="background-color:#f8e8ff;" | Writes a single byte to the input stream | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Reads an array from the input stream, returns elements read | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Writes an array to the input stream | ||
+ | |- | ||
| colspan="3" align="center" style="background-color:#EAE1EA;" | NVM | | colspan="3" align="center" style="background-color:#EAE1EA;" | NVM | ||
|- | |- | ||
− | | style="background-color:#f8e8ff;" | Opens the existing file as a block of non-volatile memory | + | | style="background-color:#f8e8ff;" | Opens the existing file as a block of non-volatile memory |
− | | style="background-color:#f8e8ff;" | Creates the new file as a block of non-volatile memory | + | |- |
− | | style="background-color:#f8e8ff;" | Reads a single byte from the NVM, -1 if empty | + | | style="background-color:#f8e8ff;" | Creates the new file as a block of non-volatile memory |
− | | style="background-color:#f8e8ff;" | Writes a single byte to the NVM multiple times | + | |- |
− | | style="background-color:#f8e8ff;" | Reads an array from the NVM, returns elements read | + | | style="background-color:#f8e8ff;" | Reads a single byte from the NVM, -1 if empty |
− | | style="background-color:#f8e8ff;" | Writes an array to the NVM | + | |- |
+ | | style="background-color:#f8e8ff;" | Writes a single byte to the NVM multiple times | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Reads an array from the NVM, returns elements read | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Writes an array to the NVM | ||
+ | |- | ||
|} | |} | ||
Line 410: | Line 689: | ||
{| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
− | | style="background-color:#f8e8ff;" | Displays a simple 'Ok' message box | + | | style="background-color:#f8e8ff;" | Displays a simple 'Ok' message box |
− | | style="background-color:#f8e8ff;" | Invokes the Win32 API MessageBox function | + | |- |
− | | style="background-color:#f8e8ff;" | Displays a simple 'Yes/No' message box | + | | style="background-color:#f8e8ff;" | Invokes the Win32 API MessageBox function |
− | | style="background-color:#f8e8ff;" | Displays a simple 'Yes/No/Cancel' message box (0 == Cancel, 1 == No, 2 == Yes) | + | |- |
− | | style="background-color:#f8e8ff;" | Displays a message box that allows the user to input text. Returns true if 'Ok' clicked, false otherwise | + | | style="background-color:#f8e8ff;" | Displays a simple 'Yes/No' message box |
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Displays a simple 'Yes/No/Cancel' message box (0 == Cancel, 1 == No, 2 == Yes) | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Displays a message box that allows the user to input text. Returns true if 'Ok' clicked, false otherwise | ||
+ | |- | ||
|} | |} | ||
Line 423: | Line 707: | ||
{| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
− | | style="background-color:#f8e8ff;" | Returns the value of a monotonic non-decrementing millisecond counter | + | | style="background-color:#f8e8ff;" | Returns the value of a monotonic non-decrementing millisecond counter |
− | | style="background-color:#f8e8ff;" | Returns the current UTC Modified Julian Date value | + | |- |
− | | style="background-color:#f8e8ff;" | Returns the current local time as a Modified Julian Date value | + | | style="background-color:#f8e8ff;" | Returns the current UTC Modified Julian Date value |
− | | style="background-color:#f8e8ff;" | Increments or decrements a Modified Julian Date and millisecond value | + | |- |
− | | style="background-color:#f8e8ff;" | Converts a Modified Julian Date into a Gregorian calendar date | + | | style="background-color:#f8e8ff;" | Returns the current local time as a Modified Julian Date value |
− | | style="background-color:#f8e8ff;" | Converts a Gregorian calendar date into a Modified Julian Date | + | |- |
− | | style="background-color:#f8e8ff;" | Converts a Modified Julian Date into a number of seconds since a specified epoch | + | | style="background-color:#f8e8ff;" | Increments or decrements a Modified Julian Date and millisecond value |
− | | style="background-color:#f8e8ff;" | Returns the Modified Julian Date given by the number of seconds since a specified epoch | + | |- |
− | | style="background-color:#f8e8ff;" | Gets the day of the week that the MJD represents | + | | style="background-color:#f8e8ff;" | Converts a Modified Julian Date into a Gregorian calendar date |
− | | style="background-color:#f8e8ff;" | Returns true if the given year is a leap year, else false | + | |- |
− | | style="background-color:#f8e8ff;" | Returns the number of days in the given month | + | | style="background-color:#f8e8ff;" | Converts a Gregorian calendar date into a Modified Julian Date |
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Converts a Modified Julian Date into a number of seconds since a specified epoch | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Returns the Modified Julian Date given by the number of seconds since a specified epoch | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Gets the day of the week that the MJD represents | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Returns true if the given year is a leap year, else false | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Returns the number of days in the given month | ||
+ | |- | ||
|} | |} | ||
Line 442: | Line 737: | ||
{| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
− | | style="background-color:#f8e8ff;" | Takes English text and optional hint and converts to the current language | + | | style="background-color:#f8e8ff;" | Takes English text and optional hint and converts to the current language |
+ | |- | ||
|} | |} | ||
Line 451: | Line 747: | ||
{| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
− | | style="background-color:#f8e8ff;" | Sends a System.User message to the targeted component | + | | style="background-color:#f8e8ff;" | Sends a System.User message to the targeted component |
− | | style="background-color:#f8e8ff;" | Sends the currently processing message to the target | + | |- |
− | | style="background-color:#f8e8ff;" | Returns true if the macro exists | + | | style="background-color:#f8e8ff;" | Sends the currently processing message to the target |
− | | style="background-color:#f8e8ff;" | Calls a macro | + | |- |
− | | style="background-color:#f8e8ff;" | Given a handle to an object with viewable presence, shows that object on screen | + | | style="background-color:#f8e8ff;" | Returns true if the macro exists |
− | | style="background-color:#f8e8ff;" | Creates a general-purpose garbage collected handle for resource management | + | |- |
− | | style="background-color:#f8e8ff;" | Sets a general purpose word in the handle for use by its owner | + | | style="background-color:#f8e8ff;" | Calls a macro |
− | | style="background-color:#f8e8ff;" | Gets a general-purpose word set by the owner of a custom handle | + | |- |
− | | style="background-color:#f8e8ff;" | Deletes any handle created by the component | + | | style="background-color:#f8e8ff;" | Given a handle to an object with viewable presence, shows that object on screen |
− | | style="background-color:#f8e8ff;" | Gets the handle of the component that posted this event - 0 for system | + | |- |
− | | style="background-color:#f8e8ff;" | Calls the Component.Timer event with Ident as an argument after Millisecs time | + | | style="background-color:#f8e8ff;" | Creates a general-purpose garbage collected handle for resource management |
− | | style="background-color:#f8e8ff;" | Kills any timers with the given ident for this component | + | |- |
− | | style="background-color:#f8e8ff;" | Enables or disables the software watchdog during long operations | + | | style="background-color:#f8e8ff;" | Sets a general purpose word in the handle for use by its owner |
− | | style="background-color:#f8e8ff;" | Claims an event message by name, returns true if claimed | + | |- |
− | | style="background-color:#f8e8ff;" | Releases a previously claimed an event message by name, returns true if released | + | | style="background-color:#f8e8ff;" | Gets a general-purpose word set by the owner of a custom handle |
− | | style="background-color:#f8e8ff;" | Allows an event to be fired or removes the ability for an event to fire - this may be nested | + | |- |
− | | style="background-color:#f8e8ff;" | Claims mouse clicks for the target object | + | | style="background-color:#f8e8ff;" | Deletes any handle created by the component |
− | | style="background-color:#f8e8ff;" | Releases mouse clicks for the target object | + | |- |
− | | style="background-color:#f8e8ff;" | Allows calls to one of your children to be redirected to another component | + | | style="background-color:#f8e8ff;" | Gets the handle of the component that posted this event - 0 for system |
− | | style="background-color:#f8e8ff;" | Start the simulation engine | + | |- |
− | | style="background-color:#f8e8ff;" | Stop the simulation engine | + | | style="background-color:#f8e8ff;" | Calls the Component.Timer event with Ident as an argument after Millisecs time |
− | | style="background-color:#f8e8ff;" | Sets the speed the simulation engine | + | |- |
− | | style="background-color:#f8e8ff;" | Sets the clipboard with text data | + | | style="background-color:#f8e8ff;" | Kills any timers with the given ident for this component |
− | | style="background-color:#f8e8ff;" | Reads text data from the clipboard | + | |- |
− | | style="background-color:#f8e8ff;" | Checks to see if a Flowcode window has the focus | + | | style="background-color:#f8e8ff;" | Enables or disables the software watchdog during long operations |
− | | style="background-color:#f8e8ff;" | Launches an external file or program on this computer | + | |- |
− | | style="background-color:#f8e8ff;" | Writes an integer value to the registry | + | | style="background-color:#f8e8ff;" | Claims an event message by name, returns true if claimed |
− | | style="background-color:#f8e8ff;" | Writes a string value to the registry | + | |- |
− | | style="background-color:#f8e8ff;" | Reads an integer value from the registry | + | | style="background-color:#f8e8ff;" | Releases a previously claimed an event message by name, returns true if released |
− | | style="background-color:#f8e8ff;" | Reads a string value from the registry | + | |- |
+ | | style="background-color:#f8e8ff;" | Allows an event to be fired or removes the ability for an event to fire - this may be nested | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Claims mouse clicks for the target object | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Releases mouse clicks for the target object | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Allows calls to one of your children to be redirected to another component | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Start the simulation engine | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Stop the simulation engine | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Sets the speed the simulation engine | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Sets the clipboard with text data | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Reads text data from the clipboard | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Checks to see if a Flowcode window has the focus | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Launches an external file or program on this computer | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Writes an integer value to the registry | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Writes a string value to the registry | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Reads an integer value from the registry | ||
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Reads a string value from the registry | ||
+ | |- | ||
|} | |} | ||
Line 489: | Line 815: | ||
{| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
− | | style="background-color:#f8e8ff;" | Prints out the string or value on a line in the debug window | + | | style="background-color:#f8e8ff;" | Prints out the string or value on a line in the debug window |
− | | style="background-color:#f8e8ff;" | Prints out the string or value with a new-line in the debug window | + | |- |
− | | style="background-color:#f8e8ff;" | Temporary debug function | + | | style="background-color:#f8e8ff;" | Prints out the string or value with a new-line in the debug window |
+ | |- | ||
+ | | style="background-color:#f8e8ff;" | Temporary debug function | ||
+ | |- | ||
|} | |} | ||
Line 506: | Line 835: | ||
{| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Compile.Broadcast to all components immediately before compilation is started|Broadcast to all components immediately before compilation is started]]\r\n| style="background-color:#f8e8ff;" | Broadcast to all components immediately before compilation is started | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event Compile.Broadcast to all components immediately before compilation is started|Broadcast to all components immediately before compilation is started]]\r\n| style="background-color:#f8e8ff;" | Broadcast to all components immediately before compilation is started |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Compile.Sent to a component to allow dynamic amendment of global property declarations|Sent to a component to allow dynamic amendment of global property declarations]]\r\n| style="background-color:#f8e8ff;" | Sent to a component to allow dynamic amendment of global property declarations | + | |- |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Compile.Sent to a component to allow dynamic amendment of global variable declarations|Sent to a component to allow dynamic amendment of global variable declarations]]\r\n| style="background-color:#f8e8ff;" | Sent to a component to allow dynamic amendment of global variable declarations | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event Compile.Sent to a component to allow dynamic amendment of global property declarations|Sent to a component to allow dynamic amendment of global property declarations]]\r\n| style="background-color:#f8e8ff;" | Sent to a component to allow dynamic amendment of global property declarations |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Compile.Sent to a component to allow dynamic amendment of global array-size declarations|Sent to a component to allow dynamic amendment of global array-size declarations]]\r\n| style="background-color:#f8e8ff;" | Sent to a component to allow dynamic amendment of global array-size declarations | + | |- |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Compile.Sent to a component to allow dynamic amendment of global constant declarations|Sent to a component to allow dynamic amendment of global constant declarations]]\r\n| style="background-color:#f8e8ff;" | Sent to a component to allow dynamic amendment of global constant declarations | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event Compile.Sent to a component to allow dynamic amendment of global variable declarations|Sent to a component to allow dynamic amendment of global variable declarations]]\r\n| style="background-color:#f8e8ff;" | Sent to a component to allow dynamic amendment of global variable declarations |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Compile.Sent to a component to allow dynamic amendment of header code|Sent to a component to allow dynamic amendment of header code]]\r\n| style="background-color:#f8e8ff;" | Sent to a component to allow dynamic amendment of header code | + | |- |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Compile.Sent to a component to allow dynamic amendment of the interrupts for a component|Sent to a component to allow dynamic amendment of the interrupts for a component]]\r\n| style="background-color:#f8e8ff;" | Sent to a component to allow dynamic amendment of the interrupts for a component | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event Compile.Sent to a component to allow dynamic amendment of global array-size declarations|Sent to a component to allow dynamic amendment of global array-size declarations]]\r\n| style="background-color:#f8e8ff;" | Sent to a component to allow dynamic amendment of global array-size declarations |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Compile.Sent to a component to allow dynamic amendment of a single interrupts code|Sent to a component to allow dynamic amendment of a single interrupts code]]\r\n| style="background-color:#f8e8ff;" | Sent to a component to allow dynamic amendment of a single interrupts code | + | |- |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Compile.Broadcast to all components that compilation is starting|Broadcast to all components that compilation is starting]]\r\n| style="background-color:#f8e8ff;" | Broadcast to all components that compilation is starting | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event Compile.Sent to a component to allow dynamic amendment of global constant declarations|Sent to a component to allow dynamic amendment of global constant declarations]]\r\n| style="background-color:#f8e8ff;" | Sent to a component to allow dynamic amendment of global constant declarations |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Compile.Broadcast to all components that compilation has stopped|Broadcast to all components that compilation has stopped]]\r\n| style="background-color:#f8e8ff;" | Broadcast to all components that compilation has stopped | + | |- |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Compile.Sent to a component to amend the size of the expected array|Sent to a component to amend the size of the expected array]]\r\n| style="background-color:#f8e8ff;" | Sent to a component to amend the size of the expected array | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event Compile.Sent to a component to allow dynamic amendment of header code|Sent to a component to allow dynamic amendment of header code]]\r\n| style="background-color:#f8e8ff;" | Sent to a component to allow dynamic amendment of header code |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Compile.Sent to a component to retrieve tags to be placed in the html body|Sent to a component to retrieve tags to be placed in the html body]]\r\n| style="background-color:#f8e8ff;" | Sent to a component to retrieve tags to be placed in the html body | + | |- |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Compile.Sent to a component to retrieve script code to be placed in the html header section|Sent to a component to retrieve script code to be placed in the html header section]]\r\n| style="background-color:#f8e8ff;" | Sent to a component to retrieve script code to be placed in the html header section | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event Compile.Sent to a component to allow dynamic amendment of the interrupts for a component|Sent to a component to allow dynamic amendment of the interrupts for a component]]\r\n| style="background-color:#f8e8ff;" | Sent to a component to allow dynamic amendment of the interrupts for a component |
+ | |- | ||
+ | | colspan="2" style="background-color:#f8e8ff;" | [[Event Compile.Sent to a component to allow dynamic amendment of a single interrupts code|Sent to a component to allow dynamic amendment of a single interrupts code]]\r\n| style="background-color:#f8e8ff;" | Sent to a component to allow dynamic amendment of a single interrupts code | ||
+ | |- | ||
+ | | colspan="2" style="background-color:#f8e8ff;" | [[Event Compile.Broadcast to all components that compilation is starting|Broadcast to all components that compilation is starting]]\r\n| style="background-color:#f8e8ff;" | Broadcast to all components that compilation is starting | ||
+ | |- | ||
+ | | colspan="2" style="background-color:#f8e8ff;" | [[Event Compile.Broadcast to all components that compilation has stopped|Broadcast to all components that compilation has stopped]]\r\n| style="background-color:#f8e8ff;" | Broadcast to all components that compilation has stopped | ||
+ | |- | ||
+ | | colspan="2" style="background-color:#f8e8ff;" | [[Event Compile.Sent to a component to amend the size of the expected array|Sent to a component to amend the size of the expected array]]\r\n| style="background-color:#f8e8ff;" | Sent to a component to amend the size of the expected array | ||
+ | |- | ||
+ | | colspan="2" style="background-color:#f8e8ff;" | [[Event Compile.Sent to a component to retrieve tags to be placed in the html body|Sent to a component to retrieve tags to be placed in the html body]]\r\n| style="background-color:#f8e8ff;" | Sent to a component to retrieve tags to be placed in the html body | ||
+ | |- | ||
+ | | colspan="2" style="background-color:#f8e8ff;" | [[Event Compile.Sent to a component to retrieve script code to be placed in the html header section|Sent to a component to retrieve script code to be placed in the html header section]]\r\n| style="background-color:#f8e8ff;" | Sent to a component to retrieve script code to be placed in the html header section | ||
+ | |- | ||
|} | |} | ||
Line 527: | Line 869: | ||
{| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Components.Sent when a property has been changed by the User (specific property and value identified)|Sent when a property has been changed by the User (specific property and value identified)]]\r\n| style="background-color:#f8e8ff;" | Sent when a property has been changed by the User (specific property and value identified) | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event Components.Sent when a property has been changed by the User (specific property and value identified)|Sent when a property has been changed by the User (specific property and value identified)]]\r\n| style="background-color:#f8e8ff;" | Sent when a property has been changed by the User (specific property and value identified) |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Components.Sent when a property has been changed by the User|Sent when a property has been changed by the User]]\r\n| style="background-color:#f8e8ff;" | Sent when a property has been changed by the User | + | |- |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Components.Sent to the component when the project is closing|Sent to the component when the project is closing]]\r\n| style="background-color:#f8e8ff;" | Sent to the component when the project is closing | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event Components.Sent when a property has been changed by the User|Sent when a property has been changed by the User]]\r\n| style="background-color:#f8e8ff;" | Sent when a property has been changed by the User |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Components.Broadcast to all existing components once a new component has been added|Broadcast to all existing components once a new component has been added]]\r\n| style="background-color:#f8e8ff;" | Broadcast to all existing components once a new component has been added | + | |- |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Components.Broadcast to all existing components when a new component is about to be added|Broadcast to all existing components when a new component is about to be added]]\r\n| style="background-color:#f8e8ff;" | Broadcast to all existing components when a new component is about to be added | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event Components.Sent to the component when the project is closing|Sent to the component when the project is closing]]\r\n| style="background-color:#f8e8ff;" | Sent to the component when the project is closing |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Components.Sent to the mouse target when the user has altered the position of a component child|Sent to the mouse target when the user has altered the position of a component child]]\r\n| style="background-color:#f8e8ff;" | Sent to the mouse target when the user has altered the position of a component child | + | |- |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Components.Broadcast to all remaining components after a component has been removed|Broadcast to all remaining components after a component has been removed]]\r\n| style="background-color:#f8e8ff;" | Broadcast to all remaining components after a component has been removed | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event Components.Broadcast to all existing components once a new component has been added|Broadcast to all existing components once a new component has been added]]\r\n| style="background-color:#f8e8ff;" | Broadcast to all existing components once a new component has been added |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Components.Broadcast to all existing components when a component is about to be removed|Broadcast to all existing components when a component is about to be removed]]\r\n| style="background-color:#f8e8ff;" | Broadcast to all existing components when a component is about to be removed | + | |- |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Components.Sent to the component when the component is renamed|Sent to the component when the component is renamed]]\r\n| style="background-color:#f8e8ff;" | Sent to the component when the component is renamed | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event Components.Broadcast to all existing components when a new component is about to be added|Broadcast to all existing components when a new component is about to be added]]\r\n| style="background-color:#f8e8ff;" | Broadcast to all existing components when a new component is about to be added |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Components.Closedown routine for the component|Closedown routine for the component]]\r\n| style="background-color:#f8e8ff;" | Closedown routine for the component | + | |- |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Components.Send to a component when it is being deleted|Send to a component when it is being deleted]]\r\n| style="background-color:#f8e8ff;" | Send to a component when it is being deleted | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event Components.Sent to the mouse target when the user has altered the position of a component child|Sent to the mouse target when the user has altered the position of a component child]]\r\n| style="background-color:#f8e8ff;" | Sent to the mouse target when the user has altered the position of a component child |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Components.Initialisation routine for the component once the component is linked to its parent|Initialisation routine for the component once the component is linked to its parent]]\r\n| style="background-color:#f8e8ff;" | Initialisation routine for the component once the component is linked to its parent | + | |- |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Components.Initialisation routine before the component is linked to its parent|Initialisation routine before the component is linked to its parent]]\r\n| style="background-color:#f8e8ff;" | Initialisation routine before the component is linked to its parent | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event Components.Broadcast to all remaining components after a component has been removed|Broadcast to all remaining components after a component has been removed]]\r\n| style="background-color:#f8e8ff;" | Broadcast to all remaining components after a component has been removed |
+ | |- | ||
+ | | colspan="2" style="background-color:#f8e8ff;" | [[Event Components.Broadcast to all existing components when a component is about to be removed|Broadcast to all existing components when a component is about to be removed]]\r\n| style="background-color:#f8e8ff;" | Broadcast to all existing components when a component is about to be removed | ||
+ | |- | ||
+ | | colspan="2" style="background-color:#f8e8ff;" | [[Event Components.Sent to the component when the component is renamed|Sent to the component when the component is renamed]]\r\n| style="background-color:#f8e8ff;" | Sent to the component when the component is renamed | ||
+ | |- | ||
+ | | colspan="2" style="background-color:#f8e8ff;" | [[Event Components.Closedown routine for the component|Closedown routine for the component]]\r\n| style="background-color:#f8e8ff;" | Closedown routine for the component | ||
+ | |- | ||
+ | | colspan="2" style="background-color:#f8e8ff;" | [[Event Components.Send to a component when it is being deleted|Send to a component when it is being deleted]]\r\n| style="background-color:#f8e8ff;" | Send to a component when it is being deleted | ||
+ | |- | ||
+ | | colspan="2" style="background-color:#f8e8ff;" | [[Event Components.Initialisation routine for the component once the component is linked to its parent|Initialisation routine for the component once the component is linked to its parent]]\r\n| style="background-color:#f8e8ff;" | Initialisation routine for the component once the component is linked to its parent | ||
+ | |- | ||
+ | | colspan="2" style="background-color:#f8e8ff;" | [[Event Components.Initialisation routine before the component is linked to its parent|Initialisation routine before the component is linked to its parent]]\r\n| style="background-color:#f8e8ff;" | Initialisation routine before the component is linked to its parent | ||
+ | |- | ||
|} | |} | ||
Line 548: | Line 903: | ||
{| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Console.Post to the owning component when a line is inserted by the user|Post to the owning component when a line is inserted by the user]]\r\n| style="background-color:#f8e8ff;" | Post to the owning component when a line is inserted by the user | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event Console.Post to the owning component when a line is inserted by the user|Post to the owning component when a line is inserted by the user]]\r\n| style="background-color:#f8e8ff;" | Post to the owning component when a line is inserted by the user |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Console.Post when the console text is changed by the user in some way|Post when the console text is changed by the user in some way]]\r\n| style="background-color:#f8e8ff;" | Post when the console text is changed by the user in some way | + | |- |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Console.Post when the console memory is changed by the user in some way|Post when the console memory is changed by the user in some way]]\r\n| style="background-color:#f8e8ff;" | Post when the console memory is changed by the user in some way | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event Console.Post when the console text is changed by the user in some way|Post when the console text is changed by the user in some way]]\r\n| style="background-color:#f8e8ff;" | Post when the console text is changed by the user in some way |
+ | |- | ||
+ | | colspan="2" style="background-color:#f8e8ff;" | [[Event Console.Post when the console memory is changed by the user in some way|Post when the console memory is changed by the user in some way]]\r\n| style="background-color:#f8e8ff;" | Post when the console memory is changed by the user in some way | ||
+ | |- | ||
|} | |} | ||
Line 559: | Line 917: | ||
{| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Connection.Sent when auto-populate of digital connections is requested|Sent when auto-populate of digital connections is requested]]\r\n| style="background-color:#f8e8ff;" | Sent when auto-populate of digital connections is requested | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event Connection.Sent when auto-populate of digital connections is requested|Sent when auto-populate of digital connections is requested]]\r\n| style="background-color:#f8e8ff;" | Sent when auto-populate of digital connections is requested |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Connection.Sent during simulation if a connected port pin changes|Sent during simulation if a connected port pin changes]]\r\n| style="background-color:#f8e8ff;" | Sent during simulation if a connected port pin changes | + | |- |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Connection.Sent when auto-populate of analog connections is requested|Sent when auto-populate of analog connections is requested]]\r\n| style="background-color:#f8e8ff;" | Sent when auto-populate of analog connections is requested | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event Connection.Sent during simulation if a connected port pin changes|Sent during simulation if a connected port pin changes]]\r\n| style="background-color:#f8e8ff;" | Sent during simulation if a connected port pin changes |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Connection.Sent during simulation if a connected ADC channel changes|Sent during simulation if a connected ADC channel changes]]\r\n| style="background-color:#f8e8ff;" | Sent during simulation if a connected ADC channel changes | + | |- |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Connection.Sent when the target device has changed|Sent when the target device has changed]]\r\n| style="background-color:#f8e8ff;" | Sent when the target device has changed | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event Connection.Sent when auto-populate of analog connections is requested|Sent when auto-populate of analog connections is requested]]\r\n| style="background-color:#f8e8ff;" | Sent when auto-populate of analog connections is requested |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Connection.Sent when the component is compiled with unconnected pins|Sent when the component is compiled with unconnected pins]]\r\n| style="background-color:#f8e8ff;" | Sent when the component is compiled with unconnected pins | + | |- |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Connection.Sent when some settings of the target device have changed|Sent when some settings of the target device have changed]]\r\n| style="background-color:#f8e8ff;" | Sent when some settings of the target device have changed | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event Connection.Sent during simulation if a connected ADC channel changes|Sent during simulation if a connected ADC channel changes]]\r\n| style="background-color:#f8e8ff;" | Sent during simulation if a connected ADC channel changes |
+ | |- | ||
+ | | colspan="2" style="background-color:#f8e8ff;" | [[Event Connection.Sent when the target device has changed|Sent when the target device has changed]]\r\n| style="background-color:#f8e8ff;" | Sent when the target device has changed | ||
+ | |- | ||
+ | | colspan="2" style="background-color:#f8e8ff;" | [[Event Connection.Sent when the component is compiled with unconnected pins|Sent when the component is compiled with unconnected pins]]\r\n| style="background-color:#f8e8ff;" | Sent when the component is compiled with unconnected pins | ||
+ | |- | ||
+ | | colspan="2" style="background-color:#f8e8ff;" | [[Event Connection.Sent when some settings of the target device have changed|Sent when some settings of the target device have changed]]\r\n| style="background-color:#f8e8ff;" | Sent when some settings of the target device have changed | ||
+ | |- | ||
|} | |} | ||
Line 574: | Line 939: | ||
{| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Simulation.Broadcast to all components that simulation has paused|Broadcast to all components that simulation has paused]]\r\n| style="background-color:#f8e8ff;" | Broadcast to all components that simulation has paused | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event Simulation.Broadcast to all components that simulation has paused|Broadcast to all components that simulation has paused]]\r\n| style="background-color:#f8e8ff;" | Broadcast to all components that simulation has paused |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Simulation.Broadcast to all components that simulation has resumed|Broadcast to all components that simulation has resumed]]\r\n| style="background-color:#f8e8ff;" | Broadcast to all components that simulation has resumed | + | |- |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Simulation.Broadcast to all components that simulation is starting|Broadcast to all components that simulation is starting]]\r\n| style="background-color:#f8e8ff;" | Broadcast to all components that simulation is starting | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event Simulation.Broadcast to all components that simulation has resumed|Broadcast to all components that simulation has resumed]]\r\n| style="background-color:#f8e8ff;" | Broadcast to all components that simulation has resumed |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Simulation.Broadcast to all components that simulation has stopped|Broadcast to all components that simulation has stopped]]\r\n| style="background-color:#f8e8ff;" | Broadcast to all components that simulation has stopped | + | |- |
+ | | colspan="2" style="background-color:#f8e8ff;" | [[Event Simulation.Broadcast to all components that simulation is starting|Broadcast to all components that simulation is starting]]\r\n| style="background-color:#f8e8ff;" | Broadcast to all components that simulation is starting | ||
+ | |- | ||
+ | | colspan="2" style="background-color:#f8e8ff;" | [[Event Simulation.Broadcast to all components that simulation has stopped|Broadcast to all components that simulation has stopped]]\r\n| style="background-color:#f8e8ff;" | Broadcast to all components that simulation has stopped | ||
+ | |- | ||
|} | |} | ||
Line 586: | Line 955: | ||
{| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event System.Called when a custom handle is deleted to allow cleanup of resources|Called when a custom handle is deleted to allow cleanup of resources]]\r\n| style="background-color:#f8e8ff;" | Called when a custom handle is deleted to allow cleanup of resources | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event System.Called when a custom handle is deleted to allow cleanup of resources|Called when a custom handle is deleted to allow cleanup of resources]]\r\n| style="background-color:#f8e8ff;" | Called when a custom handle is deleted to allow cleanup of resources |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event System.Called back on the panel command System.TimerStart|Called back on the panel command System.TimerStart]]\r\n| style="background-color:#f8e8ff;" | Called back on the panel command System.TimerStart | + | |- |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event System.Called back on the panel command System.Notify|Called back on the panel command System.Notify]]\r\n| style="background-color:#f8e8ff;" | Called back on the panel command System.Notify | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event System.Called back on the panel command System.TimerStart|Called back on the panel command System.TimerStart]]\r\n| style="background-color:#f8e8ff;" | Called back on the panel command System.TimerStart |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event System.Broadcast after a project has finished loading|Broadcast after a project has finished loading]]\r\n| style="background-color:#f8e8ff;" | Broadcast after a project has finished loading | + | |- |
+ | | colspan="2" style="background-color:#f8e8ff;" | [[Event System.Called back on the panel command System.Notify|Called back on the panel command System.Notify]]\r\n| style="background-color:#f8e8ff;" | Called back on the panel command System.Notify | ||
+ | |- | ||
+ | | colspan="2" style="background-color:#f8e8ff;" | [[Event System.Broadcast after a project has finished loading|Broadcast after a project has finished loading]]\r\n| style="background-color:#f8e8ff;" | Broadcast after a project has finished loading | ||
+ | |- | ||
|} | |} | ||
Line 598: | Line 971: | ||
{| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Sound.Sent when a sound queued by the component has finished playing|Sent when a sound queued by the component has finished playing]]\r\n| style="background-color:#f8e8ff;" | Sent when a sound queued by the component has finished playing | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event Sound.Sent when a sound queued by the component has finished playing|Sent when a sound queued by the component has finished playing]]\r\n| style="background-color:#f8e8ff;" | Sent when a sound queued by the component has finished playing |
+ | |- | ||
|} | |} | ||
Line 607: | Line 981: | ||
{| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event DataRecorder.Sent when Packet_ResyncEv is specified in scope decoding|Sent when Packet_ResyncEv is specified in scope decoding]]\r\n| style="background-color:#f8e8ff;" | Sent when Packet_ResyncEv is specified in scope decoding | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event DataRecorder.Sent when Packet_ResyncEv is specified in scope decoding|Sent when Packet_ResyncEv is specified in scope decoding]]\r\n| style="background-color:#f8e8ff;" | Sent when Packet_ResyncEv is specified in scope decoding |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event DataRecorder.Sent when a block of the stream is to be decoded into packets|Sent when a block of the stream is to be decoded into packets]]\r\n| style="background-color:#f8e8ff;" | Sent when a block of the stream is to be decoded into packets | + | |- |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event DataRecorder.Sent when a %e is read in a format string when decoding a packet|Sent when a %e is read in a format string when decoding a packet]]\r\n| style="background-color:#f8e8ff;" | Sent when a %e is read in a format string when decoding a packet | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event DataRecorder.Sent when a block of the stream is to be decoded into packets|Sent when a block of the stream is to be decoded into packets]]\r\n| style="background-color:#f8e8ff;" | Sent when a block of the stream is to be decoded into packets |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event DataRecorder.Sent when the mouse hovers over a scope stream|Sent when the mouse hovers over a scope stream]]\r\n| style="background-color:#f8e8ff;" | Sent when the mouse hovers over a scope stream | + | |- |
+ | | colspan="2" style="background-color:#f8e8ff;" | [[Event DataRecorder.Sent when a %e is read in a format string when decoding a packet|Sent when a %e is read in a format string when decoding a packet]]\r\n| style="background-color:#f8e8ff;" | Sent when a %e is read in a format string when decoding a packet | ||
+ | |- | ||
+ | | colspan="2" style="background-color:#f8e8ff;" | [[Event DataRecorder.Sent when the mouse hovers over a scope stream|Sent when the mouse hovers over a scope stream]]\r\n| style="background-color:#f8e8ff;" | Sent when the mouse hovers over a scope stream | ||
+ | |- | ||
|} | |} | ||
Line 619: | Line 997: | ||
{| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Tooltip.Called when a tooltip graphic is updating with the draw image already pushed|Called when a tooltip graphic is updating with the draw image already pushed]]\r\n| style="background-color:#f8e8ff;" | Called when a tooltip graphic is updating with the draw image already pushed | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event Tooltip.Called when a tooltip graphic is updating with the draw image already pushed|Called when a tooltip graphic is updating with the draw image already pushed]]\r\n| style="background-color:#f8e8ff;" | Called when a tooltip graphic is updating with the draw image already pushed |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Tooltip.Called when a tooltip text string can be displayed|Called when a tooltip text string can be displayed]]\r\n| style="background-color:#f8e8ff;" | Called when a tooltip text string can be displayed | + | |- |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Tooltip.Called when a tooltip graphic can be displayed with the draw image already pushed|Called when a tooltip graphic can be displayed with the draw image already pushed]]\r\n| style="background-color:#f8e8ff;" | Called when a tooltip graphic can be displayed with the draw image already pushed | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event Tooltip.Called when a tooltip text string can be displayed|Called when a tooltip text string can be displayed]]\r\n| style="background-color:#f8e8ff;" | Called when a tooltip text string can be displayed |
+ | |- | ||
+ | | colspan="2" style="background-color:#f8e8ff;" | [[Event Tooltip.Called when a tooltip graphic can be displayed with the draw image already pushed|Called when a tooltip graphic can be displayed with the draw image already pushed]]\r\n| style="background-color:#f8e8ff;" | Called when a tooltip graphic can be displayed with the draw image already pushed | ||
+ | |- | ||
|} | |} | ||
Line 630: | Line 1,011: | ||
{| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event File.Sent when a file being watched has changed|Sent when a file being watched has changed]]\r\n| style="background-color:#f8e8ff;" | Sent when a file being watched has changed | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event File.Sent when a file being watched has changed|Sent when a file being watched has changed]]\r\n| style="background-color:#f8e8ff;" | Sent when a file being watched has changed |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event File.Sent when a file monitor is being closed|Sent when a file monitor is being closed]]\r\n| style="background-color:#f8e8ff;" | Sent when a file monitor is being closed | + | |- |
+ | | colspan="2" style="background-color:#f8e8ff;" | [[Event File.Sent when a file monitor is being closed|Sent when a file monitor is being closed]]\r\n| style="background-color:#f8e8ff;" | Sent when a file monitor is being closed | ||
+ | |- | ||
|} | |} | ||
Line 640: | Line 1,023: | ||
{| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Graphics.Notification than an animation has finished|Notification than an animation has finished]]\r\n| style="background-color:#f8e8ff;" | Notification than an animation has finished | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event Graphics.Notification than an animation has finished|Notification than an animation has finished]]\r\n| style="background-color:#f8e8ff;" | Notification than an animation has finished |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Graphics.Updates the background container of the 2d panel|Updates the background container of the 2d panel]]\r\n| style="background-color:#f8e8ff;" | Updates the background container of the 2d panel | + | |- |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Graphics.Reconstructs and redraws the target component|Reconstructs and redraws the target component]]\r\n| style="background-color:#f8e8ff;" | Reconstructs and redraws the target component | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event Graphics.Updates the background container of the 2d panel|Updates the background container of the 2d panel]]\r\n| style="background-color:#f8e8ff;" | Updates the background container of the 2d panel |
+ | |- | ||
+ | | colspan="2" style="background-color:#f8e8ff;" | [[Event Graphics.Reconstructs and redraws the target component|Reconstructs and redraws the target component]]\r\n| style="background-color:#f8e8ff;" | Reconstructs and redraws the target component | ||
+ | |- | ||
|} | |} | ||
Line 651: | Line 1,037: | ||
{| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Keyboard.Sent to give a meaningful name to a button on a simulated mouse-click|Sent to give a meaningful name to a button on a simulated mouse-click]]\r\n| style="background-color:#f8e8ff;" | Sent to give a meaningful name to a button on a simulated mouse-click | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event Keyboard.Sent to give a meaningful name to a button on a simulated mouse-click|Sent to give a meaningful name to a button on a simulated mouse-click]]\r\n| style="background-color:#f8e8ff;" | Sent to give a meaningful name to a button on a simulated mouse-click |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Keyboard.Post when a mapped key is pressed for the component|Post when a mapped key is pressed for the component]]\r\n| style="background-color:#f8e8ff;" | Post when a mapped key is pressed for the component | + | |- |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Keyboard.Post when a mapped key is released for the component|Post when a mapped key is released for the component]]\r\n| style="background-color:#f8e8ff;" | Post when a mapped key is released for the component | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event Keyboard.Post when a mapped key is pressed for the component|Post when a mapped key is pressed for the component]]\r\n| style="background-color:#f8e8ff;" | Post when a mapped key is pressed for the component |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Keyboard.Sent to find out how many keys it is possible to map to the component during simulation|Sent to find out how many keys it is possible to map to the component during simulation]]\r\n| style="background-color:#f8e8ff;" | Sent to find out how many keys it is possible to map to the component during simulation | + | |- |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Keyboard.Sent to give a meaningful name to a custom key-map event for a component|Sent to give a meaningful name to a custom key-map event for a component]]\r\n| style="background-color:#f8e8ff;" | Sent to give a meaningful name to a custom key-map event for a component | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event Keyboard.Post when a mapped key is released for the component|Post when a mapped key is released for the component]]\r\n| style="background-color:#f8e8ff;" | Post when a mapped key is released for the component |
+ | |- | ||
+ | | colspan="2" style="background-color:#f8e8ff;" | [[Event Keyboard.Sent to find out how many keys it is possible to map to the component during simulation|Sent to find out how many keys it is possible to map to the component during simulation]]\r\n| style="background-color:#f8e8ff;" | Sent to find out how many keys it is possible to map to the component during simulation | ||
+ | |- | ||
+ | | colspan="2" style="background-color:#f8e8ff;" | [[Event Keyboard.Sent to give a meaningful name to a custom key-map event for a component|Sent to give a meaningful name to a custom key-map event for a component]]\r\n| style="background-color:#f8e8ff;" | Sent to give a meaningful name to a custom key-map event for a component | ||
+ | |- | ||
|} | |} | ||
Line 664: | Line 1,055: | ||
{| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Mouse.Post when the mouse is released on a child of the component during simulation|Post when the mouse is released on a child of the component during simulation]]\r\n| style="background-color:#f8e8ff;" | Post when the mouse is released on a child of the component during simulation | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event Mouse.Post when the mouse is released on a child of the component during simulation|Post when the mouse is released on a child of the component during simulation]]\r\n| style="background-color:#f8e8ff;" | Post when the mouse is released on a child of the component during simulation |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Mouse.Post when the mouse is clicked on a child of the component during simulation|Post when the mouse is clicked on a child of the component during simulation]]\r\n| style="background-color:#f8e8ff;" | Post when the mouse is clicked on a child of the component during simulation | + | |- |
− | | colspan="2" style="background-color:#f8e8ff;" | [[Event Mouse.Post when the mouse is dragged on a child of the component during simulation|Post when the mouse is dragged on a child of the component during simulation]]\r\n| style="background-color:#f8e8ff;" | Post when the mouse is dragged on a child of the component during simulation | + | | colspan="2" style="background-color:#f8e8ff;" | [[Event Mouse.Post when the mouse is clicked on a child of the component during simulation|Post when the mouse is clicked on a child of the component during simulation]]\r\n| style="background-color:#f8e8ff;" | Post when the mouse is clicked on a child of the component during simulation |
+ | |- | ||
+ | | colspan="2" style="background-color:#f8e8ff;" | [[Event Mouse.Post when the mouse is dragged on a child of the component during simulation|Post when the mouse is dragged on a child of the component during simulation]]\r\n| style="background-color:#f8e8ff;" | Post when the mouse is dragged on a child of the component during simulation | ||
+ | |- | ||
|} | |} | ||
Revision as of 15:48, 13 January 2023
Contents
Built in functions
Property | ||
Gets the value of a property as a string | ||
Sets a components 'color' property as a R,G,B value | ||
Sets a components property as a string | ||
Copies a property value from one target to another | ||
Sets all child components property as a string | ||
Copies the values of a properties children from the source to dest | ||
Sets whether the property is visible or not | ||
Sets whether the property can be edited in the UI or not | ||
Gets whether the property is visible or not | ||
Gets whether the property can be edited in the UI or not | ||
Gets a components property filter string for lists, files, etc | ||
Sets a components property filter string for lists, files, etc | ||
Copies a property filter from one target to another | ||
Gets a single lists index value from a property by line number | ||
Gets a single list entry from a property by named index | ||
Sets an existing list entries text for the property by named index | ||
Alters or appends a list entries text for the property by named index | ||
Returns the id of the panel hosting the component | ||
Sets whether a component can interact with the mouse | ||
Gets whether a component can interact with the mouse | ||
Sets whether a component can be seen on the panel | ||
Gets whether a component can be seen on the panel | ||
Sets whether a component is checked in collision detections | ||
Gets whether a component is checked in collision detections | ||
Sets whether a component is considered for compilation or not | ||
Gets whether a component will be compiled or not | ||
Gets the type-instance of the component, >= 1 is valid | ||
Finds a named object that is part of the component | ||
Gets the root component handle | ||
Gets the top-level owner of the component | ||
Gets the owner of the component | ||
Gets the next (younger) sibling of the components handle | ||
Gets the previous (elder) sibling of the components handle | ||
Gets the first (eldest) child of the component | ||
Gets the last (youngest) child of the component | ||
Gets the original definition of the component, returns Current if no original copy | ||
Clones an existing object to another position on the panel | ||
Deletes an existing object, removing it from the panel |
Returns the name of the panel from the id | ||
Returns the main background colour of the panel | ||
Gets the number of 2d panels | ||
Creates a new 2d panel | ||
Adds a new component to a panel | ||
Position | ||
Returns the positions coordinates in (X,Y,Z) array | ||
Returns the component size in (X,Y,Z) array | ||
Moves the object to the given coordinates in World coordinates | ||
Sets the objects size to a value | ||
Gets a handle to an object representing the components current position | ||
Gets a handle to an empty position | ||
Sets an objects position based on a component or pre-defined position | ||
Sets an objects coordinates based on a position | ||
Sets an objects scale based on a position | ||
Sets an objects orientation based on a position | ||
Gets a handle to an object representing the components bounding box position | ||
Returns the position of a line's nodes as a comma-separated list | ||
Sets the nodes of a line | ||
Blends positions from two sources to a destination | ||
Blends positions from two sources to a destination over time | ||
Stops all animations started by this component | ||
Moves the object by the given offset relative to its parent along an axis | ||
Moves the object by the given offset relative to its parent | ||
Moves the object to the given coordinates relative to its parent | ||
Sets the objects scale to a value | ||
Multiplies the objects scale by a value | ||
Divides the objects scale by a value | ||
Rotates the object to the given rotation | ||
Rotates the object by the given rotation along an axis | ||
Rotates the object around the X axis | ||
Rotates the object around the Y axis | ||
Rotates the object around the Z axis | ||
Returns the positions coordinates in (X,Y,Z) array | ||
Returns the positions scale in (X,Y,Z) array | ||
Returns the positions quaternion in (X,Y,Z,W) array | ||
Returns the positions euler angles in (P,Y,R) array | ||
Coordinate maths functions | ||
2D Panel functions | ||
Camera positioning for 3D panel | ||
PCloud | ||
Creates a new point cloud tied to a position handle | ||
Sets whether the point cloud is displayed or not | ||
Sets the position for the point cloud to be located at | ||
Gets the position the point cloud is located at | ||
Sets the X,Y,Z point lists | ||
Sets the X,Y,Z point lists | ||
Sets the X,Y,Z point lists in a height-map grid | ||
Sets the X,Y,Z point lists in a height-map grid | ||
Sets the X,Y,Z point lists in a flat height-map grid | ||
Given an XY on the grid, sets the vertex value at that point | ||
Creates a unit scaled axis (X, Y or Z) with a center of zero and a range of two | ||
Sets the RGB colour of the entire cloud | ||
Sets the RGB colour of the individual points in the cloud | ||
Given an XY on the grid, sets the vertex colour at that point | ||
Sets the rendering mode of the point cloud | ||
Enables or disables simple lighting for point mode, providing a normal passing through the point and (0,0,0) | ||
Manually refresh the screen the point cloud exists on | ||
LinkBar | ||
Creates a new bar linking a pair of position handles | ||
Sets whether the link is displayed or not | ||
Sets the position for the start point of the bar | ||
Sets the position for the end point of the bar | ||
Sets the clipping adjustments for the beginning of the link | ||
Sets the clipping adjustments for the end of the link | ||
Sets the graphic for the start point of the bar | ||
Sets the graphic for the main line of the bar | ||
Sets the graphic for the end point of the bar | ||
Gets the position the bars start point is located at | ||
Gets the position the bar is located at | ||
Gets the position the bars end point is located at | ||
Manually refresh the screen the bar exists on | ||
Sets whether Flowcode should automatically draw links for component object property types | ||
TextLabel | ||
Creates a new text label that always faces the camera | ||
Sets whether the label is displayed or not | ||
Sets the position for the point to draw the text at | ||
Sets the offset from the SetPos() position for the label | ||
Sets the text for the label | ||
Sets the multipliers for the width and height of the label | ||
Sets the foreground and background colours for the label | ||
Sets whether to draw at a fixed size or to scale based on distance from the camera | ||
Gets the position the label is located at | ||
Manually refresh the screen the label exists on | ||
Collision | ||
Tests whether an object collides with the table top, returns Z distance to move to rest on the table | ||
Tests whether an object collides with a position | ||
Tests whether an object collides with a position | ||
Returns the position to move Pos to so it does not collide with Test - null if no collide | ||
Tests whether an object collides with a position | ||
Returns the position to move Pos to so it does not collide with any other object - null if no collide | ||
Graphics | ||
Sends a redraw request to the given component | ||
Sets the draw colour for and subsequent graphics objects | ||
Sets the draw colour for and subsequent graphics objects | ||
Sets the text font for subsequent text objects | ||
Sets the text scale for subsequent text objects | ||
Sets the thinkness when drawing lines and points | ||
Creates a drawing area on a shape | ||
Begins drawing on a given shape | ||
Ends drawing started with DrawBegin() | ||
Deletes a drawing area for a shape | ||
Draws a line of text texture | ||
Draws a point on a texture | ||
Draws a line on a texture | ||
Draws a smooth line on a texture | ||
Draws a rectangle on a texture | ||
Draws a circle on a texture | ||
Clear texture to the given component | ||
Routines to change the last drawn shape |
Gets the button state from the mouse: 4 for left, 1 for right |
Gets the handle of the component under the mouse |
Gets the position of the mouse, intersecting with a component or the viewing plane |
Gets the X/Y position of the mouse in screen coords |
Gets the side of the component clicked on, 0 to 5 |
Simulates a click on an object |
Simulates a click-drag on an object |
Simulates a click-release on an object |
Simulates a key-press on an object |
Simulates a key-release on an object |
Gets a paths item value from the FCD document |
Gets a FCD items handle, suitable for traversal with the Tree API |
Gets a FCD paths handle, suitable for traversal with the Tree API |
Override item value from the FCD document from path |
Reset paths item value from the FCD document |
Plays a formatted file sound, returns true if the sound played OK |
Loads a wave file into memory, providing the values needed to play it |
Creates a sound object that data can be played through |
Sets the volume of playbacks for this sound |
Gets the volume of playbacks for this sound in the range 0 to 1 |
Gets the number of bits per sample for the sound |
Gets the current sample rate for the sound |
Sets the current sample rate for the sound - this will stop the playing sound |
Queues a sound for playing |
Queues a sound for playing, with the format provided |
Stops all playing and queued sounds |
Gets the number of sample blocks queued or playing for the sound |
Adds a group to the scope to which streams may be added |
Sets the visibility of the given group |
Adds a stream to the given group suitable for inputs and operations |
Adds a fixed-view stream to the given group suitable for inputs and operations |
Renames the given scope group, stream or buffer |
Sets the labels for the Y-axis of the given stream |
Sets the group, stream or buffers line colour |
Gets the streams line colour |
Sets the groups background colour |
Gets the stream groups background colour |
Sets whether a stream can be decoded via the components event - defaults to 'true' |
Gets whether a stream can be decoded via the components event - defaults to 'true' |
Adds an input to the stream from a port |
Adds an input to the stream from an analog channel |
Adds an input to the stream from a custom injection |
Adds an operation to act on the inputs of the stream |
Clears all inputs and operations from the given stream |
Sets the contents of a snapshot stream |
Sets one of 32 custom analog values for the group |
Gets a block of the output stream with each input sample operated on, returns number of samples read |
Searches back through the output history for a value, returns offset of found sample from TimeUS, 0 if not found |
Attempts to calculate the wave period given a series of transitions for the stream, returns calculated period |
Sets the graphical format of the packets added with AddPacket and Add...Packets |
Returns the graphical format of the packets added with AddPacket and Add...Packets |
Adds an overlay packet to the stream at a given offset from the current time |
Adds overlay packets to the stream by decoding the stream contents with a fixed period rate |
Adds overlay packets to the stream by decoding the stream contents with a variable period rate |
Clears existing overlay packets from the stream |
Clears all existing overlay packets from the stream |
Converts a duration in ticks into a time in seconds |
Converts a time in seconds into a duration in ticks |
Converts a float to an array containing 4 bytes |
Returns a float value from an unsigned long representation (used to store or transfer it) |
Calculates the frequency from an array of data. |
Calculates the amplitude from an array of data. |
Adds a window to the list of consoles available |
Adds a window to the list of consoles available |
Gets the default (read-only) console window |
Gets a console window |
Returns the name of a console |
Renames the given console |
Sets whether to show address and bytes for the console |
Sets the colour of text inserted by the user from now on |
Sets the colour of text inserted by the component from now on |
Adds a block of text to the console window |
Reads a line of text from the given console, pass -1 for final line |
Writes a line of text from the given console, pass -1 for final line |
Reads a line of bytes from the given console extending the array if needed |
Writes a line of bytes from the given console, pass -1 for final line |
Counts the number of lines in the console |
Clears all the text in the console |
Gets a ports value from its index |
Sets a ports value from its index |
Gets an analog value from its channel index |
Sets an analog value from its index, range 0->1 |
Gets a ports details from its name or index |
Expands a string using the built-in pathname expansion variables |
Expands a string to the name of a macro used in the generated code |
Expands a string to the name of a global variable used in the generated code |
Expands a string to the name of a property used in the generated code |
Expands a macro name to the code generated for the header of that macro |
Expands a macro name to the code generated for the body of that macro |
Expands a macro name to the code generated for the tail of that macro |
Gets the value of the given object, if available |
Gets the name of the given object |
Gets the full '.' separated name of the given object |
Gets the value of a named sub-item of the given object, if available |
Updates the object to step depth-first through the tree |
Updates the object to point to the next (younger) sibling |
Updates the object to point to the next (younger) sibling matching the name |
Updates the object to point to the Nth next (younger) sibling matching the name |
Updates the object to point to the last (elder) sibling |
Updates the object to point to its parent object |
Updates the object to point to the root of the tree |
Updates the object to point to the head (eldest) child |
Updates the object to point to the tail (youngest) child |
Updates the object to point to the '.' separated named child path |
Returns the number of immediate children present for the object |
Returns true if the object has children, else false |
Returns the number of immediate children present for the object |
Returns true if the object has a parent, else false if it is the root |
Updates the object to point to the head (eldest) attribute, if any |
Updates the object to point to the tail (youngest) attribute, if any |
Updates the object to point to the named attribute, if any |
Creates a copy of the handle and returns the copy |
Gets an absolute path from a relative filename | ||
Gets an relative path from an absolute filename | ||
Creates a directory structure | ||
Finds the type of a file: 0=Unknown, 1=File, 2=Dir, 4=Disk | ||
Gets the number of bytes in the file, by handle or name | ||
Deletes the file or directory structure | ||
Creates the new file as a standard stream | ||
Opens the existing file as a standard stream | ||
Reads an array from the file, returns elements read | ||
Writes an array to the file | ||
Sets the position of the next read or write in the file | ||
Gets the position of the next read or write in the file | ||
Writes all unwritten data to the file in one block | ||
Buffer | ||
Opens the existing file as a circular buffer | ||
Creates the new file as a circular buffer | ||
Reads a single byte from the input stream, -1 if empty | ||
Writes a single byte to the input stream | ||
Reads an array from the input stream, returns elements read | ||
Writes an array to the input stream | ||
NVM | ||
Opens the existing file as a block of non-volatile memory | ||
Creates the new file as a block of non-volatile memory | ||
Reads a single byte from the NVM, -1 if empty | ||
Writes a single byte to the NVM multiple times | ||
Reads an array from the NVM, returns elements read | ||
Writes an array to the NVM |
Displays a simple 'Ok' message box |
Invokes the Win32 API MessageBox function |
Displays a simple 'Yes/No' message box |
Displays a simple 'Yes/No/Cancel' message box (0 == Cancel, 1 == No, 2 == Yes) |
Displays a message box that allows the user to input text. Returns true if 'Ok' clicked, false otherwise |
Returns the value of a monotonic non-decrementing millisecond counter |
Returns the current UTC Modified Julian Date value |
Returns the current local time as a Modified Julian Date value |
Increments or decrements a Modified Julian Date and millisecond value |
Converts a Modified Julian Date into a Gregorian calendar date |
Converts a Gregorian calendar date into a Modified Julian Date |
Converts a Modified Julian Date into a number of seconds since a specified epoch |
Returns the Modified Julian Date given by the number of seconds since a specified epoch |
Gets the day of the week that the MJD represents |
Returns true if the given year is a leap year, else false |
Returns the number of days in the given month |
Takes English text and optional hint and converts to the current language |
Sends a System.User message to the targeted component |
Sends the currently processing message to the target |
Returns true if the macro exists |
Calls a macro |
Given a handle to an object with viewable presence, shows that object on screen |
Creates a general-purpose garbage collected handle for resource management |
Sets a general purpose word in the handle for use by its owner |
Gets a general-purpose word set by the owner of a custom handle |
Deletes any handle created by the component |
Gets the handle of the component that posted this event - 0 for system |
Calls the Component.Timer event with Ident as an argument after Millisecs time |
Kills any timers with the given ident for this component |
Enables or disables the software watchdog during long operations |
Claims an event message by name, returns true if claimed |
Releases a previously claimed an event message by name, returns true if released |
Allows an event to be fired or removes the ability for an event to fire - this may be nested |
Claims mouse clicks for the target object |
Releases mouse clicks for the target object |
Allows calls to one of your children to be redirected to another component |
Start the simulation engine |
Stop the simulation engine |
Sets the speed the simulation engine |
Sets the clipboard with text data |
Reads text data from the clipboard |
Checks to see if a Flowcode window has the focus |
Launches an external file or program on this computer |
Writes an integer value to the registry |
Writes a string value to the registry |
Reads an integer value from the registry |
Reads a string value from the registry |
Prints out the string or value on a line in the debug window |
Prints out the string or value with a new-line in the debug window |
Temporary debug function |
Events
Broadcast to all components immediately before compilation is started\r\n| style="background-color:#f8e8ff;" | Broadcast to all components immediately before compilation is started | |
Sent to a component to allow dynamic amendment of global property declarations\r\n| style="background-color:#f8e8ff;" | Sent to a component to allow dynamic amendment of global property declarations | |
Sent to a component to allow dynamic amendment of global variable declarations\r\n| style="background-color:#f8e8ff;" | Sent to a component to allow dynamic amendment of global variable declarations | |
Sent to a component to allow dynamic amendment of global array-size declarations\r\n| style="background-color:#f8e8ff;" | Sent to a component to allow dynamic amendment of global array-size declarations | |
Sent to a component to allow dynamic amendment of global constant declarations\r\n| style="background-color:#f8e8ff;" | Sent to a component to allow dynamic amendment of global constant declarations | |
Sent to a component to allow dynamic amendment of header code\r\n| style="background-color:#f8e8ff;" | Sent to a component to allow dynamic amendment of header code | |
Sent to a component to allow dynamic amendment of the interrupts for a component\r\n| style="background-color:#f8e8ff;" | Sent to a component to allow dynamic amendment of the interrupts for a component | |
Sent to a component to allow dynamic amendment of a single interrupts code\r\n| style="background-color:#f8e8ff;" | Sent to a component to allow dynamic amendment of a single interrupts code | |
Broadcast to all components that compilation is starting\r\n| style="background-color:#f8e8ff;" | Broadcast to all components that compilation is starting | |
Broadcast to all components that compilation has stopped\r\n| style="background-color:#f8e8ff;" | Broadcast to all components that compilation has stopped | |
Sent to a component to amend the size of the expected array\r\n| style="background-color:#f8e8ff;" | Sent to a component to amend the size of the expected array | |
Sent to a component to retrieve tags to be placed in the html body\r\n| style="background-color:#f8e8ff;" | Sent to a component to retrieve tags to be placed in the html body | |
Sent to a component to retrieve script code to be placed in the html header section\r\n| style="background-color:#f8e8ff;" | Sent to a component to retrieve script code to be placed in the html header section |
Sent when a property has been changed by the User (specific property and value identified)\r\n| style="background-color:#f8e8ff;" | Sent when a property has been changed by the User (specific property and value identified) | |
Sent when a property has been changed by the User\r\n| style="background-color:#f8e8ff;" | Sent when a property has been changed by the User | |
Sent to the component when the project is closing\r\n| style="background-color:#f8e8ff;" | Sent to the component when the project is closing | |
Broadcast to all existing components once a new component has been added\r\n| style="background-color:#f8e8ff;" | Broadcast to all existing components once a new component has been added | |
Broadcast to all existing components when a new component is about to be added\r\n| style="background-color:#f8e8ff;" | Broadcast to all existing components when a new component is about to be added | |
Sent to the mouse target when the user has altered the position of a component child\r\n| style="background-color:#f8e8ff;" | Sent to the mouse target when the user has altered the position of a component child | |
Broadcast to all remaining components after a component has been removed\r\n| style="background-color:#f8e8ff;" | Broadcast to all remaining components after a component has been removed | |
Broadcast to all existing components when a component is about to be removed\r\n| style="background-color:#f8e8ff;" | Broadcast to all existing components when a component is about to be removed | |
Sent to the component when the component is renamed\r\n| style="background-color:#f8e8ff;" | Sent to the component when the component is renamed | |
Closedown routine for the component\r\n| style="background-color:#f8e8ff;" | Closedown routine for the component | |
Send to a component when it is being deleted\r\n| style="background-color:#f8e8ff;" | Send to a component when it is being deleted | |
Initialisation routine for the component once the component is linked to its parent\r\n| style="background-color:#f8e8ff;" | Initialisation routine for the component once the component is linked to its parent | |
Initialisation routine before the component is linked to its parent\r\n| style="background-color:#f8e8ff;" | Initialisation routine before the component is linked to its parent |
Post to the owning component when a line is inserted by the user\r\n| style="background-color:#f8e8ff;" | Post to the owning component when a line is inserted by the user | |
Post when the console text is changed by the user in some way\r\n| style="background-color:#f8e8ff;" | Post when the console text is changed by the user in some way | |
Post when the console memory is changed by the user in some way\r\n| style="background-color:#f8e8ff;" | Post when the console memory is changed by the user in some way |
Sent when auto-populate of digital connections is requested\r\n| style="background-color:#f8e8ff;" | Sent when auto-populate of digital connections is requested | |
Sent during simulation if a connected port pin changes\r\n| style="background-color:#f8e8ff;" | Sent during simulation if a connected port pin changes | |
Sent when auto-populate of analog connections is requested\r\n| style="background-color:#f8e8ff;" | Sent when auto-populate of analog connections is requested | |
Sent during simulation if a connected ADC channel changes\r\n| style="background-color:#f8e8ff;" | Sent during simulation if a connected ADC channel changes | |
Sent when the target device has changed\r\n| style="background-color:#f8e8ff;" | Sent when the target device has changed | |
Sent when the component is compiled with unconnected pins\r\n| style="background-color:#f8e8ff;" | Sent when the component is compiled with unconnected pins | |
Sent when some settings of the target device have changed\r\n| style="background-color:#f8e8ff;" | Sent when some settings of the target device have changed |
Broadcast to all components that simulation has paused\r\n| style="background-color:#f8e8ff;" | Broadcast to all components that simulation has paused | |
Broadcast to all components that simulation has resumed\r\n| style="background-color:#f8e8ff;" | Broadcast to all components that simulation has resumed | |
Broadcast to all components that simulation is starting\r\n| style="background-color:#f8e8ff;" | Broadcast to all components that simulation is starting | |
Broadcast to all components that simulation has stopped\r\n| style="background-color:#f8e8ff;" | Broadcast to all components that simulation has stopped |
Called when a custom handle is deleted to allow cleanup of resources\r\n| style="background-color:#f8e8ff;" | Called when a custom handle is deleted to allow cleanup of resources | |
Called back on the panel command System.TimerStart\r\n| style="background-color:#f8e8ff;" | Called back on the panel command System.TimerStart | |
Called back on the panel command System.Notify\r\n| style="background-color:#f8e8ff;" | Called back on the panel command System.Notify | |
Broadcast after a project has finished loading\r\n| style="background-color:#f8e8ff;" | Broadcast after a project has finished loading |
Sent when a sound queued by the component has finished playing\r\n| style="background-color:#f8e8ff;" | Sent when a sound queued by the component has finished playing |
Sent when Packet_ResyncEv is specified in scope decoding\r\n| style="background-color:#f8e8ff;" | Sent when Packet_ResyncEv is specified in scope decoding | |
Sent when a block of the stream is to be decoded into packets\r\n| style="background-color:#f8e8ff;" | Sent when a block of the stream is to be decoded into packets | |
Sent when a %e is read in a format string when decoding a packet\r\n| style="background-color:#f8e8ff;" | Sent when a %e is read in a format string when decoding a packet | |
Sent when the mouse hovers over a scope stream\r\n| style="background-color:#f8e8ff;" | Sent when the mouse hovers over a scope stream |
Called when a tooltip graphic is updating with the draw image already pushed\r\n| style="background-color:#f8e8ff;" | Called when a tooltip graphic is updating with the draw image already pushed | |
Called when a tooltip text string can be displayed\r\n| style="background-color:#f8e8ff;" | Called when a tooltip text string can be displayed | |
Called when a tooltip graphic can be displayed with the draw image already pushed\r\n| style="background-color:#f8e8ff;" | Called when a tooltip graphic can be displayed with the draw image already pushed |
Sent when a file being watched has changed\r\n| style="background-color:#f8e8ff;" | Sent when a file being watched has changed | |
Sent when a file monitor is being closed\r\n| style="background-color:#f8e8ff;" | Sent when a file monitor is being closed |
Notification than an animation has finished\r\n| style="background-color:#f8e8ff;" | Notification than an animation has finished | |
Updates the background container of the 2d panel\r\n| style="background-color:#f8e8ff;" | Updates the background container of the 2d panel | |
Reconstructs and redraws the target component\r\n| style="background-color:#f8e8ff;" | Reconstructs and redraws the target component |
Sent to give a meaningful name to a button on a simulated mouse-click\r\n| style="background-color:#f8e8ff;" | Sent to give a meaningful name to a button on a simulated mouse-click | |
Post when a mapped key is pressed for the component\r\n| style="background-color:#f8e8ff;" | Post when a mapped key is pressed for the component | |
Post when a mapped key is released for the component\r\n| style="background-color:#f8e8ff;" | Post when a mapped key is released for the component | |
Sent to find out how many keys it is possible to map to the component during simulation\r\n| style="background-color:#f8e8ff;" | Sent to find out how many keys it is possible to map to the component during simulation | |
Sent to give a meaningful name to a custom key-map event for a component\r\n| style="background-color:#f8e8ff;" | Sent to give a meaningful name to a custom key-map event for a component |
Post when the mouse is released on a child of the component during simulation\r\n| style="background-color:#f8e8ff;" | Post when the mouse is released on a child of the component during simulation | |
Post when the mouse is clicked on a child of the component during simulation\r\n| style="background-color:#f8e8ff;" | Post when the mouse is clicked on a child of the component during simulation | |
Post when the mouse is dragged on a child of the component during simulation\r\n| style="background-color:#f8e8ff;" | Post when the mouse is dragged on a child of the component during simulation |