ArticyXImporter
ArticyXImporter for Unreal Engine
Loading...
Searching...
No Matches
FArticyPropertyDef Struct Reference

#include <ObjectDefinitionsImport.h>

Public Member Functions

void ImportFromJson (const TSharedPtr< FJsonObject > JsonProperty, const UArticyImportData *Data, const TArray< FArticyTemplateConstraint > *OptionalConstraints=nullptr)
void GenerateCode (CodeFileGenerator &header, const UArticyImportData *Data) const
void GatherScript (const TSharedPtr< FJsonObject > &JsonValue, UArticyImportData *Data) const
void InitializeModel (UArticyBaseObject *Model, const FString &Path, const TSharedPtr< FJsonObject > &JsonValue, const UArticyImportData *Data, const FString &PackageName) const
const FName & GetPropetyName () const
const FName & GetOriginalType () const
const FName & GetOriginalItemType () const
FString GetCppType (const UArticyImportData *Data) const

Friends

class UArticyImportData

Detailed Description

Represents a property definition in Articy.

Member Function Documentation

◆ GatherScript()

void FArticyPropertyDef::GatherScript ( const TSharedPtr< FJsonObject > & JsonObject,
UArticyImportData * Data ) const

Gathers script fragments from JSON and adds them to the UArticyImportData.

Parameters
JsonValueA shared pointer to the JSON object containing the script.
DataA pointer to the UArticyImportData object.

Gathers script fragments from JSON and adds them to the UArticyImportData.

Parameters
JsonObjectA shared pointer to the JSON object containing the script.
DataA pointer to the UArticyImportData object.

◆ GenerateCode()

void FArticyPropertyDef::GenerateCode ( CodeFileGenerator & header,
const UArticyImportData * Data ) const

Generates code for the property definition using CodeFileGenerator.

Parameters
headerA reference to the CodeFileGenerator.
DataA pointer to the UArticyImportData object.

◆ GetCppType()

FString FArticyPropertyDef::GetCppType ( const UArticyImportData * Data) const

Returns the C++ type of the property definition.

Parameters
DataA pointer to the UArticyImportData object.
Returns
The C++ type as a string.

◆ GetOriginalItemType()

const FName & FArticyPropertyDef::GetOriginalItemType ( ) const
inline

Returns the original item type of the property.

Returns
The original item type as an FName.

◆ GetOriginalType()

const FName & FArticyPropertyDef::GetOriginalType ( ) const
inline

Returns the original type of the property.

Returns
The original type as an FName.

◆ GetPropetyName()

const FName & FArticyPropertyDef::GetPropetyName ( ) const
inline

Returns the name of the property.

Returns
The property name as an FName.

◆ ImportFromJson()

void FArticyPropertyDef::ImportFromJson ( const TSharedPtr< FJsonObject > JsonProperty,
const UArticyImportData * Data,
const TArray< FArticyTemplateConstraint > * OptionalConstraints = nullptr )

Import property definition data from a JSON object.

Parameters
JsonPropertyA shared pointer to the JSON object containing the property definition.
DataA pointer to the UArticyImportData object.
OptionalConstraintsAn optional array of template constraints.

◆ InitializeModel()

void FArticyPropertyDef::InitializeModel ( UArticyBaseObject * Model,
const FString & Path,
const TSharedPtr< FJsonObject > & JsonObject,
const UArticyImportData * Data,
const FString & PackageName ) const

Initializes a model with data from JSON.

Parameters
ModelA pointer to the UArticyBaseObject.
PathThe path of the model.
JsonValueA shared pointer to the JSON object containing the data.
DataA pointer to the UArticyImportData object.
PackageNameThe name of the package.

Initializes a model with data from JSON.

Parameters
ModelA pointer to the UArticyBaseObject.
PathThe path of the model.
JsonObjectA shared pointer to the JSON object containing the data.
DataA pointer to the UArticyImportData object.
PackageNameThe name of the package.

The documentation for this struct was generated from the following files: