Navigation
API > API/Plugins > API/Plugins/WebAPIEditor
Describes a (usually) API-specific class representing an enum.
| Name | UWebAPIEnum |
| Type | class |
| Header File | /Engine/Plugins/Experimental/Web/WebAPI/Source/WebAPIEditor/Public/Dom/WebAPIEnum.h |
| Include Path | #include "Dom/WebAPIEnum.h" |
Syntax
UCLASS ()
class UWebAPIEnum : public UWebAPIModelBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UWebAPIModelBase → UWebAPIEnum
Implements Interfaces
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bGenerate | bool | Will be set based on dependent operations. | Dom/WebAPIEnum.h |
|
| DefaultValue | FString | Current or Default Value of the Enum. | Dom/WebAPIEnum.h |
|
| GeneratedCodeText | FString | The last generated code as text for debugging. | Dom/WebAPIEnum.h |
|
| Name | FWebAPITypeNameVariant | Name of the Enum. | Dom/WebAPIEnum.h |
|
| Type | FString | The enum base type, always uint8. | Dom/WebAPIEnum.h |
|
| Values | TArray< TObjectPtr< UWebAPIEnumValue > > | Values within the Enum. | Dom/WebAPIEnum.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TObjectPtr< UWebAPIEnumValue > AddValue() |
Add and return a reference to a new Enum Value. | Dom/WebAPIEnum.h | |
FString GetDefaultValue
(
bool bQualified |
Default value as a string, usually the first enum value. | Dom/WebAPIEnum.h |
Overridden from UWebAPIModelBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BindToTypeInfo() |
Associates this model with it's own TypeInfo. | Dom/WebAPIEnum.h |
Overridden from IWebAPISchemaObjectInterface
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AppendCodeText
(
const FString& InCodeText |
Appends the last generated code as text for debugging. | Dom/WebAPIEnum.h | |
virtual FString GetSortKey() |
Used for sorting in the UI. | Dom/WebAPIEnum.h | |
virtual void SetCodeText
(
const FString& InCodeText |
Sets the last generated code as text for debugging. | Dom/WebAPIEnum.h | |
virtual void SetNamespace
(
const FString& InNamespace |
Recursively sets the namespace of this and all child objects. | Dom/WebAPIEnum.h | |
virtual bool ToJson
(
TSharedPtr< FJsonObject >& OutJson |
Dom/WebAPIEnum.h | ||
virtual void Visit
(
TFunctionRef< void(IWebAPISchemaObjectInterface*&)> InVisitor |
Recursively visit each element in the schema. | Dom/WebAPIEnum.h |