IDlgWriter Class Reference

#include <IDlgWriter.h>

Inheritance diagram for IDlgWriter:

Public Member Functions
virtual	~IDlgWriter ()
virtual bool	CanSaveAsReference (const FNYProperty *Property, const UObject *Object)
virtual bool	ExportToFile (const FString &FileName)=0
virtual const FString &	GetAsString () const =0
bool	IsLogVerbose () const
void	SetLogVerbose (bool bValue)
virtual void	Write (const UStruct *StructDefinition, const void *Object)=0

Static Public Member Functions
static bool	CanSkipProperty (const FNYProperty *Property)
static bool	CanWriteIndex (const FNYProperty *Property)
static bool	CanWriteOneLinePerItem (const FNYProperty *Property)

Protected Attributes
bool	bLogVerbose = false

Static Protected Attributes
static constexpr int64	SkipFlags = CPF_Deprecated | CPF_Transient

Detailed Description

The writer will ignore properties by default that are marked DEPRECATED or TRANSIENT, see SkipFlags variable.

Limitations:

• TSet or TMap with the KeyType as float or structures that have floats, this is very bad you should not do this anyways
• limitation for each type you can see inside DlgIoTester.cpp in the Options.
• Having an uninitialized UObject property inside a USTRUCT (https://answers.unrealengine.com/questions/566684/editor-crashes-on-startup-if-uninitialized-uproper.html) THIS CRASHES THE WRITERS so initialize them with nullptr

MetaData specifiers: Unfortunately they only work in editor build The class can be used in exported game too, but the MetaData specifiers are ignored

• DlgNoExport: property is skipped - WARNING: should be only used on editor only variables, in non-editor builds you should use the properties from the SkipFlags
• DlgWriteIndex: used on complex (struct/object) arrays, element index is exported as comment
  • DlgLinePerItem: used to force primitive container to write each element into a new line (TODO: MAP SUPPORT)
• DlgSaveOnlyReference: UObject path is serialized instead of UObject (can be used for DataAsset like objects stored in content browser) ATM IT ONLY WORKS IF IT IS NOT INSIDE A CONTAINER DIRECTLY (can be e.g. inside a struct inside a container tho)

Definition at line 30 of file IDlgWriter.h.

Constructor & Destructor Documentation

~IDlgWriter()

virtual IDlgWriter::~IDlgWriter ( )

inlinevirtual

Definition at line 33 of file IDlgWriter.h.

Member Function Documentation

CanSaveAsReference()

virtual bool IDlgWriter::CanSaveAsReference ( const FNYProperty * Property, const UObject * Object )

inlinevirtual

Decides if the path to the object should be serialized, or the object itself

Definition at line 83 of file IDlgWriter.h.

Here is the caller graph for this function:

CanSkipProperty()

static bool IDlgWriter::CanSkipProperty ( const FNYProperty * Property )

inlinestatic

Can we skip this property from exporting?

Definition at line 41 of file IDlgWriter.h.

Here is the caller graph for this function:

CanWriteIndex()

static bool IDlgWriter::CanWriteIndex ( const FNYProperty * Property )

inlinestatic

Should write the index number for Property?

Definition at line 73 of file IDlgWriter.h.

Here is the caller graph for this function:

CanWriteOneLinePerItem()

static bool IDlgWriter::CanWriteOneLinePerItem ( const FNYProperty * Property )

inlinestatic

Should write one item per line for Property?

Definition at line 63 of file IDlgWriter.h.

Here is the caller graph for this function:

ExportToFile()

virtual bool IDlgWriter::ExportToFile ( const FString & FileName )

pure virtual

Implemented in FDlgConfigWriter, and FDlgJsonWriter.

GetAsString()

virtual const FString & IDlgWriter::GetAsString ( ) const

pure virtual

Implemented in FDlgConfigWriter, and FDlgJsonWriter.

Here is the caller graph for this function:

IsLogVerbose()

bool IDlgWriter::IsLogVerbose ( ) const

inline

Definition at line 108 of file IDlgWriter.h.

SetLogVerbose()

void IDlgWriter::SetLogVerbose ( bool bValue )

inline

Definition at line 109 of file IDlgWriter.h.

Write()

virtual void IDlgWriter::Write ( const UStruct * StructDefinition, const void * Object )

pure virtual

Has to be called before ExportToFile in order to have something to write

Implemented in FDlgJsonWriter, and FDlgConfigWriter.

Member Data Documentation

bLogVerbose

bool IDlgWriter::bLogVerbose = false

protected

Definition at line 116 of file IDlgWriter.h.

SkipFlags

constexpr int64 IDlgWriter::SkipFlags = CPF_Deprecated | CPF_Transient

staticconstexprprotected

The properties with these flags set will be ignored from writing.

Definition at line 113 of file IDlgWriter.h.

---

The documentation for this class was generated from the following file:

• SDKDemo/Plugins/UnrealEngineSDK/VisualScripter/Source/DlgSystem/Public/IO/IDlgWriter.h