Navigation
API > API/Plugins > API/Plugins/WebAPIEditor > API/Plugins/WebAPIEditor/CodeGen > API/Plugins/WebAPIEditor/CodeGen/Dom
Inheritance Hierarchy
- FWebAPICodeGenBase
- FWebAPICodeGenFile
References
| Module | WebAPIEditor |
| Header | /Engine/Plugins/Experimental/Web/WebAPI/Source/WebAPIEditor/Public/CodeGen/Dom/WebAPICodeGenFile.h |
| Include | #include "CodeGen/Dom/WebAPICodeGenFile.h" |
Syntax
class FWebAPICodeGenFile : public FWebAPICodeGenBase
Remarks
Contains a list of declarations/definitions to generate for a single file.
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
FString | BaseFilePath | Absolute Base Path to output to, usually a Module/Source/x/(Public or Private). |
 |
FString | CopyrightNotice | Copyright notice to apply to the top of the file. Uses the Project setting unless specified. |
 |
FString | FileName | Name of the file, excluding extension. |
 |
FString | FileType | File extension. |
 |
TSet< FString > | IncludePaths | Set of (unique) include paths. |
 |
TSet< FString > | Modules | Module dependencies for this file. |
 |
FString | RelativeFilePath | Relative Path of the file, excluding the filename itself. |
 |
TArray< TWeakObjectPtr< UObject > > | SchemaObjects | Schema objects represented by this file. |
 |
TArray< TSharedPtr< FWebAPICodeGenBase > > | SubItems | The inner codegen items to create within the file. |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | AddItem
(
const TSharedPtr< FWebAPICodeGenBase >& InItem |
Adds the given item as a SubItem and appends include paths. |
 |
void | AddItems
(
const TArray< TSharedPtr< CodeGenType >>& InItems |
Adds the given item as a SubItem and appends include paths. |
 |
FString | GetFullPath () |
Returns the full, absolute path to the file. |
Overridden from FWebAPICodeGenBase
| Type | Name | Description | |
|---|---|---|---|
   |
void | GetIncludePaths
(
TArray< FString >& OutIncludePaths |
Append any include paths for this file to the given Array (not Set, to allow custom order). |
   |
void | GetIncludePaths
(
TSet< FString >& OutIncludePaths |
Append any include paths for this file to the given Set. |
  |
const FName & | GetTypeName () |
CodeGen Type. |
  |
void | Sets the containing module name. |
Typedefs
| Name | Description |
|---|---|
| Super | Inherited baseclass. |
Constants
| Name | Description |
|---|---|
| TypeName | CodeGen Type. |