ui.ComponentCollection¶

Overview¶

ui.Component -> ui.ComponentCollection

Base type common to all user interface layout components.

The following layout component types are available:

• Layer - Simple component that allows arbitrary positioning/sizing of child components
• Panel - Automatically positions/resizes components along the panel's direction (either horizontal or vertical), taking into account total component sizes across that dimension.
• Grid - Organises components in a grid. Supports using either fixed-size grid cells, resulting in dynamic rows and columns, or a fixed number of rows and columns, which results in dynamic grid cell sizes
• Paged Layer - A tabbed version of the layer component, and containing functionality for creating tab headers.
• Paged Carousel - A variant of Paged Layer that has built-in functionality for switching between pages, and supports displaying the contents of multiple pages at a time as part of a horizontal carousel.
• Group Box - Similar to Layer in that it allows arbitrary positioning/sizing of child components, but additionally encloses them in a box with an optional header label.

Methods¶

IterateStaticComponents/IterateDynamicComponents¶

function ComponentCollection:IterateStaticComponents(callback : function (component : ui.Component, visible : Bool) -> Bool)
function ComponentCollection:IterateDynamicComponents(callback : function (component : ui.Component, visible : Bool) -> Bool)

Iterates over statically defined components contained in this collection, executing the provided callback once for each component, optionally stopping based on the callback's return value.

-- Report the dynamic ID and visible status
collection:IterateDynamicComponents(
    function (component, visible)
        log("Found component", component.dynamicID, " visible=", visible)
        return false -- Keep iterating
    end)

GetChild¶

function ComponentCollection:GetChild(staticID : Int) -> Component<T>?
function ComponentCollection:GetChild(categoryID : Int, dynamicID : Int) -> Component<T>?

Attempts to retrieve the static or dynamic child component corresponding to the provided IDs, returning nil if missing.

local static = collection:GetChild(100)
if static ~= nil then
    local dyn = static:GetChild(0, 1)

    if dyn ~= nil then
        print("Found dynamic component on static parent with ID 100")
    end
end

Delete¶

function ComponentCollection:Delete(categoryID : Int, dynamicID : Int) -> Bool

Attempts to delete the dynamic child component corresponding to the provided IDs, returning true if successful.

local static = collection:GetChild(100)
if static ~= nil then
    if static:Delete(0, 1) then
        print("Successfully deleted the dynamic component")
    end
end

DeleteAll¶

function ComponentCollection:DeleteAll()

Deletes all dynamically created child components contained in the current collection.

SetScrollPos¶

function ComponentCollection:SetScrollPos(x : Int, y : Int)

Sets the origin of this component's scroll region, if it supports scrolling.

SetScrollSize¶

function ComponentCollection:SetScrollSize(width : Int, height : Int)

Sets the size of this component's scroll region, if it supports scrolling.

Properties¶