UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
TypedElementListLibrary.h
Go to the documentation of this file.
1// Copyright Epic Games, Inc. All Rights Reserved.
2
3#pragma once
4
5#include "CoreMinimal.h"
9#include "TypedElementListLibrary.generated.h"
10
11UCLASS()
13{
15
16public:
20 UFUNCTION(BlueprintCallable, DisplayName="Create Element List", Category = "TypedElementFramework|Registry", meta=(ScriptMethod, ScriptName="CreateElementList"))
22 {
23 return Registry->CreateScriptElementList();
24 }
25
30 UFUNCTION(BlueprintCallable, Category="TypedElementFramework|List", meta=(ScriptMethod))
36
41 UFUNCTION(BlueprintPure, Category="TypedElementFramework|List", meta=(ScriptMethod))
42 static FScriptTypedElementHandle GetElementHandleAt(const FScriptTypedElementListProxy ElementList, const int32 Index)
43 {
44 FScriptTypedElementListConstPtr ElementListPtr = ElementList.GetElementList();
45 return ElementListPtr ? ElementListPtr->GetElementHandleAt(Index) : FScriptTypedElementHandle();
46 }
47
51 UFUNCTION(BlueprintPure, Category="TypedElementFramework|List", meta=(ScriptMethod))
53 {
54 FScriptTypedElementListConstPtr ElementListPtr = ElementList.GetElementList();
55 return ElementListPtr ? ElementListPtr->GetElementInterface(ElementHandle, BaseInterfaceType) : nullptr;
56 }
57
61 UFUNCTION(BlueprintCallable, Category="TypedElementFramework|List", meta=(ScriptMethod))
62 static bool HasElements(const FScriptTypedElementListProxy ElementList, const TSubclassOf<UInterface> BaseInterfaceType = {})
63 {
64 FScriptTypedElementListConstPtr ElementListPtr = ElementList.GetElementList();
65 return ElementListPtr && ElementListPtr->HasElements(BaseInterfaceType);
66 }
67
71 UFUNCTION(BlueprintCallable, Category="TypedElementFramework|List", meta=(ScriptMethod))
73 {
74 FScriptTypedElementListConstPtr ElementListPtr = ElementList.GetElementList();
75 return ElementListPtr ? ElementListPtr->CountElements(BaseInterfaceType) : 0;
76 }
77
81 UFUNCTION(BlueprintCallable, Category="TypedElementFramework|List", meta=(ScriptMethod))
82 static bool HasElementsOfType(const FScriptTypedElementListProxy ElementList, const FName ElementTypeName)
83 {
84 FScriptTypedElementListConstPtr ElementListPtr = ElementList.GetElementList();
85 return ElementListPtr && ElementListPtr->HasElementsOfType(ElementTypeName);
86 }
87
91 UFUNCTION(BlueprintCallable, Category="TypedElementFramework|List", meta=(ScriptMethod))
92 static int32 CountElementsOfType(const FScriptTypedElementListProxy ElementList, const FName ElementTypeName)
93 {
94 FScriptTypedElementListConstPtr ElementListPtr = ElementList.GetElementList();
95 return ElementListPtr ? ElementListPtr->CountElementsOfType(ElementTypeName) : 0;
96 }
97
101 UFUNCTION(BlueprintCallable, Category="TypedElementFramework|List", meta=(ScriptMethod))
107
111 UFUNCTION(BlueprintPure, Category="TypedElementFramework|List", meta=(ScriptMethod))
112 static bool IsValidIndex(const FScriptTypedElementListProxy ElementList, const int32 Index)
113 {
114 FScriptTypedElementListConstPtr ElementListPtr = ElementList.GetElementList();
115 return ElementListPtr && ElementListPtr->IsValidIndex(Index);
116 }
117
121 UFUNCTION(BlueprintPure, Category="TypedElementFramework|List", meta=(ScriptMethod))
123 {
124 FScriptTypedElementListConstPtr ElementListPtr = ElementList.GetElementList();
125 return ElementListPtr ? ElementListPtr->Num() : 0;
126 }
127
131 UFUNCTION(BlueprintCallable, Category="TypedElementFramework|List", meta=(ScriptMethod))
133 {
134 if (FScriptTypedElementListPtr ElementListPtr = ElementList.GetElementList())
135 {
136 ElementListPtr->Shrink();
137 }
138 }
139
143 UFUNCTION(BlueprintCallable, Category="TypedElementFramework|List", meta=(ScriptMethod))
144 static void Reserve(FScriptTypedElementListProxy ElementList, const int32 Size)
145 {
146 if (FScriptTypedElementListPtr ElementListPtr = ElementList.GetElementList())
147 {
148 ElementListPtr->Reserve(Size);
149 }
150 }
151
155 UFUNCTION(BlueprintCallable, Category="TypedElementFramework|List", meta=(ScriptMethod))
156 static void Empty(FScriptTypedElementListProxy ElementList, const int32 Slack = 0)
157 {
158 if (FScriptTypedElementListPtr ElementListPtr = ElementList.GetElementList())
159 {
160 ElementListPtr->Empty(Slack);
161 }
162 }
163
167 UFUNCTION(BlueprintCallable, Category="TypedElementFramework|List", meta=(ScriptMethod))
169 {
170 if (FScriptTypedElementListPtr ElementListPtr = ElementList.GetElementList())
171 {
173 }
174 }
175
179 UFUNCTION(BlueprintPure, Category="TypedElementFramework|List", meta=(ScriptMethod))
181 {
182 FScriptTypedElementListConstPtr ElementListPtr = ElementList.GetElementList();
183 return ElementListPtr && ElementListPtr->Contains(ElementHandle);
184 }
185
190 UFUNCTION(BlueprintCallable, Category="TypedElementFramework|List", meta=(ScriptMethod))
196
200 UFUNCTION(BlueprintCallable, Category="TypedElementFramework|List", meta=(ScriptMethod))
202 {
203 if (FScriptTypedElementListPtr ElementListPtr = ElementList.GetElementList())
204 {
205 ElementListPtr->Append(ElementHandles);
206 }
207 }
208
212 UFUNCTION(BlueprintCallable, Category="TypedElementFramework|List", meta=(ScriptMethod))
214 {
215 FScriptTypedElementListPtr ElementListPtr = ElementList.GetElementList();
218 {
219 ElementListPtr->Append(OtherElementListPtr.ToSharedRef());
220 }
221 }
222
227 UFUNCTION(BlueprintCallable, Category="TypedElementFramework|List", meta=(ScriptMethod))
233};
FPlatformTypes::int32 int32
A 32-bit signed integer.
Definition Platform.h:1125
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127
@ Num
Definition MetalRHIPrivate.h:234
#define GENERATED_BODY(...)
Definition ObjectMacros.h:765
#define UFUNCTION(...)
Definition ObjectMacros.h:745
#define UCLASS(...)
Definition ObjectMacros.h:776
uint32 Size
Definition VulkanMemory.cpp:4034
Definition NameTypes.h:617
Definition Array.h:670
Definition SharedPointer.h:692
UE_FORCEINLINE_HINT void Reset()
Definition SharedPointer.h:1120
Definition SubclassOf.h:30
bool Add(const HandleType &InElementHandle)
Definition TypedElementList.h:397
bool Remove(const FTypedElementId &InElementId)
Definition TypedElementList.h:481
Definition Interface.h:19
Definition Object.h:95
Definition TypedElementListLibrary.h:13
Definition TypedElementRegistry.h:55
U16 Index
Definition radfft.cpp:71
Definition TypedElementHandle.h:625
Definition TypedElementListProxy.h:18