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