There is no spoon
UE3:UILayer (UDK)
From Unreal Wiki, The Unreal Engine Documentation Site
Revision as of 06:50, 17 January 2010 by Wormbo (Talk | contribs) (1 revision: class descriptions for UDK January update (part 6))
 |
Object >> UIRoot >> UILayerBase >> UILayer |
- Package:
- UnrealEd
- Direct subclass:
- UILayerRoot
- This class in other games:
- UT3
| This is an auto-generated page and may need human attention. Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete. |
This class acts as a cosmetic container for grouping widgets in the UI editor.
Properties[edit]
LayerName[edit]
Type: string
The designer-specified friendly name for this layer
LayerNodes[edit]
Type: array<UILayerNode>
the child nodes of this layer
Structs[edit]
UILayerNode[edit]
Modifiers: native
Represents a single node in the UI editor layer brower.
- bool bLocked
- Indicates whether this layer node is active. Locked layer nodes cannot be selected in the UI editor window
- bool bVisible
- Indicates whether this layer node is visible. Hidden layer nodes are not rendered in the UI editor window.
- Object LayerObject
- The object associated with this layer node. Only UILayer and UIObject are valid.
- UILayer ParentLayer
- The UILayer that contains this layer node.
Default values:
| Property | Value |
|---|---|
| bVisible | True |
Native functions[edit]
FindNodeIndex[edit]
Finds the index [into the LayerNodes array] for a child node that contains the specified object as its layer object.
Parameters:
- NodeObject - the child layer object to look for.
Returns:
- the index into the LayerNodes array for the child node which contains the specified object as its layer object, or INDEX_NONE if no child nodes were found that containc the specified object as its layer object.
InsertNode[edit]
native final function bool InsertNode (const out UILayerNode NodeToInsert, optional int InsertIndex)
Inserts the specified node at the specified location
Parameters:
- NodeToInsert - the layer node that should be inserted into this UILayer's LayerNodes array
- InsertIndex - if specified, the index where the new node should be inserted into the LayerNodes array. if not specified the new node will be appended to the end of the array.
Returns:
- TRUE if the node was successfully inserted into this UILayer's list of child nodes.
RemoveNode[edit]
native final function bool RemoveNode (const out UILayerNode ExistingNode)
Removes the specified node
Parameters:
- ExistingNode - the layer node that should be removed from this UILayer's LayerNodes array
Returns:
- TRUE if the node was successfully removed from this UILayer's list of child nodes.
