API Component: Difference between revisions
XML import |
XML import |
||
| Line 5: | Line 5: | ||
{| | {| | ||
|- | |- | ||
|[[API Component.Property|Property]] | |width="35%"|[[API Component.Property|Property]] | ||
|Property manipulation functions | |Property manipulation functions | ||
|- | |- | ||
|[[API Component.SetInteractive|SetInteractive]] | |width="35%"|[[API Component.SetInteractive|SetInteractive]] | ||
|Sets whether a component can interact with the mouse | |Sets whether a component can interact with the mouse | ||
|- | |- | ||
|[[API Component.GetInteractive|GetInteractive]] | |width="35%"|[[API Component.GetInteractive|GetInteractive]] | ||
|Gets whether a component can interact with the mouse | |Gets whether a component can interact with the mouse | ||
|- | |- | ||
|[[API Component.SetVisible|SetVisible]] | |width="35%"|[[API Component.SetVisible|SetVisible]] | ||
|Sets whether a component can be seen on the panel | |Sets whether a component can be seen on the panel | ||
|- | |- | ||
|[[API Component.GetVisible|GetVisible]] | |width="35%"|[[API Component.GetVisible|GetVisible]] | ||
|Gets whether a component can be seen on the panel | |Gets whether a component can be seen on the panel | ||
|- | |- | ||
|[[API Component.SetSolid|SetSolid]] | |width="35%"|[[API Component.SetSolid|SetSolid]] | ||
|Sets whether a component is checked in collision detections | |Sets whether a component is checked in collision detections | ||
|- | |- | ||
|[[API Component.GetSolid|GetSolid]] | |width="35%"|[[API Component.GetSolid|GetSolid]] | ||
|Gets whether a component is checked in collision detections | |Gets whether a component is checked in collision detections | ||
|- | |- | ||
|[[API Component.GetInstance|GetInstance]] | |width="35%"|[[API Component.GetInstance|GetInstance]] | ||
|Gets the type-instance of the component, >= 1 is valid | |Gets the type-instance of the component, >= 1 is valid | ||
|- | |- | ||
|[[API Component.FindChild|FindChild]] | |width="35%"|[[API Component.FindChild|FindChild]] | ||
|Finds a named object that is part of the component | |Finds a named object that is part of the component | ||
|- | |- | ||
|[[API Component.GetParent|GetParent]] | |width="35%"|[[API Component.GetParent|GetParent]] | ||
|Gets the owner of the components handle | |Gets the owner of the components handle | ||
|- | |- | ||
|[[API Component.GetNext|GetNext]] | |width="35%"|[[API Component.GetNext|GetNext]] | ||
|Gets the next (younger) sibling of the components handle | |Gets the next (younger) sibling of the components handle | ||
|- | |- | ||
|[[API Component.GetLast|GetLast]] | |width="35%"|[[API Component.GetLast|GetLast]] | ||
|Gets the previous (elder) sibling of the components handle | |Gets the previous (elder) sibling of the components handle | ||
|- | |- | ||
|[[API Component.GetChildHead|GetChildHead]] | |width="35%"|[[API Component.GetChildHead|GetChildHead]] | ||
|Gets the first (eldest) child of the component | |Gets the first (eldest) child of the component | ||
|- | |- | ||
|[[API Component.GetChildTail|GetChildTail]] | |width="35%"|[[API Component.GetChildTail|GetChildTail]] | ||
|Gets the last (youngest) child of the component | |Gets the last (youngest) child of the component | ||
|- | |- | ||
|[[API Component.GetOriginal|GetOriginal]] | |width="35%"|[[API Component.GetOriginal|GetOriginal]] | ||
|Gets the original definition of the component, returns Current if no original copy | |Gets the original definition of the component, returns Current if no original copy | ||
|- | |- | ||
|[[API Component.Clone|Clone]] | |width="35%"|[[API Component.Clone|Clone]] | ||
|Clones an existing object to another position on the panel | |Clones an existing object to another position on the panel | ||
|- | |- | ||
|[[API Component.Delete|Delete]] | |width="35%"|[[API Component.Delete|Delete]] | ||
|Deletes an existing object, removing it from the panel | |Deletes an existing object, removing it from the panel | ||
|} | |||
==Functions provided for this class== | ==Functions provided for this class== | ||
{| | {| | ||
|- | |- | ||
|[[API Component.Property|Property]] | |width="35%"|[[API Component.Property|Property]] | ||
|Property manipulation functions | |Property manipulation functions | ||
|- | |- | ||
|[[API Component.SetInteractive|SetInteractive]] | |width="35%"|[[API Component.SetInteractive|SetInteractive]] | ||
|Sets whether a component can interact with the mouse | |Sets whether a component can interact with the mouse | ||
|- | |- | ||
|[[API Component.GetInteractive|GetInteractive]] | |width="35%"|[[API Component.GetInteractive|GetInteractive]] | ||
|Gets whether a component can interact with the mouse | |Gets whether a component can interact with the mouse | ||
|- | |- | ||
|[[API Component.SetVisible|SetVisible]] | |width="35%"|[[API Component.SetVisible|SetVisible]] | ||
|Sets whether a component can be seen on the panel | |Sets whether a component can be seen on the panel | ||
|- | |- | ||
|[[API Component.GetVisible|GetVisible]] | |width="35%"|[[API Component.GetVisible|GetVisible]] | ||
|Gets whether a component can be seen on the panel | |Gets whether a component can be seen on the panel | ||
|- | |- | ||
|[[API Component.SetSolid|SetSolid]] | |width="35%"|[[API Component.SetSolid|SetSolid]] | ||
|Sets whether a component is checked in collision detections | |Sets whether a component is checked in collision detections | ||
|- | |- | ||
|[[API Component.GetSolid|GetSolid]] | |width="35%"|[[API Component.GetSolid|GetSolid]] | ||
|Gets whether a component is checked in collision detections | |Gets whether a component is checked in collision detections | ||
|- | |- | ||
|[[API Component.GetInstance|GetInstance]] | |width="35%"|[[API Component.GetInstance|GetInstance]] | ||
|Gets the type-instance of the component, >= 1 is valid | |Gets the type-instance of the component, >= 1 is valid | ||
|- | |- | ||
|[[API Component.FindChild|FindChild]] | |width="35%"|[[API Component.FindChild|FindChild]] | ||
|Finds a named object that is part of the component | |Finds a named object that is part of the component | ||
|- | |- | ||
|[[API Component.GetParent|GetParent]] | |width="35%"|[[API Component.GetParent|GetParent]] | ||
|Gets the owner of the components handle | |Gets the owner of the components handle | ||
|- | |- | ||
|[[API Component.GetNext|GetNext]] | |width="35%"|[[API Component.GetNext|GetNext]] | ||
|Gets the next (younger) sibling of the components handle | |Gets the next (younger) sibling of the components handle | ||
|- | |- | ||
|[[API Component.GetLast|GetLast]] | |width="35%"|[[API Component.GetLast|GetLast]] | ||
|Gets the previous (elder) sibling of the components handle | |Gets the previous (elder) sibling of the components handle | ||
|- | |- | ||
|[[API Component.GetChildHead|GetChildHead]] | |width="35%"|[[API Component.GetChildHead|GetChildHead]] | ||
|Gets the first (eldest) child of the component | |Gets the first (eldest) child of the component | ||
|- | |- | ||
|[[API Component.GetChildTail|GetChildTail]] | |width="35%"|[[API Component.GetChildTail|GetChildTail]] | ||
|Gets the last (youngest) child of the component | |Gets the last (youngest) child of the component | ||
|- | |- | ||
|[[API Component.GetOriginal|GetOriginal]] | |width="35%"|[[API Component.GetOriginal|GetOriginal]] | ||
|Gets the original definition of the component, returns Current if no original copy | |Gets the original definition of the component, returns Current if no original copy | ||
|- | |- | ||
|[[API Component.Clone|Clone]] | |width="35%"|[[API Component.Clone|Clone]] | ||
|Clones an existing object to another position on the panel | |Clones an existing object to another position on the panel | ||
|- | |- | ||
|[[API Component.Delete|Delete]] | |width="35%"|[[API Component.Delete|Delete]] | ||
|Deletes an existing object, removing it from the panel | |Deletes an existing object, removing it from the panel | ||
|} | |||
==Examples== | ==Examples== | ||
''No examples available'' | |||
Revision as of 13:46, 11 May 2013
<sidebar>API contents</sidebar> Component traversal functions
Sub-classes provided for this class
| Property | Property manipulation functions |
| 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 |
| 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 |
Functions provided for this class
| Property | Property manipulation functions |
| 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 |
| 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 examples available