Navigation
API > API/Plugins > API/Plugins/WebAPIEditor
Encapsulates settings for WebAPI code generation.
| Name | FWebAPICodeGeneratorSettings |
| Type | struct |
| Header File | /Engine/Plugins/Experimental/Web/WebAPI/Source/WebAPIEditor/Public/CodeGen/WebAPICodeGeneratorSettings.h |
| Include Path | #include "CodeGen/WebAPICodeGeneratorSettings.h" |
Syntax
USTRUCT ()
struct FWebAPICodeGeneratorSettings
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FWebAPICodeGeneratorSettings() |
CodeGen/WebAPICodeGeneratorSettings.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bOverrideGeneratorClass | bool | Whether to override the Code Generator class specified in project settings. | CodeGen/WebAPICodeGeneratorSettings.h |
|
| bWriteResult | bool | Disable to prevent the generator writing files/assets. | CodeGen/WebAPICodeGeneratorSettings.h |
|
| CodeGeneratorClass | TSoftClassPtr< UObject > | The Code Generator to use. | CodeGen/WebAPICodeGeneratorSettings.h |
|
| CopyrightNotice | FString | The copyright notice to apply to generated files. | CodeGen/WebAPICodeGeneratorSettings.h |
|
| GeneratedSettingsBaseClass | TSoftClassPtr< UWebAPIDeveloperSettings > | The generated settings baseclass (optional). | CodeGen/WebAPICodeGeneratorSettings.h |
|
| ModelOutputPath | FString | The relative output path for generated models. | CodeGen/WebAPICodeGeneratorSettings.h |
|
| OperationOutputPath | FString | The relative output path for generated operations. | CodeGen/WebAPICodeGeneratorSettings.h |
|
| TargetModule | FWebAPIDefinitionTargetModule | The C++ Unreal module determines the location of the generated files. | CodeGen/WebAPICodeGeneratorSettings.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Namespace | FString | A pseudo-namespace to prefix generated types with to avoid naming conflicts. Usually the API name. | CodeGen/WebAPICodeGeneratorSettings.h |
|
| OnNamespaceChangedDelegate | FOnNamespaceChangedDelegate | When the pseudo-namespace changes. | CodeGen/WebAPICodeGeneratorSettings.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TScriptInterface< class IWebAPICodeGeneratorInterface > GetGeneratorClass() |
Resolves and returns an instance of the CodeGeneratorClass. | CodeGen/WebAPICodeGeneratorSettings.h | |
const FString & GetNamespace() |
Returns the specified pseudo-namespace. | CodeGen/WebAPICodeGeneratorSettings.h | |
FOnNamespaceChangedDelegate & OnNamespaceChanged() |
When the pseudo-namespace changes. | CodeGen/WebAPICodeGeneratorSettings.h | |
void SetNamespace
(
const FString& InNamespace |
Sets the specified pseudo-namespace. | CodeGen/WebAPICodeGeneratorSettings.h |