Difference between revisions of "API Component"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| (10 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Component traversal functions | Component traversal functions | ||
| − | + | ||
| + | __TOC__ | ||
| + | |||
| + | ==Sub-classes provided for this class== | ||
{| | {| | ||
| − | |-|[[API Component.Property|Property]]|Property manipulation functions | + | |- |
| + | |width="35%"|[[API Component.Property|Property]] | ||
| + | |Property manipulation functions | ||
|} | |} | ||
| − | + | ||
| + | ==Functions provided for this class== | ||
{| | {| | ||
| − | |-| | + | |- |
| + | |width="35%"|[[API Component.SetInteractive|SetInteractive]] | ||
| + | |Sets whether a component can interact with the mouse | ||
| + | |- | ||
| + | |width="35%"|[[API Component.GetInteractive|GetInteractive]] | ||
| + | |Gets whether a component can interact with the mouse | ||
| + | |- | ||
| + | |width="35%"|[[API Component.SetVisible|SetVisible]] | ||
| + | |Sets whether a component can be seen on the panel | ||
| + | |- | ||
| + | |width="35%"|[[API Component.GetVisible|GetVisible]] | ||
| + | |Gets whether a component can be seen on the panel | ||
| + | |- | ||
| + | |width="35%"|[[API Component.SetSolid|SetSolid]] | ||
| + | |Sets whether a component is checked in collision detections | ||
| + | |- | ||
| + | |width="35%"|[[API Component.GetSolid|GetSolid]] | ||
| + | |Gets whether a component is checked in collision detections | ||
| + | |- | ||
| + | |width="35%"|[[API Component.SetCompile|SetCompile]] | ||
| + | |Sets whether a component is considered for compilation or not | ||
| + | |- | ||
| + | |width="35%"|[[API Component.GetCompile|GetCompile]] | ||
| + | |Gets whether a component will be compiled or not | ||
| + | |- | ||
| + | |width="35%"|[[API Component.GetInstance|GetInstance]] | ||
| + | |Gets the type-instance of the component, >= 1 is valid | ||
| + | |- | ||
| + | |width="35%"|[[API Component.FindChild|FindChild]] | ||
| + | |Finds a named object that is part of the component | ||
| + | |- | ||
| + | |width="35%"|[[API Component.GetParent|GetParent]] | ||
| + | |Gets the owner of the components handle | ||
| + | |- | ||
| + | |width="35%"|[[API Component.GetNext|GetNext]] | ||
| + | |Gets the next (younger) sibling of the components handle | ||
| + | |- | ||
| + | |width="35%"|[[API Component.GetLast|GetLast]] | ||
| + | |Gets the previous (elder) sibling of the components handle | ||
| + | |- | ||
| + | |width="35%"|[[API Component.GetChildHead|GetChildHead]] | ||
| + | |Gets the first (eldest) child of the component | ||
| + | |- | ||
| + | |width="35%"|[[API Component.GetChildTail|GetChildTail]] | ||
| + | |Gets the last (youngest) child of the component | ||
| + | |- | ||
| + | |width="35%"|[[API Component.GetOriginal|GetOriginal]] | ||
| + | |Gets the original definition of the component, returns Current if no original copy | ||
| + | |- | ||
| + | |width="35%"|[[API Component.Clone|Clone]] | ||
| + | |Clones an existing object to another position on the panel | ||
| + | |- | ||
| + | |width="35%"|[[API Component.Delete|Delete]] | ||
| + | |Deletes an existing object, removing it from the panel | ||
|} | |} | ||
| − | === | + | |
| + | ==Examples== | ||
| + | ''<span style="color:red;">No additional examples</span>'' | ||
| + | |||
| + | ==See also== | ||
| + | [[API Tree]] | ||
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Component traversal functions
Contents
Sub-classes provided for this class
| Property | Property manipulation functions |
Functions provided for this class
| 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 |
| GetParent | Gets the owner of the components handle |
| 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 |
Examples
No additional examples
