Navigation
API > API/Plugins > API/Plugins/WebAPIEditor
Holds information for an existing or pending type.
| Name | UWebAPITypeInfo |
| Type | class |
| Header File | /Engine/Plugins/Experimental/Web/WebAPI/Source/WebAPIEditor/Public/Dom/WebAPIType.h |
| Include Path | #include "Dom/WebAPIType.h" |
Syntax
UCLASS (BlueprintType)
class UWebAPITypeInfo : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UWebAPITypeInfo
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UWebAPITypeInfo() |
Dom/WebAPIType.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsBuiltinType | bool | If this is false, the type is to be generated and should have a namespace. | Dom/WebAPIType.h |
|
| bIsNested | bool | Flag specifying whether this type is used exclusively by a parent type (isn't shared). | Dom/WebAPIType.h |
|
| ContainingType | FWebAPITypeNameVariant | When the type is nested, this specifies who "owns" it. | Dom/WebAPIType.h |
|
| DebugString | FString | Misc info for debug. | Dom/WebAPIType.h |
|
| DeclarationType | FName | Declaration type, ie. struct, enum. | Dom/WebAPIType.h |
|
| DefaultValue | FString | Default value as a string, if applicable. | Dom/WebAPIType.h |
|
| DisplayName | FString | Optional display name, different to the actual name, ie. "JsonObject" vs. "JsonObjectWrapper". | Dom/WebAPIType.h |
|
| IncludePaths | TSet< FString > | Relative include paths required when referencing this type. | Dom/WebAPIType.h |
|
| JsonName | FString | Field name as sent to and received from the external API. | Dom/WebAPIType.h |
|
| JsonPropertyToSerialize | FString | Optional sub-property to serialize, instead of the object itself. | Dom/WebAPIType.h |
|
| JsonType | FName | Json type. Should correspond with values in EJson. | Dom/WebAPIType.h |
|
| Modules | TSet< FString > | Module dependencies for this type. | Dom/WebAPIType.h |
|
| Name | FString | Type Name without prefix or namespace, ie. "Vector", not "FVector". | Dom/WebAPIType.h |
|
| Namespace | FString | Type Namespace, can be empty for built-in types. | Dom/WebAPIType.h |
|
| PinColor | FSlateColor | Color for UI. | Dom/WebAPIType.h |
|
| Prefix | FString | Type Prefix, usually "F", "U", "A", or "E". | Dom/WebAPIType.h |
|
| PrintFormatExpression | FString | Optional tokenized string expression to get the value for printf, ie. ToString({Property}) | Dom/WebAPIType.h |
|
| PrintFormatSpecifier | FString | Optional specifier for printf, ie. "s", "d". | Dom/WebAPIType.h |
|
| SchemaType | EWebAPISchemaType | SchemaType to discern between ie. a Service and a Model with the same name. | Dom/WebAPIType.h |
|
| Suffix | FString | Optional suffix, ie. "Parameter", "Item", etc. | Dom/WebAPIType.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Model | TSoftObjectPtr< UObject > | Associated model, if any. | Dom/WebAPIType.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TObjectPtr< UWebAPITypeInfo > Duplicate
(
const TObjectPtr< class UWebAPITypeRegistry >& InTypeRegistry |
Duplicate this TypeInfo to the provided TypeRegistry. | Dom/WebAPIType.h | |
FString GetDefaultValue
(
bool bQualified |
Default value as a string. | Dom/WebAPIType.h | |
FString GetDisplayName() |
The name for UI display. | Dom/WebAPIType.h | |
FString GetJsonName() |
The json field name that the target API expects, rather than the UE friendly one. | Dom/WebAPIType.h | |
UObject * GetModel() |
Get the (mutable) Model. Will return nullptr if not set. | Dom/WebAPIType.h | |
bool IsEnum() |
Dom/WebAPIType.h | ||
void SetModel
(
const ModelType* InModel |
Set's the Model. | Dom/WebAPIType.h | |
void SetName
(
const FString& InName |
Set's the name and updates the underlying object id. | Dom/WebAPIType.h | |
void SetNested
(
const FWebAPITypeNameVariant& InNester |
Set's this type as nested, using the provided Type as ContainingType. | Dom/WebAPIType.h | |
FString ToMemberName
(
const FString& InPrefix |
Get the fully formatted name as a valid member name. | Dom/WebAPIType.h | |
FString ToString
(
bool bInJustName |
Get the fully formatted name, with prefix and namespace. | Dom/WebAPIType.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual EDataValidationResult IsDataValid
(
FDataValidationContext& Context |
Dom/WebAPIType.h |