Navigation
API > API/Runtime > API/Runtime/UMG
Settings used to map widget states to indexes. Does not perform any input validation, will crash if given invalid searches
Note: Currently doesn't really have any meaningful settings, used more as global singleton. May change.
| Name | UWidgetStateSettings |
| Type | class |
| Header File | /Engine/Source/Runtime/UMG/Public/Binding/States/WidgetStateSettings.h |
| Include Path | #include "Binding/States/WidgetStateSettings.h" |
Syntax
UCLASS (Config=Game, defaultconfig, MinimalAPI)
class UWidgetStateSettings : public UDeveloperSettings
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UDeveloperSettings → UWidgetStateSettings
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BinaryStateMap | TMap< FName, uint8, TInlineSetAllocator< 32 > > | Map of Binary State Names to index (In order of addition) | Binding/States/WidgetStateSettings.h | |
| BinaryStateRegistrationCDOs | TArray< TObjectPtr< UWidgetBinaryStateRegistration >, TInlineAllocator< 32 > > | Ordered list of Binary Widget States | Binding/States/WidgetStateSettings.h | |
| BinaryStates | TArray< FName, TInlineAllocator< 32 > > | Ordered list of Binary Widget States | Binding/States/WidgetStateSettings.h | |
| EnumStateMap | TMap< FName, uint8, TInlineSetAllocator< 8 > > | Map of Enum State Names to index (In order of addition) | Binding/States/WidgetStateSettings.h | |
| EnumStateRegistrationCDOs | TArray< TObjectPtr< UWidgetEnumStateRegistration >, TInlineAllocator< 8 > > | Ordered list of Enum Widget States | Binding/States/WidgetStateSettings.h | |
| EnumStates | TArray< FName, TInlineAllocator< 8 > > | Ordered list of Enum Widget States | Binding/States/WidgetStateSettings.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Obtain a list of all known States. | Binding/States/WidgetStateSettings.h | ||
uint8 GetBinaryStateIndex
(
const FName InBinaryStateName |
Get Index corresponding to this binary state, which may dynamically change - but not within a game session. | Binding/States/WidgetStateSettings.h | |
FName GetBinaryStateName
(
const uint8 InBinaryStateIndex |
Get Name corresponding to this binary state index, which may dynamically change - but not within a game session. | Binding/States/WidgetStateSettings.h | |
| Obtain a list of all known Binary States. | Binding/States/WidgetStateSettings.h | ||
uint8 GetEnumStateIndex
(
const FName InEnumStateName |
Get Index corresponding to this enum state, which may dynamically change - but not within a game session. | Binding/States/WidgetStateSettings.h | |
FName GetEnumStateName
(
const uint8 InEnumStateIndex |
Get Name corresponding to this enum state index, which may dynamically change - but not within a game session. | Binding/States/WidgetStateSettings.h | |
| Obtain a list of all known Enum States. | Binding/States/WidgetStateSettings.h | ||
FWidgetStateBitfield GetInitialRegistrationBitfield
(
const UWidget* InWidget |
Gets bitfield of widget based on current state and given on registration state initializers | Binding/States/WidgetStateSettings.h | |
virtual void PostInitProperties() |
Binding/States/WidgetStateSettings.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static const UWidgetStateSettings * Get() |
Binding/States/WidgetStateSettings.h |