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