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