public/0.8.xpublic/0.9.xpublic/0.10.xpublic/0.11.x

    Show / Hide Table of Contents

    UUxtBaseObjectCollection

    Base scene component class for object collections

    class UUxtBaseObjectCollection;
    

    Header

    #include <Controls/UxtBaseObjectCollection.h>

    Inheritance

    Inherits from USceneComponent

    Public Functions

    Name
    void SetSortCallback(const FUxtSortScrollingObjectCollectionDelegate & Callback)
    bool CompareText(const FText & LHS, const FText & RHS)
    bool CompareString(const FString & LHS, const FString & RHS)

    Protected Functions

    Name
    const TArray< AActor * > & GetAttachedActors() const
    const TArray< AActor * > & CollectAttachedActors()

    Public Attributes

    Name
    FUxtSortScrollingObjectCollectionDelegate SortCollection

    Public Functions Documentation

    function SetSortCallback

    inline void SetSortCallback(
        const FUxtSortScrollingObjectCollectionDelegate & Callback
    )
    

    Set the the callback function to be used by the sort to compare actor pairs. In order to see results of sorting with the editor it is necessary to enable run in editor in the functions details panel.

    function CompareText

    static inline bool CompareText(
        const FText & LHS,
        const FText & RHS
    )
    

    Helper function to allow Blueprint class to easily compare a pair of text objects within sort.

    function CompareString

    static inline bool CompareString(
        const FString & LHS,
        const FString & RHS
    )
    

    Helper function to allow Blueprint class to easily compare a pair of string objects within sort.

    Protected Functions Documentation

    function GetAttachedActors

    inline const TArray< AActor * > & GetAttachedActors() const
    

    Get the array of attached actors.

    function CollectAttachedActors

    const TArray< AActor * > & CollectAttachedActors()
    

    Collect array of actors that are currently attached to the actor that this component is a part of.

    Public Attributes Documentation

    variable SortCollection

    FUxtSortScrollingObjectCollectionDelegate SortCollection;
    

    Updated on 19 August 2021 at 17:42:51 Coordinated Universal Time

    • Improve this Doc
    In This Article
    • Header
    • Inheritance
    • Public Functions
    • Protected Functions
    • Public Attributes
    • Public Functions Documentation
      • function SetSortCallback
      • function CompareText
      • function CompareString
    • Protected Functions Documentation
      • function GetAttachedActors
      • function CollectAttachedActors
    • Public Attributes Documentation
      • variable SortCollection
    Back to top Generated by DocFX