Difference between revisions of "Simulation Functionality"
From Flowcode Help
Jump to navigationJump to search(4 intermediate revisions by the same user not shown) | |||
Line 12: | Line 12: | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.GetValue|GetValue]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.GetValue|GetValue]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the value of a property as a string |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.SetColor|SetColor]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.SetColor|SetColor]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets a components 'color' property as a R,G,B value |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.SetValue|SetValue]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.SetValue|SetValue]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets a components property as a string |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.CopyValue|CopyValue]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.CopyValue|CopyValue]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Copies a property value from one target to another |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.SetChildValues|SetChildValues]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.SetChildValues|SetChildValues]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets all child components property as a string |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.CopyChildValues|CopyChildValues]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.CopyChildValues|CopyChildValues]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Copies the values of a properties children from the source to dest |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.SetVisible|SetVisible]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.SetVisible|SetVisible]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets whether the property is visible or not |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.SetWritable|SetWritable]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.SetWritable|SetWritable]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets whether the property can be edited in the UI or not |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.GetVisible|GetVisible]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.GetVisible|GetVisible]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets whether the property is visible or not |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.GetWritable|GetWritable]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.GetWritable|GetWritable]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets whether the property can be edited in the UI or not |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.GetFilter|GetFilter]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.GetFilter|GetFilter]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets a components property filter string for lists, files, etc |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.SetFilter|SetFilter]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.SetFilter|SetFilter]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets a components property filter string for lists, files, etc |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.CopyFilter|CopyFilter]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.CopyFilter|CopyFilter]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Copies a property filter from one target to another |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.GetListIndex|GetListIndex]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.GetListIndex|GetListIndex]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets a single lists index value from a property by line number |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.GetListItem|GetListItem]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.GetListItem|GetListItem]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets a single list entry from a property by named index |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.SetListItem|SetListItem]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.SetListItem|SetListItem]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets an existing list entries text for the property by named index |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.AddListItem|AddListItem]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.Property.AddListItem|AddListItem]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Alters or appends a list entries text for the property by named index |
|- | |- | ||
− | | colspan="2" style="background-color:#FFFFFF;" | [[API Component | + | |} |
− | | style="background-color:# | + | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" |
+ | |- | ||
+ | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.GetPanel|GetPanel]] | ||
+ | | style="background-color:#FFFFFF;" | Returns the id of the panel hosting the component | ||
|- | |- | ||
− | | colspan="2" style="background-color:#FFFFFF;" | [[API Component | + | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.SetInteractive|SetInteractive]] |
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets whether a component can interact with the mouse |
|- | |- | ||
− | | colspan="2" style="background-color:#FFFFFF;" | [[API Component | + | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.GetInteractive|GetInteractive]] |
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets whether a component can interact with the mouse |
|- | |- | ||
− | | colspan="2" style="background-color:#FFFFFF;" | [[API Component | + | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.SetVisible|SetVisible]] |
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets whether a component can be seen on the panel |
|- | |- | ||
− | | colspan="2" style="background-color:#FFFFFF;" | [[API Component | + | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.GetVisible|GetVisible]] |
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets whether a component can be seen on the panel |
|- | |- | ||
− | | colspan="2" style="background-color:#FFFFFF;" | [[API Component | + | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.SetSolid|SetSolid]] |
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets whether a component is checked in collision detections |
|- | |- | ||
− | | colspan="2" style="background-color:#FFFFFF;" | [[API Component | + | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.GetSolid|GetSolid]] |
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets whether a component is checked in collision detections |
|- | |- | ||
− | | colspan="2" style="background-color:#FFFFFF;" | [[API Component | + | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.SetCompile|SetCompile]] |
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets whether a component is considered for compilation or not |
|- | |- | ||
− | | colspan="2" style="background-color:#FFFFFF;" | [[API Component | + | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.GetCompile|GetCompile]] |
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets whether a component will be compiled or not |
|- | |- | ||
− | | colspan="2" style="background-color:#FFFFFF;" | [[API Component | + | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.GetInstance|GetInstance]] |
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the type-instance of the component, >= 1 is valid |
|- | |- | ||
− | | colspan="2" style="background-color:#FFFFFF;" | [[API Component | + | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.FindChild|FindChild]] |
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Finds a named object that is part of the component |
|- | |- | ||
− | | colspan="2" style="background-color:#FFFFFF;" | [[API Component | + | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.GetRoot|GetRoot]] |
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the root component handle |
|- | |- | ||
− | | colspan="2" style="background-color:#FFFFFF;" | [[API Component | + | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.GetTopParent|GetTopParent]] |
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the top-level owner of the component |
|- | |- | ||
− | | colspan="2" style="background-color:#FFFFFF;" | [[API Component | + | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.GetParent|GetParent]] |
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the owner of the component |
|- | |- | ||
− | | colspan="2" style="background-color:#FFFFFF;" | [[API Component | + | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.GetNext|GetNext]] |
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the next (younger) sibling of the components handle |
|- | |- | ||
− | | colspan="2" style="background-color:#FFFFFF;" | [[API Component | + | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.GetLast|GetLast]] |
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the previous (elder) sibling of the components handle |
|- | |- | ||
− | | colspan="2" style="background-color:#FFFFFF;" | [[API Component | + | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.GetChildHead|GetChildHead]] |
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the first (eldest) child of the component |
|- | |- | ||
− | | colspan="2" style="background-color:#FFFFFF;" | [[API Component | + | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.GetChildTail|GetChildTail]] |
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the last (youngest) child of the component |
|- | |- | ||
− | | colspan="2" style="background-color:#FFFFFF;" | [[API Component | + | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.GetOriginal|GetOriginal]] |
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the original definition of the component, returns Current if no original copy |
|- | |- | ||
− | | colspan="2" style="background-color:#FFFFFF;" | [[API Component | + | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.Clone|Clone]] |
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Clones an existing object to another position on the panel |
|- | |- | ||
− | | colspan="2" style="background-color:#FFFFFF;" | [[API Component | + | | colspan="2" style="background-color:#FFFFFF;" | [[API Component.Delete|Delete]] |
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Deletes an existing object, removing it from the panel |
|- | |- | ||
|} | |} | ||
Line 134: | Line 137: | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.GetPanelName|GetPanelName]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.GetPanelName|GetPanelName]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Returns the name of the panel from the id |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.GetPanelBkColour|GetPanelBkColour]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.GetPanelBkColour|GetPanelBkColour]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Returns the main background colour of the panel |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Get2dPanelCount|Get2dPanelCount]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Get2dPanelCount|Get2dPanelCount]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the number of 2d panels |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Create2dPanel|Create2dPanel]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Create2dPanel|Create2dPanel]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Creates a new 2d panel |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.AddNewComponent|AddNewComponent]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.AddNewComponent|AddNewComponent]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Adds a new component to a panel |
+ | |- | ||
+ | |} | ||
+ | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
| colspan="3" align="center" style="background-color:#EAE1EA;" | Position | | colspan="3" align="center" style="background-color:#EAE1EA;" | Position | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.GetWorldPosition|GetWorldPosition]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.GetWorldPosition|GetWorldPosition]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Returns the positions coordinates in (X,Y,Z) array |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.GetWorldSize|GetWorldSize]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.GetWorldSize|GetWorldSize]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Returns the component size in (X,Y,Z) array |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.SetWorldPosition|SetWorldPosition]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.SetWorldPosition|SetWorldPosition]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Moves the object to the given coordinates in World coordinates |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.SetWorldSize|SetWorldSize]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.SetWorldSize|SetWorldSize]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the objects size to a value |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.Get|Get]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.Get|Get]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets a handle to an object representing the components current position |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.GetOrigin|GetOrigin]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.GetOrigin|GetOrigin]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets a handle to an empty position |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.Set|Set]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.Set|Set]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets an objects position based on a component or pre-defined position |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.SetCoords|SetCoords]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.SetCoords|SetCoords]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets an objects coordinates based on a position |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.SetScale|SetScale]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.SetScale|SetScale]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets an objects scale based on a position |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.SetRotation|SetRotation]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.SetRotation|SetRotation]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets an objects orientation based on a position |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.GetBox|GetBox]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.GetBox|GetBox]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets a handle to an object representing the components bounding box position |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.GetLineNodes|GetLineNodes]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.GetLineNodes|GetLineNodes]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Returns the position of a line's nodes as a comma-separated list |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.SetLineNodes|SetLineNodes]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.SetLineNodes|SetLineNodes]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the nodes of a line |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.Morph|Morph]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.Morph|Morph]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Blends positions from two sources to a destination |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.Animate|Animate]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.Animate|Animate]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Blends positions from two sources to a destination over time |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.StopAnimate|StopAnimate]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.StopAnimate|StopAnimate]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Stops all animations started by this component |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.MoveAlong|MoveAlong]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.MoveAlong|MoveAlong]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Moves the object by the given offset relative to its parent along an axis |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.MoveBy|MoveBy]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.MoveBy|MoveBy]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Moves the object by the given offset relative to its parent |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.MoveTo|MoveTo]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.MoveTo|MoveTo]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Moves the object to the given coordinates relative to its parent |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.ScaleTo|ScaleTo]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.ScaleTo|ScaleTo]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the objects scale to a value |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.ScaleUp|ScaleUp]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.ScaleUp|ScaleUp]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Multiplies the objects scale by a value |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.ScaleDown|ScaleDown]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.ScaleDown|ScaleDown]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Divides the objects scale by a value |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.RotateTo|RotateTo]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.RotateTo|RotateTo]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Rotates the object to the given rotation |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.RotateAlong|RotateAlong]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.RotateAlong|RotateAlong]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Rotates the object by the given rotation along an axis |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.RotateX|RotateX]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.RotateX|RotateX]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Rotates the object around the X axis |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.RotateY|RotateY]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.RotateY|RotateY]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Rotates the object around the Y axis |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.RotateZ|RotateZ]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.RotateZ|RotateZ]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Rotates the object around the Z axis |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.GetCoords|GetCoords]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.GetCoords|GetCoords]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Returns the positions coordinates in (X,Y,Z) array |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.GetScale|GetScale]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.GetScale|GetScale]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Returns the positions scale in (X,Y,Z) array |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.GetQuat|GetQuat]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.GetQuat|GetQuat]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Returns the positions quaternion in (X,Y,Z,W) array |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.GetEuler|GetEuler]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.GetEuler|GetEuler]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Returns the positions euler angles in (P,Y,R) array |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.Math|Math]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.Math|Math]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Coordinate maths functions |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.Panel2D|Panel2D]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.Panel2D|Panel2D]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | 2D Panel functions |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.Camera|Camera]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Position.Camera|Camera]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Camera positioning for 3D panel |
+ | |- | ||
+ | |} | ||
+ | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
| colspan="3" align="center" style="background-color:#EAE1EA;" | PCloud | | colspan="3" align="center" style="background-color:#EAE1EA;" | PCloud | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.Create|Create]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.Create|Create]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Creates a new point cloud tied to a position handle |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.SetVisible|SetVisible]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.SetVisible|SetVisible]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets whether the point cloud is displayed or not |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.SetPos|SetPos]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.SetPos|SetPos]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the position for the point cloud to be located at |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.GetPos|GetPos]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.GetPos|GetPos]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the position the point cloud is located at |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.SetPoints|SetPoints]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.SetPoints|SetPoints]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the X,Y,Z point lists |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.SetPointsEx|SetPointsEx]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.SetPointsEx|SetPointsEx]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the X,Y,Z point lists |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.SetGrid|SetGrid]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.SetGrid|SetGrid]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the X,Y,Z point lists in a height-map grid |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.SetGridEx|SetGridEx]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.SetGridEx|SetGridEx]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the X,Y,Z point lists in a height-map grid |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.SetGridFlat|SetGridFlat]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.SetGridFlat|SetGridFlat]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the X,Y,Z point lists in a flat height-map grid |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.SetGridPoint|SetGridPoint]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.SetGridPoint|SetGridPoint]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Given an XY on the grid, sets the vertex value at that point |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.UnitScale|UnitScale]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.UnitScale|UnitScale]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Creates a unit scaled axis (X, Y or Z) with a center of zero and a range of two |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.SetColor|SetColor]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.SetColor|SetColor]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the RGB colour of the entire cloud |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.SetColors|SetColors]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.SetColors|SetColors]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the RGB colour of the individual points in the cloud |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.SetGridColor|SetGridColor]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.SetGridColor|SetGridColor]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Given an XY on the grid, sets the vertex colour at that point |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.SetMode|SetMode]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.SetMode|SetMode]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the rendering mode of the point cloud |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.SetPointLight|SetPointLight]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.SetPointLight|SetPointLight]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Enables or disables simple lighting for point mode, providing a normal passing through the point and (0,0,0) |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.Update|Update]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.PCloud.Update|Update]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Manually refresh the screen the point cloud exists on |
+ | |- | ||
+ | |} | ||
+ | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
| colspan="3" align="center" style="background-color:#EAE1EA;" | LinkBar | | colspan="3" align="center" style="background-color:#EAE1EA;" | LinkBar | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.LinkBar.Create|Create]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.LinkBar.Create|Create]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Creates a new bar linking a pair of position handles |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.LinkBar.SetVisible|SetVisible]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.LinkBar.SetVisible|SetVisible]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets whether the link is displayed or not |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.LinkBar.SetStartPos|SetStartPos]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.LinkBar.SetStartPos|SetStartPos]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the position for the start point of the bar |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.LinkBar.SetEndPos|SetEndPos]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.LinkBar.SetEndPos|SetEndPos]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the position for the end point of the bar |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.LinkBar.SetStartAdjustment|SetStartAdjustment]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.LinkBar.SetStartAdjustment|SetStartAdjustment]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the clipping adjustments for the beginning of the link |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.LinkBar.SetEndAdjustment|SetEndAdjustment]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.LinkBar.SetEndAdjustment|SetEndAdjustment]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the clipping adjustments for the end of the link |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.LinkBar.SetStartGfx|SetStartGfx]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.LinkBar.SetStartGfx|SetStartGfx]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the graphic for the start point of the bar |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.LinkBar.SetBarGfx|SetBarGfx]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.LinkBar.SetBarGfx|SetBarGfx]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the graphic for the main line of the bar |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.LinkBar.SetEndGfx|SetEndGfx]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.LinkBar.SetEndGfx|SetEndGfx]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the graphic for the end point of the bar |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.LinkBar.GetStartPos|GetStartPos]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.LinkBar.GetStartPos|GetStartPos]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the position the bars start point is located at |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.LinkBar.GetBarPos|GetBarPos]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.LinkBar.GetBarPos|GetBarPos]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the position the bar is located at |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.LinkBar.GetEndPos|GetEndPos]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.LinkBar.GetEndPos|GetEndPos]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the position the bars end point is located at |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.LinkBar.Update|Update]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.LinkBar.Update|Update]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Manually refresh the screen the bar exists on |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.LinkBar.EnableAuto|EnableAuto]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.LinkBar.EnableAuto|EnableAuto]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets whether Flowcode should automatically draw links for component object property types |
+ | |- | ||
+ | |} | ||
+ | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
| colspan="3" align="center" style="background-color:#EAE1EA;" | TextLabel | | colspan="3" align="center" style="background-color:#EAE1EA;" | TextLabel | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.TextLabel.Create|Create]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.TextLabel.Create|Create]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Creates a new text label that always faces the camera |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.TextLabel.SetVisible|SetVisible]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.TextLabel.SetVisible|SetVisible]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets whether the label is displayed or not |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.TextLabel.SetPos|SetPos]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.TextLabel.SetPos|SetPos]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the position for the point to draw the text at |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.TextLabel.SetOffset|SetOffset]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.TextLabel.SetOffset|SetOffset]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the offset from the SetPos() position for the label |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.TextLabel.SetText|SetText]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.TextLabel.SetText|SetText]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the text for the label |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.TextLabel.SetScale|SetScale]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.TextLabel.SetScale|SetScale]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the multipliers for the width and height of the label |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.TextLabel.SetColors|SetColors]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.TextLabel.SetColors|SetColors]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the foreground and background colours for the label |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.TextLabel.SetViewMode|SetViewMode]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.TextLabel.SetViewMode|SetViewMode]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets whether to draw at a fixed size or to scale based on distance from the camera |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.TextLabel.GetPos|GetPos]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.TextLabel.GetPos|GetPos]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the position the label is located at |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.TextLabel.Update|Update]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.TextLabel.Update|Update]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Manually refresh the screen the label exists on |
+ | |- | ||
+ | |} | ||
+ | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
| colspan="3" align="center" style="background-color:#EAE1EA;" | Collision | | colspan="3" align="center" style="background-color:#EAE1EA;" | Collision | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Collision.TestTable|TestTable]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Collision.TestTable|TestTable]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Tests whether an object collides with the table top, returns Z distance to move to rest on the table |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Collision.TestSingle|TestSingle]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Collision.TestSingle|TestSingle]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Tests whether an object collides with a position |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Collision.GetSingleAxis|GetSingleAxis]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Collision.GetSingleAxis|GetSingleAxis]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Tests whether an object collides with a position |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Collision.GetSinglePos|GetSinglePos]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Collision.GetSinglePos|GetSinglePos]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Returns the position to move Pos to so it does not collide with Test - null if no collide |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Collision.GetMultiAxis|GetMultiAxis]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Collision.GetMultiAxis|GetMultiAxis]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Tests whether an object collides with a position |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Collision.GetMultiPos|GetMultiPos]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Collision.GetMultiPos|GetMultiPos]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Returns the position to move Pos to so it does not collide with any other object - null if no collide |
+ | |- | ||
+ | |} | ||
+ | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
| colspan="3" align="center" style="background-color:#EAE1EA;" | Graphics | | colspan="3" align="center" style="background-color:#EAE1EA;" | Graphics | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.Redraw|Redraw]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.Redraw|Redraw]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sends a redraw request to the given component |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.SetColor|SetColor]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.SetColor|SetColor]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the draw colour for and subsequent graphics objects |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.SetColorRGB|SetColorRGB]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.SetColorRGB|SetColorRGB]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the draw colour for and subsequent graphics objects |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.SetTextFont|SetTextFont]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.SetTextFont|SetTextFont]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the text font for subsequent text objects |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.SetTextScale|SetTextScale]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.SetTextScale|SetTextScale]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the text scale for subsequent text objects |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.SetLineThickness|SetLineThickness]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.SetLineThickness|SetLineThickness]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the thinkness when drawing lines and points |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.DrawCreate|DrawCreate]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.DrawCreate|DrawCreate]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Creates a drawing area on a shape |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.DrawBegin|DrawBegin]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.DrawBegin|DrawBegin]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Begins drawing on a given shape |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.DrawEnd|DrawEnd]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.DrawEnd|DrawEnd]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Ends drawing started with DrawBegin() |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.DrawDelete|DrawDelete]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.DrawDelete|DrawDelete]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Deletes a drawing area for a shape |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.DrawText|DrawText]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.DrawText|DrawText]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Draws a line of text texture |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.DrawPoint|DrawPoint]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.DrawPoint|DrawPoint]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Draws a point on a texture |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.DrawLine|DrawLine]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.DrawLine|DrawLine]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Draws a line on a texture |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.DrawLineA|DrawLineA]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.DrawLineA|DrawLineA]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Draws a smooth line on a texture |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.DrawRect|DrawRect]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.DrawRect|DrawRect]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Draws a rectangle on a texture |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.DrawCircle|DrawCircle]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.DrawCircle|DrawCircle]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Draws a circle on a texture |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.Clear|Clear]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.Clear|Clear]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Clear texture to the given component |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.Shape|Shape]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Panel.Graphics.Shape|Shape]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Routines to change the last drawn shape |
|- | |- | ||
|} | |} | ||
− | |||
</tab> | </tab> | ||
Line 466: | Line 486: | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Mouse.GetButtons|GetButtons]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Mouse.GetButtons|GetButtons]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the button state from the mouse: 4 for left, 1 for right |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Mouse.GetFocus|GetFocus]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Mouse.GetFocus|GetFocus]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the handle of the component under the mouse |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Mouse.GetPosition|GetPosition]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Mouse.GetPosition|GetPosition]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the position of the mouse, intersecting with a component or the viewing plane |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Mouse.GetPosition2D|GetPosition2D]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Mouse.GetPosition2D|GetPosition2D]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the X/Y position of the mouse in screen coords |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Mouse.GetClickSide|GetClickSide]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Mouse.GetClickSide|GetClickSide]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the side of the component clicked on, 0 to 5 |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Mouse.SimClick|SimClick]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Mouse.SimClick|SimClick]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Simulates a click on an object |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Mouse.SimDrag|SimDrag]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Mouse.SimDrag|SimDrag]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Simulates a click-drag on an object |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Mouse.SimRelease|SimRelease]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Mouse.SimRelease|SimRelease]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Simulates a click-release on an object |
|- | |- | ||
|} | |} | ||
Line 498: | Line 518: | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Keyboard.KeyDown|KeyDown]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Keyboard.KeyDown|KeyDown]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Simulates a key-press on an object |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Keyboard.KeyUp|KeyUp]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Keyboard.KeyUp|KeyUp]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Simulates a key-release on an object |
|- | |- | ||
|} | |} | ||
Line 512: | Line 532: | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API FCD.GetItemValue|GetItemValue]] | | colspan="2" style="background-color:#FFFFFF;" | [[API FCD.GetItemValue|GetItemValue]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets a paths item value from the FCD document |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API FCD.GetItemHandle|GetItemHandle]] | | colspan="2" style="background-color:#FFFFFF;" | [[API FCD.GetItemHandle|GetItemHandle]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets a FCD items handle, suitable for traversal with the Tree API |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API FCD.GetPathHandle|GetPathHandle]] | | colspan="2" style="background-color:#FFFFFF;" | [[API FCD.GetPathHandle|GetPathHandle]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets a FCD paths handle, suitable for traversal with the Tree API |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API FCD.SetItemValue|SetItemValue]] | | colspan="2" style="background-color:#FFFFFF;" | [[API FCD.SetItemValue|SetItemValue]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Override item value from the FCD document from path |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API FCD.ResetItemValue|ResetItemValue]] | | colspan="2" style="background-color:#FFFFFF;" | [[API FCD.ResetItemValue|ResetItemValue]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Reset paths item value from the FCD document |
|- | |- | ||
|} | |} | ||
Line 535: | Line 555: | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Sound.Play|Play]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Sound.Play|Play]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Plays a formatted file sound, returns true if the sound played OK |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Sound.LoadWav|LoadWav]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Sound.LoadWav|LoadWav]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Loads a wave file into memory, providing the values needed to play it |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Sound.Create|Create]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Sound.Create|Create]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Creates a sound object that data can be played through |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Sound.SetVolume|SetVolume]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Sound.SetVolume|SetVolume]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the volume of playbacks for this sound |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Sound.GetVolume|GetVolume]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Sound.GetVolume|GetVolume]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the volume of playbacks for this sound in the range 0 to 1 |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Sound.GetBits|GetBits]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Sound.GetBits|GetBits]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the number of bits per sample for the sound |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Sound.GetRate|GetRate]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Sound.GetRate|GetRate]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the current sample rate for the sound |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Sound.SetRate|SetRate]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Sound.SetRate|SetRate]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the current sample rate for the sound - this will stop the playing sound |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Sound.Queue|Queue]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Sound.Queue|Queue]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Queues a sound for playing |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Sound.QueueEx|QueueEx]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Sound.QueueEx|QueueEx]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Queues a sound for playing, with the format provided |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Sound.Flush|Flush]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Sound.Flush|Flush]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Stops all playing and queued sounds |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Sound.GetPending|GetPending]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Sound.GetPending|GetPending]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the number of sample blocks queued or playing for the sound |
|- | |- | ||
|} | |} | ||
Line 579: | Line 599: | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.AddGroup|AddGroup]] | | colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.AddGroup|AddGroup]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Adds a group to the scope to which streams may be added |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.ShowGroup|ShowGroup]] | | colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.ShowGroup|ShowGroup]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the visibility of the given group |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.AddStream|AddStream]] | | colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.AddStream|AddStream]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Adds a stream to the given group suitable for inputs and operations |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.AddBuffer|AddBuffer]] | | colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.AddBuffer|AddBuffer]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Adds a fixed-view stream to the given group suitable for inputs and operations |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.Rename|Rename]] | | colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.Rename|Rename]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Renames the given scope group, stream or buffer |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.SetYAxisLabels|SetYAxisLabels]] | | colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.SetYAxisLabels|SetYAxisLabels]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the labels for the Y-axis of the given stream |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.SetLineColor|SetLineColor]] | | colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.SetLineColor|SetLineColor]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the group, stream or buffers line colour |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.GetLineColor|GetLineColor]] | | colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.GetLineColor|GetLineColor]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the streams line colour |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.SetBackColor|SetBackColor]] | | colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.SetBackColor|SetBackColor]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the groups background colour |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.GetBackColor|GetBackColor]] | | colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.GetBackColor|GetBackColor]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the stream groups background colour |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.SetDecodable|SetDecodable]] | | colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.SetDecodable|SetDecodable]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets whether a stream can be decoded via the components event - defaults to 'true' |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.GetDecodable|GetDecodable]] | | colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.GetDecodable|GetDecodable]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets whether a stream can be decoded via the components event - defaults to 'true' |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.AddPort|AddPort]] | | colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.AddPort|AddPort]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Adds an input to the stream from a port |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.AddAnalog|AddAnalog]] | | colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.AddAnalog|AddAnalog]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Adds an input to the stream from an analog channel |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.AddCustom|AddCustom]] | | colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.AddCustom|AddCustom]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Adds an input to the stream from a custom injection |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.AddOp|AddOp]] | | colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.AddOp|AddOp]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Adds an operation to act on the inputs of the stream |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.ClearOps|ClearOps]] | | colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.ClearOps|ClearOps]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Clears all inputs and operations from the given stream |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.SetBuffer|SetBuffer]] | | colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.SetBuffer|SetBuffer]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the contents of a snapshot stream |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.SetCustom|SetCustom]] | | colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.SetCustom|SetCustom]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets one of 32 custom analog values for the group |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.GetSnapshot|GetSnapshot]] | | colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.GetSnapshot|GetSnapshot]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets a block of the output stream with each input sample operated on, returns number of samples read |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.FindOutput|FindOutput]] | | colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.FindOutput|FindOutput]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Searches back through the output history for a value, returns offset of found sample from TimeUS, 0 if not found |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.FindPeriod|FindPeriod]] | | colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.FindPeriod|FindPeriod]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Attempts to calculate the wave period given a series of transitions for the stream, returns calculated period |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.SetPacketFmt|SetPacketFmt]] | | colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.SetPacketFmt|SetPacketFmt]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the graphical format of the packets added with AddPacket and Add...Packets |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.GetPacketFmt|GetPacketFmt]] | | colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.GetPacketFmt|GetPacketFmt]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Returns the graphical format of the packets added with AddPacket and Add...Packets |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.AddPacket|AddPacket]] | | colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.AddPacket|AddPacket]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Adds an overlay packet to the stream at a given offset from the current time |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.AddStepPackets|AddStepPackets]] | | colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.AddStepPackets|AddStepPackets]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Adds overlay packets to the stream by decoding the stream contents with a fixed period rate |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.AddSyncPackets|AddSyncPackets]] | | colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.AddSyncPackets|AddSyncPackets]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Adds overlay packets to the stream by decoding the stream contents with a variable period rate |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.ClearPackets|ClearPackets]] | | colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.ClearPackets|ClearPackets]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Clears existing overlay packets from the stream |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.ClearAllPackets|ClearAllPackets]] | | colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.ClearAllPackets|ClearAllPackets]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Clears all existing overlay packets from the stream |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.TicksToSecs|TicksToSecs]] | | colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.TicksToSecs|TicksToSecs]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Converts a duration in ticks into a time in seconds |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.SecsToTicks|SecsToTicks]] | | colspan="2" style="background-color:#FFFFFF;" | [[API DataRecorder.SecsToTicks|SecsToTicks]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Converts a time in seconds into a duration in ticks |
|- | |- | ||
|} | |} | ||
Line 680: | Line 700: | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Calculations.FloatToStorageULong|FloatToStorageULong]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Calculations.FloatToStorageULong|FloatToStorageULong]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Converts a float to an array containing 4 bytes |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Calculations.StorageULongToFloat|StorageULongToFloat]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Calculations.StorageULongToFloat|StorageULongToFloat]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Returns a float value from an unsigned long representation (used to store or transfer it) |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Calculations.GetFrequencyArray|GetFrequencyArray]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Calculations.GetFrequencyArray|GetFrequencyArray]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Calculates the frequency from an array of data. |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Calculations.GetAmplitudeArray|GetAmplitudeArray]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Calculations.GetAmplitudeArray|GetAmplitudeArray]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Calculates the amplitude from an array of data. |
|- | |- | ||
|} | |} | ||
Line 700: | Line 720: | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Console.AddText|AddText]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Console.AddText|AddText]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Adds a window to the list of consoles available |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Console.AddMemory|AddMemory]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Console.AddMemory|AddMemory]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Adds a window to the list of consoles available |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Console.GetDefault|GetDefault]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Console.GetDefault|GetDefault]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the default (read-only) console window |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Console.GetConsole|GetConsole]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Console.GetConsole|GetConsole]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets a console window |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Console.GetName|GetName]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Console.GetName|GetName]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Returns the name of a console |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Console.Rename|Rename]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Console.Rename|Rename]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Renames the given console |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Console.SetMemMode|SetMemMode]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Console.SetMemMode|SetMemMode]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets whether to show address and bytes for the console |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Console.SetInputRGB|SetInputRGB]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Console.SetInputRGB|SetInputRGB]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the colour of text inserted by the user from now on |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Console.SetOutputRGB|SetOutputRGB]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Console.SetOutputRGB|SetOutputRGB]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the colour of text inserted by the component from now on |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Console.WriteText|WriteText]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Console.WriteText|WriteText]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Adds a block of text to the console window |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Console.GetLineText|GetLineText]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Console.GetLineText|GetLineText]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Reads a line of text from the given console, pass -1 for final line |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Console.SetLineText|SetLineText]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Console.SetLineText|SetLineText]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Writes a line of text from the given console, pass -1 for final line |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Console.GetLineBytes|GetLineBytes]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Console.GetLineBytes|GetLineBytes]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Reads a line of bytes from the given console extending the array if needed |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Console.SetLineBytes|SetLineBytes]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Console.SetLineBytes|SetLineBytes]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Writes a line of bytes from the given console, pass -1 for final line |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Console.CountLines|CountLines]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Console.CountLines|CountLines]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Counts the number of lines in the console |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Console.ClearText|ClearText]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Console.ClearText|ClearText]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Clears all the text in the console |
|- | |- | ||
|} | |} | ||
Line 756: | Line 776: | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Connection.GetPort|GetPort]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Connection.GetPort|GetPort]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets a ports value from its index |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Connection.SetPort|SetPort]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Connection.SetPort|SetPort]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets a ports value from its index |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Connection.GetAn|GetAn]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Connection.GetAn|GetAn]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets an analog value from its channel index |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Connection.SetAn|SetAn]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Connection.SetAn|SetAn]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets an analog value from its index, range 0->1 |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Connection.DecodePort|DecodePort]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Connection.DecodePort|DecodePort]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets a ports details from its name or index |
|- | |- | ||
|} | |} | ||
Line 779: | Line 799: | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Expand.PathName|PathName]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Expand.PathName|PathName]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Expands a string using the built-in pathname expansion variables |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Expand.MacroName|MacroName]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Expand.MacroName|MacroName]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Expands a string to the name of a macro used in the generated code |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Expand.VarName|VarName]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Expand.VarName|VarName]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Expands a string to the name of a global variable used in the generated code |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Expand.Property|Property]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Expand.Property|Property]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Expands a string to the name of a property used in the generated code |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Expand.MacroHead|MacroHead]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Expand.MacroHead|MacroHead]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Expands a macro name to the code generated for the header of that macro |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Expand.MacroBody|MacroBody]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Expand.MacroBody|MacroBody]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Expands a macro name to the code generated for the body of that macro |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Expand.MacroTail|MacroTail]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Expand.MacroTail|MacroTail]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Expands a macro name to the code generated for the tail of that macro |
|- | |- | ||
|} | |} | ||
Line 808: | Line 828: | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Tree.GetValue|GetValue]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Tree.GetValue|GetValue]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the value of the given object, if available |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Tree.GetName|GetName]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Tree.GetName|GetName]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the name of the given object |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Tree.GetPath|GetPath]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Tree.GetPath|GetPath]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the full '.' separated name of the given object |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Tree.GetSubValue|GetSubValue]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Tree.GetSubValue|GetSubValue]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the value of a named sub-item of the given object, if available |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Tree.Traverse|Traverse]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Tree.Traverse|Traverse]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Updates the object to step depth-first through the tree |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Tree.StepNext|StepNext]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Tree.StepNext|StepNext]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Updates the object to point to the next (younger) sibling |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Tree.StepNamedNext|StepNamedNext]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Tree.StepNamedNext|StepNamedNext]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Updates the object to point to the next (younger) sibling matching the name |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Tree.StepNamedIndex|StepNamedIndex]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Tree.StepNamedIndex|StepNamedIndex]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Updates the object to point to the Nth next (younger) sibling matching the name |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Tree.StepLast|StepLast]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Tree.StepLast|StepLast]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Updates the object to point to the last (elder) sibling |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Tree.StepParent|StepParent]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Tree.StepParent|StepParent]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Updates the object to point to its parent object |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Tree.StepRoot|StepRoot]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Tree.StepRoot|StepRoot]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Updates the object to point to the root of the tree |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Tree.StepChildHead|StepChildHead]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Tree.StepChildHead|StepChildHead]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Updates the object to point to the head (eldest) child |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Tree.StepChildTail|StepChildTail]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Tree.StepChildTail|StepChildTail]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Updates the object to point to the tail (youngest) child |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Tree.StepChildPath|StepChildPath]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Tree.StepChildPath|StepChildPath]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Updates the object to point to the '.' separated named child path |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Tree.CountChildren|CountChildren]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Tree.CountChildren|CountChildren]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Returns the number of immediate children present for the object |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Tree.CheckChildren|CheckChildren]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Tree.CheckChildren|CheckChildren]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Returns true if the object has children, else false |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Tree.CountNamedChildren|CountNamedChildren]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Tree.CountNamedChildren|CountNamedChildren]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Returns the number of immediate children present for the object |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Tree.CheckParent|CheckParent]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Tree.CheckParent|CheckParent]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Returns true if the object has a parent, else false if it is the root |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Tree.StepSubHead|StepSubHead]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Tree.StepSubHead|StepSubHead]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Updates the object to point to the head (eldest) attribute, if any |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Tree.StepSubTail|StepSubTail]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Tree.StepSubTail|StepSubTail]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Updates the object to point to the tail (youngest) attribute, if any |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Tree.StepSubName|StepSubName]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Tree.StepSubName|StepSubName]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Updates the object to point to the named attribute, if any |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Tree.GetCopy|GetCopy]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Tree.GetCopy|GetCopy]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Creates a copy of the handle and returns the copy |
|- | |- | ||
|} | |} | ||
Line 882: | Line 902: | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API File.AbsPath|AbsPath]] | | colspan="2" style="background-color:#FFFFFF;" | [[API File.AbsPath|AbsPath]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets an absolute path from a relative filename |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API File.RelPath|RelPath]] | | colspan="2" style="background-color:#FFFFFF;" | [[API File.RelPath|RelPath]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets an relative path from an absolute filename |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API File.CreateDir|CreateDir]] | | colspan="2" style="background-color:#FFFFFF;" | [[API File.CreateDir|CreateDir]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Creates a directory structure |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API File.GetType|GetType]] | | colspan="2" style="background-color:#FFFFFF;" | [[API File.GetType|GetType]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Finds the type of a file: 0=Unknown, 1=File, 2=Dir, 4=Disk |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API File.GetSize|GetSize]] | | colspan="2" style="background-color:#FFFFFF;" | [[API File.GetSize|GetSize]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the number of bytes in the file, by handle or name |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API File.Delete|Delete]] | | colspan="2" style="background-color:#FFFFFF;" | [[API File.Delete|Delete]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Deletes the file or directory structure |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API File.Create|Create]] | | colspan="2" style="background-color:#FFFFFF;" | [[API File.Create|Create]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Creates the new file as a standard stream |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API File.Open|Open]] | | colspan="2" style="background-color:#FFFFFF;" | [[API File.Open|Open]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Opens the existing file as a standard stream |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API File.ReadArray|ReadArray]] | | colspan="2" style="background-color:#FFFFFF;" | [[API File.ReadArray|ReadArray]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Reads an array from the file, returns elements read |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API File.WriteArray|WriteArray]] | | colspan="2" style="background-color:#FFFFFF;" | [[API File.WriteArray|WriteArray]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Writes an array to the file |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API File.SetPos|SetPos]] | | colspan="2" style="background-color:#FFFFFF;" | [[API File.SetPos|SetPos]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the position of the next read or write in the file |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API File.GetPos|GetPos]] | | colspan="2" style="background-color:#FFFFFF;" | [[API File.GetPos|GetPos]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the position of the next read or write in the file |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API File.Flush|Flush]] | | colspan="2" style="background-color:#FFFFFF;" | [[API File.Flush|Flush]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Writes all unwritten data to the file in one block |
+ | |- | ||
+ | |} | ||
+ | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
| colspan="3" align="center" style="background-color:#EAE1EA;" | Buffer | | colspan="3" align="center" style="background-color:#EAE1EA;" | Buffer | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API File.Buffer.Open|Open]] | | colspan="2" style="background-color:#FFFFFF;" | [[API File.Buffer.Open|Open]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Opens the existing file as a circular buffer |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API File.Buffer.Create|Create]] | | colspan="2" style="background-color:#FFFFFF;" | [[API File.Buffer.Create|Create]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Creates the new file as a circular buffer |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API File.Buffer.ReadByte|ReadByte]] | | colspan="2" style="background-color:#FFFFFF;" | [[API File.Buffer.ReadByte|ReadByte]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Reads a single byte from the input stream, -1 if empty |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API File.Buffer.WriteByte|WriteByte]] | | colspan="2" style="background-color:#FFFFFF;" | [[API File.Buffer.WriteByte|WriteByte]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Writes a single byte to the input stream |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API File.Buffer.ReadArray|ReadArray]] | | colspan="2" style="background-color:#FFFFFF;" | [[API File.Buffer.ReadArray|ReadArray]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Reads an array from the input stream, returns elements read |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API File.Buffer.WriteArray|WriteArray]] | | colspan="2" style="background-color:#FFFFFF;" | [[API File.Buffer.WriteArray|WriteArray]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Writes an array to the input stream |
+ | |- | ||
+ | |} | ||
+ | {| class="wikitable" style="width: 800px; background-color:#FFFFFF;" | ||
|- | |- | ||
| colspan="3" align="center" style="background-color:#EAE1EA;" | NVM | | colspan="3" align="center" style="background-color:#EAE1EA;" | NVM | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API File.NVM.Open|Open]] | | colspan="2" style="background-color:#FFFFFF;" | [[API File.NVM.Open|Open]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Opens the existing file as a block of non-volatile memory |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API File.NVM.Create|Create]] | | colspan="2" style="background-color:#FFFFFF;" | [[API File.NVM.Create|Create]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Creates the new file as a block of non-volatile memory |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API File.NVM.ReadByte|ReadByte]] | | colspan="2" style="background-color:#FFFFFF;" | [[API File.NVM.ReadByte|ReadByte]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Reads a single byte from the NVM, -1 if empty |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API File.NVM.WriteByte|WriteByte]] | | colspan="2" style="background-color:#FFFFFF;" | [[API File.NVM.WriteByte|WriteByte]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Writes a single byte to the NVM multiple times |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API File.NVM.ReadArray|ReadArray]] | | colspan="2" style="background-color:#FFFFFF;" | [[API File.NVM.ReadArray|ReadArray]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Reads an array from the NVM, returns elements read |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API File.NVM.WriteArray|WriteArray]] | | colspan="2" style="background-color:#FFFFFF;" | [[API File.NVM.WriteArray|WriteArray]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Writes an array to the NVM |
|- | |- | ||
|} | |} | ||
− | |||
</tab> | </tab> | ||
Line 969: | Line 994: | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API UI.SimpleMsgBox|SimpleMsgBox]] | | colspan="2" style="background-color:#FFFFFF;" | [[API UI.SimpleMsgBox|SimpleMsgBox]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Displays a simple 'Ok' message box |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API UI.Win32MsgBox|Win32MsgBox]] | | colspan="2" style="background-color:#FFFFFF;" | [[API UI.Win32MsgBox|Win32MsgBox]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Invokes the Win32 API MessageBox function |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API UI.YesNoMsgBox|YesNoMsgBox]] | | colspan="2" style="background-color:#FFFFFF;" | [[API UI.YesNoMsgBox|YesNoMsgBox]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Displays a simple 'Yes/No' message box |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API UI.YesNoCancelMsgBox|YesNoCancelMsgBox]] | | colspan="2" style="background-color:#FFFFFF;" | [[API UI.YesNoCancelMsgBox|YesNoCancelMsgBox]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Displays a simple 'Yes/No/Cancel' message box (0 == Cancel, 1 == No, 2 == Yes) |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API UI.InputMsgBox|InputMsgBox]] | | colspan="2" style="background-color:#FFFFFF;" | [[API UI.InputMsgBox|InputMsgBox]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Displays a message box that allows the user to input text. Returns true if 'Ok' clicked, false otherwise |
|- | |- | ||
|} | |} | ||
Line 992: | Line 1,017: | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Time.GetMillisecs|GetMillisecs]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Time.GetMillisecs|GetMillisecs]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Returns the value of a monotonic non-decrementing millisecond counter |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Time.GetUTC|GetUTC]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Time.GetUTC|GetUTC]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Returns the current UTC Modified Julian Date value |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Time.GetLocal|GetLocal]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Time.GetLocal|GetLocal]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Returns the current local time as a Modified Julian Date value |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Time.AddMJD|AddMJD]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Time.AddMJD|AddMJD]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Increments or decrements a Modified Julian Date and millisecond value |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Time.MJDToDate|MJDToDate]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Time.MJDToDate|MJDToDate]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Converts a Modified Julian Date into a Gregorian calendar date |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Time.DateToMJD|DateToMJD]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Time.DateToMJD|DateToMJD]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Converts a Gregorian calendar date into a Modified Julian Date |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Time.MJDToSeconds|MJDToSeconds]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Time.MJDToSeconds|MJDToSeconds]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Converts a Modified Julian Date into a number of seconds since a specified epoch |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Time.SecondsToMJD|SecondsToMJD]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Time.SecondsToMJD|SecondsToMJD]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Returns the Modified Julian Date given by the number of seconds since a specified epoch |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Time.MJDToWeekday|MJDToWeekday]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Time.MJDToWeekday|MJDToWeekday]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the day of the week that the MJD represents |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Time.GetLeapYear|GetLeapYear]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Time.GetLeapYear|GetLeapYear]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Returns true if the given year is a leap year, else false |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Time.GetMonthDays|GetMonthDays]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Time.GetMonthDays|GetMonthDays]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Returns the number of days in the given month |
|- | |- | ||
|} | |} | ||
Line 1,033: | Line 1,058: | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Language.Translate|Translate]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Language.Translate|Translate]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Takes English text and optional hint and converts to the current language |
|- | |- | ||
|} | |} | ||
Line 1,044: | Line 1,069: | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API System.Notify|Notify]] | | colspan="2" style="background-color:#FFFFFF;" | [[API System.Notify|Notify]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sends a System.User message to the targeted component |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API System.Forward|Forward]] | | colspan="2" style="background-color:#FFFFFF;" | [[API System.Forward|Forward]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sends the currently processing message to the target |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API System.MacroExists|MacroExists]] | | colspan="2" style="background-color:#FFFFFF;" | [[API System.MacroExists|MacroExists]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Returns true if the macro exists |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API System.CallMacro|CallMacro]] | | colspan="2" style="background-color:#FFFFFF;" | [[API System.CallMacro|CallMacro]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Calls a macro |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API System.ShowHandle|ShowHandle]] | | colspan="2" style="background-color:#FFFFFF;" | [[API System.ShowHandle|ShowHandle]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Given a handle to an object with viewable presence, shows that object on screen |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API System.CreateHandle|CreateHandle]] | | colspan="2" style="background-color:#FFFFFF;" | [[API System.CreateHandle|CreateHandle]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Creates a general-purpose garbage collected handle for resource management |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API System.SetHandleWord|SetHandleWord]] | | colspan="2" style="background-color:#FFFFFF;" | [[API System.SetHandleWord|SetHandleWord]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets a general purpose word in the handle for use by its owner |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API System.GetHandleWord|GetHandleWord]] | | colspan="2" style="background-color:#FFFFFF;" | [[API System.GetHandleWord|GetHandleWord]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets a general-purpose word set by the owner of a custom handle |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API System.DeleteHandle|DeleteHandle]] | | colspan="2" style="background-color:#FFFFFF;" | [[API System.DeleteHandle|DeleteHandle]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Deletes any handle created by the component |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API System.GetSender|GetSender]] | | colspan="2" style="background-color:#FFFFFF;" | [[API System.GetSender|GetSender]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Gets the handle of the component that posted this event - 0 for system |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API System.TimerStart|TimerStart]] | | colspan="2" style="background-color:#FFFFFF;" | [[API System.TimerStart|TimerStart]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Calls the Component.Timer event with Ident as an argument after Millisecs time |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API System.TimerStop|TimerStop]] | | colspan="2" style="background-color:#FFFFFF;" | [[API System.TimerStop|TimerStop]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Kills any timers with the given ident for this component |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API System.WDTEnable|WDTEnable]] | | colspan="2" style="background-color:#FFFFFF;" | [[API System.WDTEnable|WDTEnable]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Enables or disables the software watchdog during long operations |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API System.ClaimEvent|ClaimEvent]] | | colspan="2" style="background-color:#FFFFFF;" | [[API System.ClaimEvent|ClaimEvent]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Claims an event message by name, returns true if claimed |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API System.ReleaseEvent|ReleaseEvent]] | | colspan="2" style="background-color:#FFFFFF;" | [[API System.ReleaseEvent|ReleaseEvent]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Releases a previously claimed an event message by name, returns true if released |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API System.EnableEvent|EnableEvent]] | | colspan="2" style="background-color:#FFFFFF;" | [[API System.EnableEvent|EnableEvent]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Allows an event to be fired or removes the ability for an event to fire - this may be nested |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API System.ClaimMouse|ClaimMouse]] | | colspan="2" style="background-color:#FFFFFF;" | [[API System.ClaimMouse|ClaimMouse]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Claims mouse clicks for the target object |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API System.ReleaseMouse|ReleaseMouse]] | | colspan="2" style="background-color:#FFFFFF;" | [[API System.ReleaseMouse|ReleaseMouse]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Releases mouse clicks for the target object |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API System.RedirectMacros|RedirectMacros]] | | colspan="2" style="background-color:#FFFFFF;" | [[API System.RedirectMacros|RedirectMacros]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Allows calls to one of your children to be redirected to another component |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API System.StartSim|StartSim]] | | colspan="2" style="background-color:#FFFFFF;" | [[API System.StartSim|StartSim]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Start the simulation engine |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API System.StopSim|StopSim]] | | colspan="2" style="background-color:#FFFFFF;" | [[API System.StopSim|StopSim]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Stop the simulation engine |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API System.SetSimSpeed|SetSimSpeed]] | | colspan="2" style="background-color:#FFFFFF;" | [[API System.SetSimSpeed|SetSimSpeed]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the speed the simulation engine |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API System.SetClipboardData|SetClipboardData]] | | colspan="2" style="background-color:#FFFFFF;" | [[API System.SetClipboardData|SetClipboardData]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sets the clipboard with text data |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API System.ReadClipboardData|ReadClipboardData]] | | colspan="2" style="background-color:#FFFFFF;" | [[API System.ReadClipboardData|ReadClipboardData]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Reads text data from the clipboard |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API System.GetHasFocus|GetHasFocus]] | | colspan="2" style="background-color:#FFFFFF;" | [[API System.GetHasFocus|GetHasFocus]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Checks to see if a Flowcode window has the focus |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API System.ShellExecute|ShellExecute]] | | colspan="2" style="background-color:#FFFFFF;" | [[API System.ShellExecute|ShellExecute]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Launches an external file or program on this computer |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API System.WriteRegistryInt|WriteRegistryInt]] | | colspan="2" style="background-color:#FFFFFF;" | [[API System.WriteRegistryInt|WriteRegistryInt]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Writes an integer value to the registry |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API System.WriteRegistryString|WriteRegistryString]] | | colspan="2" style="background-color:#FFFFFF;" | [[API System.WriteRegistryString|WriteRegistryString]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Writes a string value to the registry |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API System.ReadRegistryInt|ReadRegistryInt]] | | colspan="2" style="background-color:#FFFFFF;" | [[API System.ReadRegistryInt|ReadRegistryInt]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Reads an integer value from the registry |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API System.ReadRegistryString|ReadRegistryString]] | | colspan="2" style="background-color:#FFFFFF;" | [[API System.ReadRegistryString|ReadRegistryString]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Reads a string value from the registry |
|- | |- | ||
|} | |} | ||
Line 1,142: | Line 1,167: | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Debug.Print|Print]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Debug.Print|Print]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Prints out the string or value on a line in the debug window |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Debug.PrintLn|PrintLn]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Debug.PrintLn|PrintLn]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Prints out the string or value with a new-line in the debug window |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[API Debug.TestFunction|TestFunction]] | | colspan="2" style="background-color:#FFFFFF;" | [[API Debug.TestFunction|TestFunction]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Temporary debug function |
|- | |- | ||
|} | |} | ||
Line 1,165: | Line 1,190: | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Compile.Preprocess|Preprocess]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Compile.Preprocess|Preprocess]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Broadcast to all components immediately before compilation is started |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Compile.AddProperty|AddProperty]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Compile.AddProperty|AddProperty]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sent to a component to allow dynamic amendment of global property declarations |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Compile.AddConst|AddConst]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Compile.AddConst|AddConst]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sent to a component to allow dynamic amendment of global variable declarations |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Compile.AddVarSize|AddVarSize]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Compile.AddVarSize|AddVarSize]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sent to a component to allow dynamic amendment of global array-size declarations |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Compile.AddVar|AddVar]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Compile.AddVar|AddVar]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sent to a component to allow dynamic amendment of global constant declarations |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Compile.AddHeader|AddHeader]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Compile.AddHeader|AddHeader]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sent to a component to allow dynamic amendment of header code |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Compile.AddInterrupts|AddInterrupts]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Compile.AddInterrupts|AddInterrupts]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sent to a component to allow dynamic amendment of the interrupts for a component |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Compile.AddInterrupt|AddInterrupt]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Compile.AddInterrupt|AddInterrupt]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sent to a component to allow dynamic amendment of a single interrupts code |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Compile.Start|Start]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Compile.Start|Start]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Broadcast to all components that compilation is starting |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Compile.Stop|Stop]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Compile.Stop|Stop]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Broadcast to all components that compilation has stopped |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Compile.GetVarSize|GetVarSize]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Compile.GetVarSize|GetVarSize]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sent to a component to amend the size of the expected array |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Compile.HtmlBodyInfo|HtmlBodyInfo]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Compile.HtmlBodyInfo|HtmlBodyInfo]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sent to a component to retrieve tags to be placed in the html body |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Compile.HtmlScriptHeader|HtmlScriptHeader]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Compile.HtmlScriptHeader|HtmlScriptHeader]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sent to a component to retrieve script code to be placed in the html header section |
|- | |- | ||
|} | |} | ||
Line 1,212: | Line 1,237: | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Components.PropertyEx|PropertyEx]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Components.PropertyEx|PropertyEx]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sent when a property has been changed by the User (specific property and value identified) |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Components.Property|Property]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Components.Property|Property]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sent when a property has been changed by the User |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Components.ProjectClosedown|ProjectClosedown]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Components.ProjectClosedown|ProjectClosedown]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sent to the component when the project is closing |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Components.Added|Added]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Components.Added|Added]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Broadcast to all existing components once a new component has been added |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Components.Adding|Adding]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Components.Adding|Adding]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Broadcast to all existing components when a new component is about to be added |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Components.Resize|Resize]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Components.Resize|Resize]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sent to the mouse target when the user has altered the position of a component child |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Components.Removed|Removed]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Components.Removed|Removed]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Broadcast to all remaining components after a component has been removed |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Components.Removing|Removing]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Components.Removing|Removing]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Broadcast to all existing components when a component is about to be removed |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Components.Renamed|Renamed]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Components.Renamed|Renamed]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sent to the component when the component is renamed |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Components.Deleted|Deleted]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Components.Deleted|Deleted]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Closedown routine for the component |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Components.Deleting|Deleting]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Components.Deleting|Deleting]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Send to a component when it is being deleted |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Components.Initialise|Initialise]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Components.Initialise|Initialise]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Initialisation routine for the component once the component is linked to its parent |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Components.Initialising|Initialising]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Components.Initialising|Initialising]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Initialisation routine before the component is linked to its parent |
|- | |- | ||
|} | |} | ||
Line 1,259: | Line 1,284: | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Console.AddLine|AddLine]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Console.AddLine|AddLine]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Post to the owning component when a line is inserted by the user |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Console.TextChanged|TextChanged]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Console.TextChanged|TextChanged]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Post when the console text is changed by the user in some way |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Console.MemChanged|MemChanged]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Console.MemChanged|MemChanged]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Post when the console memory is changed by the user in some way |
|- | |- | ||
|} | |} | ||
Line 1,276: | Line 1,301: | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Connection.PinPopulate|PinPopulate]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Connection.PinPopulate|PinPopulate]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sent when auto-populate of digital connections is requested |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Connection.PinChange|PinChange]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Connection.PinChange|PinChange]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sent during simulation if a connected port pin changes |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Connection.AnPopulate|AnPopulate]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Connection.AnPopulate|AnPopulate]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sent when auto-populate of analog connections is requested |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Connection.AnChange|AnChange]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Connection.AnChange|AnChange]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sent during simulation if a connected ADC channel changes |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Connection.ChipChange|ChipChange]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Connection.ChipChange|ChipChange]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sent when the target device has changed |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Connection.Unconnected|Unconnected]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Connection.Unconnected|Unconnected]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sent when the component is compiled with unconnected pins |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Connection.FCDChange|FCDChange]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Connection.FCDChange|FCDChange]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sent when some settings of the target device have changed |
|- | |- | ||
|} | |} | ||
Line 1,305: | Line 1,330: | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Simulation.Pause|Pause]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Simulation.Pause|Pause]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Broadcast to all components that simulation has paused |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Simulation.Resume|Resume]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Simulation.Resume|Resume]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Broadcast to all components that simulation has resumed |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Simulation.Start|Start]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Simulation.Start|Start]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Broadcast to all components that simulation is starting |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Simulation.Stop|Stop]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Simulation.Stop|Stop]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Broadcast to all components that simulation has stopped |
|- | |- | ||
|} | |} | ||
Line 1,325: | Line 1,350: | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event System.CleanHandle|CleanHandle]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event System.CleanHandle|CleanHandle]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Called when a custom handle is deleted to allow cleanup of resources |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event System.Timer|Timer]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event System.Timer|Timer]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Called back on the panel command System.TimerStart |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event System.User|User]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event System.User|User]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Called back on the panel command System.Notify |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event System.LoadComplete|LoadComplete]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event System.LoadComplete|LoadComplete]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Broadcast after a project has finished loading |
|- | |- | ||
|} | |} | ||
Line 1,345: | Line 1,370: | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Sound.Complete|Complete]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Sound.Complete|Complete]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sent when a sound queued by the component has finished playing |
|- | |- | ||
|} | |} | ||
Line 1,356: | Line 1,381: | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event DataRecorder.ResyncPacket|ResyncPacket]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event DataRecorder.ResyncPacket|ResyncPacket]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sent when Packet_ResyncEv is specified in scope decoding |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event DataRecorder.Decode|Decode]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event DataRecorder.Decode|Decode]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sent when a block of the stream is to be decoded into packets |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event DataRecorder.FmtPacket|FmtPacket]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event DataRecorder.FmtPacket|FmtPacket]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sent when a %e is read in a format string when decoding a packet |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event DataRecorder.Overlay|Overlay]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event DataRecorder.Overlay|Overlay]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sent when the mouse hovers over a scope stream |
|- | |- | ||
|} | |} | ||
Line 1,376: | Line 1,401: | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Tooltip.GraphicPoll|GraphicPoll]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Tooltip.GraphicPoll|GraphicPoll]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Called when a tooltip graphic is updating with the draw image already pushed |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Tooltip.GetText|GetText]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Tooltip.GetText|GetText]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Called when a tooltip text string can be displayed |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Tooltip.GetGraphic|GetGraphic]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Tooltip.GetGraphic|GetGraphic]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Called when a tooltip graphic can be displayed with the draw image already pushed |
|- | |- | ||
|} | |} | ||
Line 1,393: | Line 1,418: | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event File.Changed|Changed]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event File.Changed|Changed]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sent when a file being watched has changed |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event File.Closed|Closed]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event File.Closed|Closed]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sent when a file monitor is being closed |
|- | |- | ||
|} | |} | ||
Line 1,407: | Line 1,432: | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Graphics.Animated|Animated]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Graphics.Animated|Animated]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Notification than an animation has finished |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Graphics.Background|Background]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Graphics.Background|Background]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Updates the background container of the 2d panel |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Graphics.Redraw|Redraw]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Graphics.Redraw|Redraw]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Reconstructs and redraws the target component |
|- | |- | ||
|} | |} | ||
Line 1,424: | Line 1,449: | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Keyboard.ButtonName|ButtonName]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Keyboard.ButtonName|ButtonName]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sent to give a meaningful name to a button on a simulated mouse-click |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Keyboard.KeyMapDown|KeyMapDown]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Keyboard.KeyMapDown|KeyMapDown]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Post when a mapped key is pressed for the component |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Keyboard.KeyMapUp|KeyMapUp]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Keyboard.KeyMapUp|KeyMapUp]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Post when a mapped key is released for the component |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Keyboard.MappingKeys|MappingKeys]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Keyboard.MappingKeys|MappingKeys]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sent to find out how many keys it is possible to map to the component during simulation |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Keyboard.MappingName|MappingName]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Keyboard.MappingName|MappingName]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Sent to give a meaningful name to a custom key-map event for a component |
|- | |- | ||
|} | |} | ||
Line 1,447: | Line 1,472: | ||
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Mouse.Release|Release]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Mouse.Release|Release]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Post when the mouse is released on a child of the component during simulation |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Mouse.Click|Click]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Mouse.Click|Click]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Post when the mouse is clicked on a child of the component during simulation |
|- | |- | ||
| colspan="2" style="background-color:#FFFFFF;" | [[Event Mouse.Drag|Drag]] | | colspan="2" style="background-color:#FFFFFF;" | [[Event Mouse.Drag|Drag]] | ||
− | | style="background-color:# | + | | style="background-color:#FFFFFF;" | Post when the mouse is dragged on a child of the component during simulation |
|- | |- | ||
|} | |} |
Latest revision as of 16:20, 13 January 2023
Contents
Built in functions
Property | ||
GetValue | Gets the value of a property as a string | |
SetColor | Sets a components 'color' property as a R,G,B value | |
SetValue | Sets a components property as a string | |
CopyValue | Copies a property value from one target to another | |
SetChildValues | Sets all child components property as a string | |
CopyChildValues | Copies the values of a properties children from the source to dest | |
SetVisible | Sets whether the property is visible or not | |
SetWritable | Sets whether the property can be edited in the UI or not | |
GetVisible | Gets whether the property is visible or not | |
GetWritable | Gets whether the property can be edited in the UI or not | |
GetFilter | Gets a components property filter string for lists, files, etc | |
SetFilter | Sets a components property filter string for lists, files, etc | |
CopyFilter | Copies a property filter from one target to another | |
GetListIndex | Gets a single lists index value from a property by line number | |
GetListItem | Gets a single list entry from a property by named index | |
SetListItem | Sets an existing list entries text for the property by named index | |
AddListItem | Alters or appends a list entries text for the property by named index |
GetPanel | Returns the id of the panel hosting the component | |
SetInteractive | Sets whether a component can interact with the mouse | |
GetInteractive | Gets whether a component can interact with the mouse | |
SetVisible | Sets whether a component can be seen on the panel | |
GetVisible | Gets whether a component can be seen on the panel | |
SetSolid | Sets whether a component is checked in collision detections | |
GetSolid | Gets whether a component is checked in collision detections | |
SetCompile | Sets whether a component is considered for compilation or not | |
GetCompile | Gets whether a component will be compiled or not | |
GetInstance | Gets the type-instance of the component, >= 1 is valid | |
FindChild | Finds a named object that is part of the component | |
GetRoot | Gets the root component handle | |
GetTopParent | Gets the top-level owner of the component | |
GetParent | Gets the owner of the component | |
GetNext | Gets the next (younger) sibling of the components handle | |
GetLast | Gets the previous (elder) sibling of the components handle | |
GetChildHead | Gets the first (eldest) child of the component | |
GetChildTail | Gets the last (youngest) child of the component | |
GetOriginal | Gets the original definition of the component, returns Current if no original copy | |
Clone | Clones an existing object to another position on the panel | |
Delete | Deletes an existing object, removing it from the panel |
GetPanelName | Returns the name of the panel from the id | |
GetPanelBkColour | Returns the main background colour of the panel | |
Get2dPanelCount | Gets the number of 2d panels | |
Create2dPanel | Creates a new 2d panel | |
AddNewComponent | Adds a new component to a panel |
Position | ||
GetWorldPosition | Returns the positions coordinates in (X,Y,Z) array | |
GetWorldSize | Returns the component size in (X,Y,Z) array | |
SetWorldPosition | Moves the object to the given coordinates in World coordinates | |
SetWorldSize | Sets the objects size to a value | |
Get | Gets a handle to an object representing the components current position | |
GetOrigin | Gets a handle to an empty position | |
Set | Sets an objects position based on a component or pre-defined position | |
SetCoords | Sets an objects coordinates based on a position | |
SetScale | Sets an objects scale based on a position | |
SetRotation | Sets an objects orientation based on a position | |
GetBox | Gets a handle to an object representing the components bounding box position | |
GetLineNodes | Returns the position of a line's nodes as a comma-separated list | |
SetLineNodes | Sets the nodes of a line | |
Morph | Blends positions from two sources to a destination | |
Animate | Blends positions from two sources to a destination over time | |
StopAnimate | Stops all animations started by this component | |
MoveAlong | Moves the object by the given offset relative to its parent along an axis | |
MoveBy | Moves the object by the given offset relative to its parent | |
MoveTo | Moves the object to the given coordinates relative to its parent | |
ScaleTo | Sets the objects scale to a value | |
ScaleUp | Multiplies the objects scale by a value | |
ScaleDown | Divides the objects scale by a value | |
RotateTo | Rotates the object to the given rotation | |
RotateAlong | Rotates the object by the given rotation along an axis | |
RotateX | Rotates the object around the X axis | |
RotateY | Rotates the object around the Y axis | |
RotateZ | Rotates the object around the Z axis | |
GetCoords | Returns the positions coordinates in (X,Y,Z) array | |
GetScale | Returns the positions scale in (X,Y,Z) array | |
GetQuat | Returns the positions quaternion in (X,Y,Z,W) array | |
GetEuler | Returns the positions euler angles in (P,Y,R) array | |
Math | Coordinate maths functions | |
Panel2D | 2D Panel functions | |
Camera | Camera positioning for 3D panel |
PCloud | ||
Create | Creates a new point cloud tied to a position handle | |
SetVisible | Sets whether the point cloud is displayed or not | |
SetPos | Sets the position for the point cloud to be located at | |
GetPos | Gets the position the point cloud is located at | |
SetPoints | Sets the X,Y,Z point lists | |
SetPointsEx | Sets the X,Y,Z point lists | |
SetGrid | Sets the X,Y,Z point lists in a height-map grid | |
SetGridEx | Sets the X,Y,Z point lists in a height-map grid | |
SetGridFlat | Sets the X,Y,Z point lists in a flat height-map grid | |
SetGridPoint | Given an XY on the grid, sets the vertex value at that point | |
UnitScale | Creates a unit scaled axis (X, Y or Z) with a center of zero and a range of two | |
SetColor | Sets the RGB colour of the entire cloud | |
SetColors | Sets the RGB colour of the individual points in the cloud | |
SetGridColor | Given an XY on the grid, sets the vertex colour at that point | |
SetMode | Sets the rendering mode of the point cloud | |
SetPointLight | Enables or disables simple lighting for point mode, providing a normal passing through the point and (0,0,0) | |
Update | Manually refresh the screen the point cloud exists on |
LinkBar | ||
Create | Creates a new bar linking a pair of position handles | |
SetVisible | Sets whether the link is displayed or not | |
SetStartPos | Sets the position for the start point of the bar | |
SetEndPos | Sets the position for the end point of the bar | |
SetStartAdjustment | Sets the clipping adjustments for the beginning of the link | |
SetEndAdjustment | Sets the clipping adjustments for the end of the link | |
SetStartGfx | Sets the graphic for the start point of the bar | |
SetBarGfx | Sets the graphic for the main line of the bar | |
SetEndGfx | Sets the graphic for the end point of the bar | |
GetStartPos | Gets the position the bars start point is located at | |
GetBarPos | Gets the position the bar is located at | |
GetEndPos | Gets the position the bars end point is located at | |
Update | Manually refresh the screen the bar exists on | |
EnableAuto | Sets whether Flowcode should automatically draw links for component object property types |
TextLabel | ||
Create | Creates a new text label that always faces the camera | |
SetVisible | Sets whether the label is displayed or not | |
SetPos | Sets the position for the point to draw the text at | |
SetOffset | Sets the offset from the SetPos() position for the label | |
SetText | Sets the text for the label | |
SetScale | Sets the multipliers for the width and height of the label | |
SetColors | Sets the foreground and background colours for the label | |
SetViewMode | Sets whether to draw at a fixed size or to scale based on distance from the camera | |
GetPos | Gets the position the label is located at | |
Update | Manually refresh the screen the label exists on |
Collision | ||
TestTable | Tests whether an object collides with the table top, returns Z distance to move to rest on the table | |
TestSingle | Tests whether an object collides with a position | |
GetSingleAxis | Tests whether an object collides with a position | |
GetSinglePos | Returns the position to move Pos to so it does not collide with Test - null if no collide | |
GetMultiAxis | Tests whether an object collides with a position | |
GetMultiPos | Returns the position to move Pos to so it does not collide with any other object - null if no collide |
Graphics | ||
Redraw | Sends a redraw request to the given component | |
SetColor | Sets the draw colour for and subsequent graphics objects | |
SetColorRGB | Sets the draw colour for and subsequent graphics objects | |
SetTextFont | Sets the text font for subsequent text objects | |
SetTextScale | Sets the text scale for subsequent text objects | |
SetLineThickness | Sets the thinkness when drawing lines and points | |
DrawCreate | Creates a drawing area on a shape | |
DrawBegin | Begins drawing on a given shape | |
DrawEnd | Ends drawing started with DrawBegin() | |
DrawDelete | Deletes a drawing area for a shape | |
DrawText | Draws a line of text texture | |
DrawPoint | Draws a point on a texture | |
DrawLine | Draws a line on a texture | |
DrawLineA | Draws a smooth line on a texture | |
DrawRect | Draws a rectangle on a texture | |
DrawCircle | Draws a circle on a texture | |
Clear | Clear texture to the given component | |
Shape | Routines to change the last drawn shape |
GetButtons | Gets the button state from the mouse: 4 for left, 1 for right | |
GetFocus | Gets the handle of the component under the mouse | |
GetPosition | Gets the position of the mouse, intersecting with a component or the viewing plane | |
GetPosition2D | Gets the X/Y position of the mouse in screen coords | |
GetClickSide | Gets the side of the component clicked on, 0 to 5 | |
SimClick | Simulates a click on an object | |
SimDrag | Simulates a click-drag on an object | |
SimRelease | Simulates a click-release on an object |
GetItemValue | Gets a paths item value from the FCD document | |
GetItemHandle | Gets a FCD items handle, suitable for traversal with the Tree API | |
GetPathHandle | Gets a FCD paths handle, suitable for traversal with the Tree API | |
SetItemValue | Override item value from the FCD document from path | |
ResetItemValue | Reset paths item value from the FCD document |
Play | Plays a formatted file sound, returns true if the sound played OK | |
LoadWav | Loads a wave file into memory, providing the values needed to play it | |
Create | Creates a sound object that data can be played through | |
SetVolume | Sets the volume of playbacks for this sound | |
GetVolume | Gets the volume of playbacks for this sound in the range 0 to 1 | |
GetBits | Gets the number of bits per sample for the sound | |
GetRate | Gets the current sample rate for the sound | |
SetRate | Sets the current sample rate for the sound - this will stop the playing sound | |
Queue | Queues a sound for playing | |
QueueEx | Queues a sound for playing, with the format provided | |
Flush | Stops all playing and queued sounds | |
GetPending | Gets the number of sample blocks queued or playing for the sound |
AddGroup | Adds a group to the scope to which streams may be added | |
ShowGroup | Sets the visibility of the given group | |
AddStream | Adds a stream to the given group suitable for inputs and operations | |
AddBuffer | Adds a fixed-view stream to the given group suitable for inputs and operations | |
Rename | Renames the given scope group, stream or buffer | |
SetYAxisLabels | Sets the labels for the Y-axis of the given stream | |
SetLineColor | Sets the group, stream or buffers line colour | |
GetLineColor | Gets the streams line colour | |
SetBackColor | Sets the groups background colour | |
GetBackColor | Gets the stream groups background colour | |
SetDecodable | Sets whether a stream can be decoded via the components event - defaults to 'true' | |
GetDecodable | Gets whether a stream can be decoded via the components event - defaults to 'true' | |
AddPort | Adds an input to the stream from a port | |
AddAnalog | Adds an input to the stream from an analog channel | |
AddCustom | Adds an input to the stream from a custom injection | |
AddOp | Adds an operation to act on the inputs of the stream | |
ClearOps | Clears all inputs and operations from the given stream | |
SetBuffer | Sets the contents of a snapshot stream | |
SetCustom | Sets one of 32 custom analog values for the group | |
GetSnapshot | Gets a block of the output stream with each input sample operated on, returns number of samples read | |
FindOutput | Searches back through the output history for a value, returns offset of found sample from TimeUS, 0 if not found | |
FindPeriod | Attempts to calculate the wave period given a series of transitions for the stream, returns calculated period | |
SetPacketFmt | Sets the graphical format of the packets added with AddPacket and Add...Packets | |
GetPacketFmt | Returns the graphical format of the packets added with AddPacket and Add...Packets | |
AddPacket | Adds an overlay packet to the stream at a given offset from the current time | |
AddStepPackets | Adds overlay packets to the stream by decoding the stream contents with a fixed period rate | |
AddSyncPackets | Adds overlay packets to the stream by decoding the stream contents with a variable period rate | |
ClearPackets | Clears existing overlay packets from the stream | |
ClearAllPackets | Clears all existing overlay packets from the stream | |
TicksToSecs | Converts a duration in ticks into a time in seconds | |
SecsToTicks | Converts a time in seconds into a duration in ticks |
FloatToStorageULong | Converts a float to an array containing 4 bytes | |
StorageULongToFloat | Returns a float value from an unsigned long representation (used to store or transfer it) | |
GetFrequencyArray | Calculates the frequency from an array of data. | |
GetAmplitudeArray | Calculates the amplitude from an array of data. |
AddText | Adds a window to the list of consoles available | |
AddMemory | Adds a window to the list of consoles available | |
GetDefault | Gets the default (read-only) console window | |
GetConsole | Gets a console window | |
GetName | Returns the name of a console | |
Rename | Renames the given console | |
SetMemMode | Sets whether to show address and bytes for the console | |
SetInputRGB | Sets the colour of text inserted by the user from now on | |
SetOutputRGB | Sets the colour of text inserted by the component from now on | |
WriteText | Adds a block of text to the console window | |
GetLineText | Reads a line of text from the given console, pass -1 for final line | |
SetLineText | Writes a line of text from the given console, pass -1 for final line | |
GetLineBytes | Reads a line of bytes from the given console extending the array if needed | |
SetLineBytes | Writes a line of bytes from the given console, pass -1 for final line | |
CountLines | Counts the number of lines in the console | |
ClearText | Clears all the text in the console |
GetPort | Gets a ports value from its index | |
SetPort | Sets a ports value from its index | |
GetAn | Gets an analog value from its channel index | |
SetAn | Sets an analog value from its index, range 0->1 | |
DecodePort | Gets a ports details from its name or index |
PathName | Expands a string using the built-in pathname expansion variables | |
MacroName | Expands a string to the name of a macro used in the generated code | |
VarName | Expands a string to the name of a global variable used in the generated code | |
Property | Expands a string to the name of a property used in the generated code | |
MacroHead | Expands a macro name to the code generated for the header of that macro | |
MacroBody | Expands a macro name to the code generated for the body of that macro | |
MacroTail | Expands a macro name to the code generated for the tail of that macro |
GetValue | Gets the value of the given object, if available | |
GetName | Gets the name of the given object | |
GetPath | Gets the full '.' separated name of the given object | |
GetSubValue | Gets the value of a named sub-item of the given object, if available | |
Traverse | Updates the object to step depth-first through the tree | |
StepNext | Updates the object to point to the next (younger) sibling | |
StepNamedNext | Updates the object to point to the next (younger) sibling matching the name | |
StepNamedIndex | Updates the object to point to the Nth next (younger) sibling matching the name | |
StepLast | Updates the object to point to the last (elder) sibling | |
StepParent | Updates the object to point to its parent object | |
StepRoot | Updates the object to point to the root of the tree | |
StepChildHead | Updates the object to point to the head (eldest) child | |
StepChildTail | Updates the object to point to the tail (youngest) child | |
StepChildPath | Updates the object to point to the '.' separated named child path | |
CountChildren | Returns the number of immediate children present for the object | |
CheckChildren | Returns true if the object has children, else false | |
CountNamedChildren | Returns the number of immediate children present for the object | |
CheckParent | Returns true if the object has a parent, else false if it is the root | |
StepSubHead | Updates the object to point to the head (eldest) attribute, if any | |
StepSubTail | Updates the object to point to the tail (youngest) attribute, if any | |
StepSubName | Updates the object to point to the named attribute, if any | |
GetCopy | Creates a copy of the handle and returns the copy |
AbsPath | Gets an absolute path from a relative filename | |
RelPath | Gets an relative path from an absolute filename | |
CreateDir | Creates a directory structure | |
GetType | Finds the type of a file: 0=Unknown, 1=File, 2=Dir, 4=Disk | |
GetSize | Gets the number of bytes in the file, by handle or name | |
Delete | Deletes the file or directory structure | |
Create | Creates the new file as a standard stream | |
Open | Opens the existing file as a standard stream | |
ReadArray | Reads an array from the file, returns elements read | |
WriteArray | Writes an array to the file | |
SetPos | Sets the position of the next read or write in the file | |
GetPos | Gets the position of the next read or write in the file | |
Flush | Writes all unwritten data to the file in one block |
Buffer | ||
Open | Opens the existing file as a circular buffer | |
Create | Creates the new file as a circular buffer | |
ReadByte | Reads a single byte from the input stream, -1 if empty | |
WriteByte | Writes a single byte to the input stream | |
ReadArray | Reads an array from the input stream, returns elements read | |
WriteArray | Writes an array to the input stream |
NVM | ||
Open | Opens the existing file as a block of non-volatile memory | |
Create | Creates the new file as a block of non-volatile memory | |
ReadByte | Reads a single byte from the NVM, -1 if empty | |
WriteByte | Writes a single byte to the NVM multiple times | |
ReadArray | Reads an array from the NVM, returns elements read | |
WriteArray | Writes an array to the NVM |
SimpleMsgBox | Displays a simple 'Ok' message box | |
Win32MsgBox | Invokes the Win32 API MessageBox function | |
YesNoMsgBox | Displays a simple 'Yes/No' message box | |
YesNoCancelMsgBox | Displays a simple 'Yes/No/Cancel' message box (0 == Cancel, 1 == No, 2 == Yes) | |
InputMsgBox | Displays a message box that allows the user to input text. Returns true if 'Ok' clicked, false otherwise |
GetMillisecs | Returns the value of a monotonic non-decrementing millisecond counter | |
GetUTC | Returns the current UTC Modified Julian Date value | |
GetLocal | Returns the current local time as a Modified Julian Date value | |
AddMJD | Increments or decrements a Modified Julian Date and millisecond value | |
MJDToDate | Converts a Modified Julian Date into a Gregorian calendar date | |
DateToMJD | Converts a Gregorian calendar date into a Modified Julian Date | |
MJDToSeconds | Converts a Modified Julian Date into a number of seconds since a specified epoch | |
SecondsToMJD | Returns the Modified Julian Date given by the number of seconds since a specified epoch | |
MJDToWeekday | Gets the day of the week that the MJD represents | |
GetLeapYear | Returns true if the given year is a leap year, else false | |
GetMonthDays | Returns the number of days in the given month |
Translate | Takes English text and optional hint and converts to the current language |
Notify | Sends a System.User message to the targeted component | |
Forward | Sends the currently processing message to the target | |
MacroExists | Returns true if the macro exists | |
CallMacro | Calls a macro | |
ShowHandle | Given a handle to an object with viewable presence, shows that object on screen | |
CreateHandle | Creates a general-purpose garbage collected handle for resource management | |
SetHandleWord | Sets a general purpose word in the handle for use by its owner | |
GetHandleWord | Gets a general-purpose word set by the owner of a custom handle | |
DeleteHandle | Deletes any handle created by the component | |
GetSender | Gets the handle of the component that posted this event - 0 for system | |
TimerStart | Calls the Component.Timer event with Ident as an argument after Millisecs time | |
TimerStop | Kills any timers with the given ident for this component | |
WDTEnable | Enables or disables the software watchdog during long operations | |
ClaimEvent | Claims an event message by name, returns true if claimed | |
ReleaseEvent | Releases a previously claimed an event message by name, returns true if released | |
EnableEvent | Allows an event to be fired or removes the ability for an event to fire - this may be nested | |
ClaimMouse | Claims mouse clicks for the target object | |
ReleaseMouse | Releases mouse clicks for the target object | |
RedirectMacros | Allows calls to one of your children to be redirected to another component | |
StartSim | Start the simulation engine | |
StopSim | Stop the simulation engine | |
SetSimSpeed | Sets the speed the simulation engine | |
SetClipboardData | Sets the clipboard with text data | |
ReadClipboardData | Reads text data from the clipboard | |
GetHasFocus | Checks to see if a Flowcode window has the focus | |
ShellExecute | Launches an external file or program on this computer | |
WriteRegistryInt | Writes an integer value to the registry | |
WriteRegistryString | Writes a string value to the registry | |
ReadRegistryInt | Reads an integer value from the registry | |
ReadRegistryString | Reads a string value from the registry |
Prints out the string or value on a line in the debug window | ||
PrintLn | Prints out the string or value with a new-line in the debug window | |
TestFunction | Temporary debug function |
Events
Preprocess | Broadcast to all components immediately before compilation is started | |
AddProperty | Sent to a component to allow dynamic amendment of global property declarations | |
AddConst | Sent to a component to allow dynamic amendment of global variable declarations | |
AddVarSize | Sent to a component to allow dynamic amendment of global array-size declarations | |
AddVar | Sent to a component to allow dynamic amendment of global constant declarations | |
AddHeader | Sent to a component to allow dynamic amendment of header code | |
AddInterrupts | Sent to a component to allow dynamic amendment of the interrupts for a component | |
AddInterrupt | Sent to a component to allow dynamic amendment of a single interrupts code | |
Start | Broadcast to all components that compilation is starting | |
Stop | Broadcast to all components that compilation has stopped | |
GetVarSize | Sent to a component to amend the size of the expected array | |
HtmlBodyInfo | Sent to a component to retrieve tags to be placed in the html body | |
HtmlScriptHeader | Sent to a component to retrieve script code to be placed in the html header section |
PropertyEx | Sent when a property has been changed by the User (specific property and value identified) | |
Property | Sent when a property has been changed by the User | |
ProjectClosedown | Sent to the component when the project is closing | |
Added | Broadcast to all existing components once a new component has been added | |
Adding | Broadcast to all existing components when a new component is about to be added | |
Resize | Sent to the mouse target when the user has altered the position of a component child | |
Removed | Broadcast to all remaining components after a component has been removed | |
Removing | Broadcast to all existing components when a component is about to be removed | |
Renamed | Sent to the component when the component is renamed | |
Deleted | Closedown routine for the component | |
Deleting | Send to a component when it is being deleted | |
Initialise | Initialisation routine for the component once the component is linked to its parent | |
Initialising | Initialisation routine before the component is linked to its parent |
AddLine | Post to the owning component when a line is inserted by the user | |
TextChanged | Post when the console text is changed by the user in some way | |
MemChanged | Post when the console memory is changed by the user in some way |
PinPopulate | Sent when auto-populate of digital connections is requested | |
PinChange | Sent during simulation if a connected port pin changes | |
AnPopulate | Sent when auto-populate of analog connections is requested | |
AnChange | Sent during simulation if a connected ADC channel changes | |
ChipChange | Sent when the target device has changed | |
Unconnected | Sent when the component is compiled with unconnected pins | |
FCDChange | Sent when some settings of the target device have changed |
Pause | Broadcast to all components that simulation has paused | |
Resume | Broadcast to all components that simulation has resumed | |
Start | Broadcast to all components that simulation is starting | |
Stop | Broadcast to all components that simulation has stopped |
CleanHandle | Called when a custom handle is deleted to allow cleanup of resources | |
Timer | Called back on the panel command System.TimerStart | |
User | Called back on the panel command System.Notify | |
LoadComplete | Broadcast after a project has finished loading |
Complete | Sent when a sound queued by the component has finished playing |
ResyncPacket | Sent when Packet_ResyncEv is specified in scope decoding | |
Decode | Sent when a block of the stream is to be decoded into packets | |
FmtPacket | Sent when a %e is read in a format string when decoding a packet | |
Overlay | Sent when the mouse hovers over a scope stream |
GraphicPoll | Called when a tooltip graphic is updating with the draw image already pushed | |
GetText | Called when a tooltip text string can be displayed | |
GetGraphic | Called when a tooltip graphic can be displayed with the draw image already pushed |
Animated | Notification than an animation has finished | |
Background | Updates the background container of the 2d panel | |
Redraw | Reconstructs and redraws the target component |
ButtonName | Sent to give a meaningful name to a button on a simulated mouse-click | |
KeyMapDown | Post when a mapped key is pressed for the component | |
KeyMapUp | Post when a mapped key is released for the component | |
MappingKeys | Sent to find out how many keys it is possible to map to the component during simulation | |
MappingName | Sent to give a meaningful name to a custom key-map event for a component |