• Studio

  • Studio API

  • Bots

  • Web API

  • Designer Resources

  • Host Resources

  • Globals

    UICollectionCells

    Inherits from:

    Element that manages a collection of cells within a UICollection. This element should only be used from within a UICollectionSection otherwise the behaviour is unknown.

    Properties

    cellCount

    number
    ClientOnly
    ReadOnly

    Return the number of cells in the collection

    collection

    ClientOnly
    ReadOnly

    Returns the parent collection

    hasLayout

    boolean
    ClientOnly
    ReadOnly

    Returns true if the cells container has a layout defined

    loading

    boolean
    ClientOnly

    Set to true to show the loading indicator

    section

    ClientOnly
    ReadOnly

    Returns the parent section

    selection

    number[]
    ClientOnly
    ReadOnly

    Returns the selection cell index

    selectionCount

    number
    ClientOnly
    ReadOnly

    Returns the number of selected cells

    visibleCells

    ClientOnly
    ReadOnly

    Methods

    AddCell

    ClientOnly

    Add a single cell to the end

    Returns

    void

    AddCells

    ClientOnly

    Add one or more cells to the end

    Parameters

    count
    number

    Returns

    void

    Deselect

    ClientOnly

    Deselect a cell using the cell view

    Parameters

    cell

    Returns

    void

    Deselect

    ClientOnly

    Deselect a cell using the cell index

    Parameters

    cellIndex
    number

    Returns

    void

    DeselectAll

    ClientOnly

    Deselect all cells in the collection

    Returns

    void

    Dispose

    ClientOnly

    Returns

    void

    Enumerate all visible cells in the collection. Note that no changes to the cells should be made during a call to enumerate or the results will be unknown.

    Parameters

    enumerate
    (cell: UIView, cellIndex: number, selected: boolean) -> (boolean)

    Returns

    void

    GetVisibleCell

    ClientOnly

    Return the cell for the given visible cell for the index or null if the cell is not visible

    Parameters

    cellIndex
    number

    Returns

    IndexOf

    ClientOnly

    Return the index of the given cell within the collection. If the cell is not found a value of -1 will be returned.

    Parameters

    cell

    Returns

    number

    InsertCell

    ClientOnly

    Parameters

    index
    number

    Returns

    void

    InsertCells

    ClientOnly

    Insert one or more cells into the collection. If the given index is <0 then add to the end

    Parameters

    index
    number
    count
    number

    Returns

    void

    InstantiateCell

    ClientOnly

    Instantiates a new cell within the container and returns the instance. This method may pull cells from the recycle bin if available.

    Parameters

    cellIndex
    number

    Index of the cell within the collection to instantiate

    Returns

    IsSelected

    ClientOnly

    Returns true if the given cell is selected

    Parameters

    cell

    Returns

    boolean

    IsSelected

    ClientOnly

    Returns true if the given cell index is selected

    Parameters

    cellIndex
    number

    Returns

    boolean

    ItemSizeChanged

    ClientOnly

    Parameters

    itemIndex
    number
    itemPosition
    number
    delta
    number

    Returns

    void

    RecycleAllCells

    ClientOnly

    Returns

    void

    RecycleCell

    ClientOnly

    Recycle the given cell using the appropriate recycling method.

    Parameters

    index
    number
    cell

    Returns

    void

    RemoveAllCells

    ClientOnly

    Remove all cells from the collection

    Returns

    void

    RemoveCell

    ClientOnly

    Remove a single cell from the collection

    Parameters

    index
    number

    Index of the cell to remove

    Returns

    void

    RemoveCells

    ClientOnly

    Remove all cells in the given range. Note that this call must be made from within PerformUpdates

    Parameters

    index
    number

    Starting index

    count
    number

    Number of cells to remove

    Returns

    void

    ScrollTo

    ClientOnly

    Scroll to the cell at the given index

    Parameters

    cellIndex
    number
    additionalOffset
    number
    optional

    Returns

    void

    Select

    ClientOnly

    Select the given cell and deselect all other cells. To add a cell to the selection pass true for the add parameter

    Parameters

    cell
    add
    boolean
    optional

    Returns

    void

    Select

    ClientOnly

    Select the cell at the given index and deselect all other cells. To add a cell to the selection pass true for the add parameter

    Parameters

    cellIndex
    number
    add
    boolean
    optional

    Returns

    void

    Returns the cell's index in the selection list if it's selected or -1 if it's not

    Parameters

    cellIndex
    number

    Returns

    number

    SetLayout

    ClientOnly

    Parameters

    Returns

    void

    SetLayout

    ClientOnly

    Parameters

    Returns

    void

    Toggle

    ClientOnly

    Toggles the selection state of the cell

    Parameters

    cell
    add
    boolean
    optional

    Returns

    void

    Toggle

    ClientOnly

    Toggles the selection state of the cell

    Parameters

    cellIndex
    number
    add
    boolean
    optional

    Returns

    void

    UpdateCell

    ClientOnly

    Parameters

    index
    number

    Returns

    void

    UpdateCells

    ClientOnly

    Parameters

    index
    number
    count
    number

    Returns

    void

    UpdateLayout

    ClientOnly

    Parameters

    min
    number
    max
    number

    Returns

    number
    PocketWorlds Icon

    © 2026 Pocket Worlds. All rights reserved.