Navigation
API > API/Plugins > API/Plugins/Chooser
Data table used to choose an asset based on input parameters
| Name | UChooserTable |
| Type | class |
| Header File | /Engine/Plugins/Chooser/Source/Chooser/Public/Chooser.h |
| Include Path | #include "Chooser.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType)
class UChooserTable : public UChooserSignature
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UChooserSignature → UChooserTable
Implements Interfaces
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Chooser.h | |||
UChooserTable
(
const FObjectInitializer& ObjectInitializer |
Chooser.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| CurrentVersion | int | Chooser.h | |
| PropertyNamesTag | const FName | Chooser.h | |
| PropertyTagDelimiter | const FString | Chooser.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ColumnsStructs | TArray< FInstancedStruct > | Columns which filter Results. | Chooser.h |
|
| CookedResults | TArray< FInstancedStruct > | Chooser.h | ||
| DisabledRows | TArray< bool > | Chooser.h | ||
| EditorResultsColumnWidth | float | Chooser.h | ||
| FallbackResult | FInstancedStruct | FallbackResult will be used as the Result if there are no rows in the chooser which pass all filters. If FallbackResult is not assigned, then the Chooser will return null in that case. | Chooser.h | |
| NestedChoosers | TArray< TObjectPtr< UChooserTable > > | Chooser.h | ||
| NestedChoosersChanged | FSimpleMulticastDelegate | Chooser.h | ||
| NestedObjects | TArray< TObjectPtr< UObject > > | Chooser.h | ||
| NestedObjectsChanged | FSimpleMulticastDelegate | Chooser.h | ||
| OnOutputObjectTypeChanged | FChooserOutputObjectTypeChanged | Chooser.h | ||
| ParentTable | TObjectPtr< UChooserTable > | Deprecated in favor of RootChooser | Chooser.h | |
| ResultsStructs | TArray< FInstancedStruct > | Each possible Result (Rows of chooser table) | Chooser.h | |
| RootChooser | TObjectPtr< UChooserTable > | Chooser.h | ||
| Version | uint32 | Chooser.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bDebugTestValuesValid | bool | Chooser.h | ||
| bEnableDebugTesting | bool | Enable display of which cells pass/fail based on current TestValue for each column | Chooser.h | |
| bIsCookedPackage | bool | Chooser.h | ||
| CachedPreviousOutputObjectType | UClass * | Caching the OutputObjectType and ContextObjectType so that on Undo, we can tell if we should fire the changed delegate | Chooser.h | |
| CachedPreviousResultType | EObjectChooserResultType | Chooser.h | ||
| CompileDependencies | TArray< TWeakObjectPtr< UStruct > > | Chooser.h | ||
| DebugLock | FCriticalSection | Chooser.h | ||
| DebugSelectedRows | TArray< int32 > | Rows which were selected last time this chooser was evaluated on DebugTarget. | Chooser.h | |
| DebugTarget | TWeakObjectPtr< const UObject > | Reference to the UObject in PIE which we want to get debug info for | Chooser.h | |
| DebugTargetName | FString | Chooser.h | ||
| RecentContextObjects | TArray< FString > | Objects this chooser has been recently evaluated on | Chooser.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddNestedChooser
(
UChooserTable* Chooser |
Chooser.h | ||
void AddNestedObject
(
UObject* Object |
Chooser.h | ||
void AddRecentContextObject
(
const FString& ObjectName |
Chooser.h | ||
void DeleteNestedChooser
(
UChooserTable* NestedChooser |
Chooser.h | ||
void DeleteNestedObject
(
UObject* ObjectToDelete |
Chooser.h | ||
| Chooser.h | |||
const UChooserTable * GetContextOwner () |
Chooser.h | ||
const TArray< int32 > & GetDebugSelectedRows() |
Chooser.h | ||
const FString & GetDebugTargetName() |
Chooser.h | ||
bool GetDebugTestValuesValid() |
Chooser.h | ||
bool GetEnableDebugTesting() |
Chooser.h | ||
| Chooser.h | |||
const UChooserTable * GetRootChooser () |
Chooser.h | ||
bool HasDebugTarget() |
Chooser.h | ||
bool IsCookedData() |
Chooser.h | ||
bool IsRowDisabled
(
int32 RowIndex |
Chooser.h | ||
void IterateRecentContextObjects
(
TFunction< void(const FString&)> Callback |
Chooser.h | ||
void OnDependencyCompiled
(
UBlueprint* Blueprint |
Chooser.h | ||
void OnDependentStructChanged
(
UUserDefinedStruct* Blueprint |
Chooser.h | ||
void PopulateCookedData
(
bool bCooking |
Chooser.h | ||
void RemoveDisabledData() |
Chooser.h | ||
void RemoveNestedChooser
(
UChooserTable* Chooser |
Chooser.h | ||
void RemoveNestedObject
(
UObject* Object |
Chooser.h | ||
void ResetDebugTarget() |
Chooser.h | ||
bool ResultAssetFilter
(
const FAssetData& AssetData |
Chooser.h | ||
void SetDebugSelectedRow
(
int32 Index |
Chooser.h | ||
void SetDebugSelectedRows
(
const TArray< int32 >& Indices |
Chooser.h | ||
void SetDebugTarget
(
FString Name |
Chooser.h | ||
void SetDebugTestValuesValid
(
bool bValue |
Chooser.h | ||
void SetEnableDebugTesting
(
bool bValue |
Chooser.h | ||
void UpdateDebugging
(
FChooserEvaluationContext& Context |
Chooser.h |
Public Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginDestroy() |
Chooser.h | ||
virtual void GetAssetRegistryTags
(
FAssetRegistryTagsContext Context |
Chooser.h | ||
virtual void GetAssetRegistryTags
(
TArray< FAssetRegistryTag >& OutTags |
Chooser.h | ||
virtual CHOOSER_API EDataValidationResult IsDataValid
(
FDataValidationContext& Context |
Chooser.h | ||
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Chooser.h | ||
virtual void PostEditUndo() |
Chooser.h | ||
virtual void PostLoad() |
Chooser.h | ||
virtual void Serialize
(
FArchive& Ar |
Chooser.h |
Overridden from IHasContextClass
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddCompileDependency
(
const UStruct* Struct |
Chooser.h | ||
virtual void Compile
(
bool bForce |
Chooser.h | ||
virtual TConstArrayView< FInstancedStruct > GetContextData() |
IHasContextClass implementation. | Chooser.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FObjectChooserBase::EIteratorStatus EvaluateChooser
(
FChooserEvaluationContext& Context, |
Chooser.h | ||
static FObjectChooserBase::EIteratorStatus EvaluateChooser
(
FChooserEvaluationContext& Context, |
Chooser.h | ||
static FObjectChooserBase::EIteratorStatus IterateChooser
(
FChooserEvaluationContext& Context, |
Chooser.h | ||
static FObjectChooserBase::EIteratorStatus IterateChooser
(
const UChooserTable* Chooser, |
Chooser.h |
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Columns_DEPRECATED | TArray< TScriptInterface< IChooserColumn > > | Deprecated UObject Columns | Chooser.h | |
| ContextObjectType_DEPRECATED | TObjectPtr< UClass > | Deprecated single context object | Chooser.h | |
| Results_DEPRECATED | TArray< TScriptInterface< IObjectChooser > > | Deprecated UObject Results | Chooser.h |