Navigation
API > API/Plugins > API/Plugins/WebAPIEditor
The asset containing various options and the schema itself.
| Name | UWebAPIDefinition |
| Type | class |
| Header File | /Engine/Plugins/Experimental/Web/WebAPI/Source/WebAPIEditor/Public/WebAPIDefinition.h |
| Include Path | #include "WebAPIDefinition.h" |
Syntax
UCLASS (AutoCollapseCategories="ImportSettings")
class UWebAPIDefinition : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UWebAPIDefinition
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UWebAPIDefinition() |
WebAPIDefinition.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~UWebAPIDefinition() |
WebAPIDefinition.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AssetImportData | TObjectPtr< class UAssetImportData > | Importing data and options used for this definition. | WebAPIDefinition.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| GeneratorSettings | FWebAPICodeGeneratorSettings | Settings for code generation. | WebAPIDefinition.h |
|
| ImportedDataCache | TMap< FName, TObjectPtr< UObject > > | Optional data store, ie. schema file contents. | WebAPIDefinition.h | |
| MessageLog | TSharedPtr< FWebAPIMessageLog > | MessageLog for this Definition. | WebAPIDefinition.h | |
| ProviderSettings | FWebAPIProviderSettings | Settings for the WebAPI provider. | WebAPIDefinition.h |
|
| WebAPISchema | TObjectPtr< UWebAPISchema > | The schema written by the provider. | WebAPIDefinition.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
DataCacheType * AddOrGetImportedDataCache
(
FName InKey |
WebAPIDefinition.h | ||
UObject * AddOrGetImportedDataCache
(
FName InKey, |
Retrieves the custom data for the given key, or creates it if it doesn't exist. | WebAPIDefinition.h | |
FString GetCopyrightNotice() |
Get the user-specified Copyright Notice, or from the Project Settings if unspecified. | WebAPIDefinition.h | |
const FWebAPICodeGeneratorSettings & GetGeneratorSettings () |
Settings for the code generation. | WebAPIDefinition.h | |
| Settings for the code generation. | WebAPIDefinition.h | ||
const TSharedPtr< FWebAPIMessageLog > & GetMessageLog() |
WebAPIDefinition.h | ||
const FWebAPIProviderSettings & GetProviderSettings () |
Settings for the WebAPI provider. | WebAPIDefinition.h | |
| Settings for the WebAPI provider. | WebAPIDefinition.h | ||
| WebAPIDefinition.h | |||
const UWebAPISchema * GetWebAPISchema () |
WebAPIDefinition.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual EDataValidationResult IsDataValid
(
FDataValidationContext& Context |
WebAPIDefinition.h |