FEnumEditorUtils

Choose your operating system:

Windows

macOS

Linux

References

Module

UnrealEd

Header

/Engine/Source/Editor/UnrealEd/Public/Kismet2/EnumEditorUtils.h

Include

#include "Kismet2/EnumEditorUtils.h"

Syntax

class FEnumEditorUtils

Functions

Name Description

Public function Static

void

 

AddNewEnumeratorForUserDefinedEnum

(
    UUserDefinedEnum* Enum
)

Adds new enumerator (with default unique name) for user defined enum

Public function Static

UEnum *

 

CreateUserDefinedEnum

(
    UObject* InParent,
    FName EnumName,
    EObjectFlags Flags
)

Creates new user defined enum in given blueprint.

Public function Static

void

 

EnsureAllDisplayNamesExist

(
    UUserDefinedEnum* Enum
)

Public function Static

bool

 

IsEnumeratorBitflagsType

(
    UUserDefinedEnum* Enum
)

Check if the enumerator-as-bitflags meta data is set

Public function Static

bool

 

IsEnumeratorDisplayNameValid

(
    const UUserDefinedEnum* Enum,
    int32 EnumeratorIndex,
    FText NewDisplayName
)

Public function Static

bool

 

IsNameAvailebleForUserDefinedEnum

(
    FName Name
)

Return if an enum can be named/renamed with given name

Public function Static

bool

 

IsProperNameForUserDefinedEnumerator

(
    const UEnum* Enum,
    FString NewName
)

Check if NewName is a short name and is acceptable as name in given enum

Public function Static

void

 

MoveEnumeratorInUserDefinedEnum

(
    UUserDefinedEnum* Enum,
    int32 InitialEnumeratorIndex,
    int32 TargetIndex
)

Reorder enumerators in enum.

Public function Static

void

 

PostEditUndo

(
    UUserDefinedEnum* Enum
)

Handles necessary notifications when the Enum has had a transaction undone or redone on it.

Public function Static

void

 

RemoveEnumeratorFromUserDefinedEnum

(
    UUserDefinedEnum* Enum,
    int32 EnumeratorIndex
)

Removes enumerator from enum

Public function Static

int64

 

ResolveEnumerator

(
    const UEnum* Enum,
    FArchive& Ar,
    int64 EnumeratorValue
)

Try to update an out-of-date enum index after an enum's change

Public function Static

void

 

SetEnumeratorBitflagsTypeState

(
    UUserDefinedEnum* Enum,
    bool bBitflagsType
)

Set the state of the enumerator-as-bitflags meta data

Public function Static

bool

 

SetEnumeratorDisplayName

(
    UUserDefinedEnum* Enum,
    int32 EnumeratorIndex,
    FText NewDisplayName
)

DISPLAY NAME.

Public function Static

void

 

UpdateAfterPathChanged

(
    UEnum* Enum
)

Updates enumerators names after name or path of the Enum was changed

Public function Static

void

 

UpgradeDisplayNamesFromMetaData

(
    UUserDefinedEnum* Enum
)

Classes

Name

Description

Public class

FEnumEditorManager

Enums

Name

Description

Public enum

EEnumEditorChangeInfo

Typedefs

Name

Description

INotifyOnEnumChanged