Navigation
API > API/Runtime > API/Runtime/UMG > API/Runtime/UMG/Binding > API/Runtime/UMG/Binding/States
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UDeveloperSettings
- UWidgetStateSettings
References
| Module | UMG |
| Header | /Engine/Source/Runtime/UMG/Public/Binding/States/WidgetStateSettings.h |
| Include | #include "Binding/States/WidgetStateSettings.h" |
Syntax
class UWidgetStateSettings : public UDeveloperSettings
Remarks
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.
Functions
| Type | Name | Description | |
|---|---|---|---|
| UWidgetStateSettings * | Get () |
||
| void | GetAllStateNames
(
TArray< FName >& OutStateNames |
Obtain a list of all known States. | |
| uint8 | GetBinaryStateIndex
(
const FName InBinaryStateName |
Get Index corresponding to this binary state, which may dynamically change - but not within a game session. | |
| FName | GetBinaryStateName
(
const uint8 InBinaryStateIndex |
Get Name corresponding to this binary state index, which may dynamically change - but not within a game session. | |
| void | GetBinaryStateNames
(
TArray< FName >& OutBinaryStateNames |
Obtain a list of all known Binary States. | |
| uint8 | GetEnumStateIndex
(
const FName InEnumStateName |
Get Index corresponding to this enum state, which may dynamically change - but not within a game session. | |
| FName | GetEnumStateName
(
const uint8 InEnumStateIndex |
Get Name corresponding to this enum state index, which may dynamically change - but not within a game session. | |
| void | GetEnumStateNames
(
TArray< FName >& OutEnumStateNames |
Obtain a list of all known Enum States. | |
| FWidgetStateBitfield | GetInitialRegistrationBitfield
(
const UWidget* InWidget |
Gets bitfield of widget based on current state and given on registration state initializers |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
| void | Called after the C++ constructor and after the properties have been initialized, including those loaded from config. |