Difference between revisions of "Lua:Class:Component"
Jump to navigation
Jump to search
Line 1: | Line 1: | ||
− | ''' | + | Component '''class''': ('''Inheritance''': ''[[Object]]'') |
− | Base class for components | + | Base class for components. |
− | + | == Properties == | |
− | + | ; ComponentCount : integer : ''Readonly'' | |
− | + | : Number of child components. | |
− | |||
− | |||
− | |||
− | |||
− | + | ; Component[int] : Component : ''Readonly'' | |
− | + | : Array containing the child components. Starts at 0. | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | ; ComponentByName[string] : Component : ''Readonly'' | |
+ | : Returns a component based on the name. | ||
− | * [[Lua| | + | ; Name : string |
+ | : The name of the component. | ||
+ | |||
+ | ; Tag : integer | ||
+ | : Free to use storage space. (Usefull for id's) | ||
+ | |||
+ | ; Owner : Component | ||
+ | : Returns the owner of this object. Nil if it has none. | ||
+ | |||
+ | == Methods == | ||
+ | ; getComponentCount() : integer | ||
+ | : Returns the number of components attached to his component. | ||
+ | |||
+ | ; getComponent(index) : Component | ||
+ | : Returns the specific component. | ||
+ | |||
+ | ; findComponentByName(name) : Component | ||
+ | : Returns the component with this name. | ||
+ | |||
+ | ; getName() : string | ||
+ | : Return the name. | ||
+ | |||
+ | ; setName(newname) | ||
+ | : Changes the name. | ||
+ | |||
+ | ; getTag() : integer | ||
+ | : Get the tag value. | ||
+ | |||
+ | ; setTag(tagvalue) | ||
+ | : Sets an integer value. You can use this for ID's. | ||
+ | |||
+ | ; getOwner() : Component | ||
+ | : Returns the owner of this component | ||
+ | |||
+ | == See also == | ||
+ | * [[Lua]] | ||
+ | * [[Help_File:Script engine|Script engine]] | ||
+ | |||
+ | === Related Functions === | ||
+ | * [[createClass]] | ||
+ | * [[inheritsFromObject]] | ||
+ | * [[inheritsFromComponent]] | ||
+ | * [[inheritsFromControl]] | ||
+ | * [[inheritsFromWinControl]] | ||
+ | |||
+ | === Related Classes === | ||
+ | * [[Object]] | ||
+ | * [[Control]] | ||
+ | * [[WinControl]] | ||
+ | * [[Application]] | ||
+ | * [[Form]] |
Revision as of 22:47, 10 March 2017
Component class: (Inheritance: Object)
Base class for components.
Properties
- ComponentCount : integer : Readonly
- Number of child components.
- Component[int] : Component : Readonly
- Array containing the child components. Starts at 0.
- ComponentByName[string] : Component : Readonly
- Returns a component based on the name.
- Name : string
- The name of the component.
- Tag : integer
- Free to use storage space. (Usefull for id's)
- Owner : Component
- Returns the owner of this object. Nil if it has none.
Methods
- getComponentCount() : integer
- Returns the number of components attached to his component.
- getComponent(index) : Component
- Returns the specific component.
- findComponentByName(name) : Component
- Returns the component with this name.
- getName() : string
- Return the name.
- setName(newname)
- Changes the name.
- getTag() : integer
- Get the tag value.
- setTag(tagvalue)
- Sets an integer value. You can use this for ID's.
- getOwner() : Component
- Returns the owner of this component