FArticyPackageDef Struct Reference

#include <PackagesImport.h>

Public Member Functions
void	ImportFromJson (const UArticyArchiveReader &Archive, const TSharedPtr< FJsonObject > &JsonPackage)
void	GatherScripts (UArticyImportData *Data) const
void	GatherText (const TSharedPtr< FJsonObject > &Json)
UArticyPackage *	GeneratePackageAsset (UArticyImportData *Data) const
TMap< FString, FArticyTexts >	GetTexts () const
FString	GetFolder () const
FString	GetFolderName () const
const FString	GetName () const
const FString	GetPreviousName () const
void	SetName (const FString &NewName)
FArticyId	GetId () const
bool	GetIsIncluded () const
FString	GetScriptFragmentHash () const
bool	operator== (const FArticyPackageDef &Other) const

Detailed Description

Represents a package definition in Articy with properties for ID, name, description, and models.

Member Function Documentation

GatherScripts()

void FArticyPackageDef::GatherScripts

(

UArticyImportData *

Data

)

const

Gathers scripts from the package definition and adds them to the ArticyImportData.

Parameters

Data	A pointer to the UArticyImportData object.

GatherText()

void FArticyPackageDef::GatherText

(

const TSharedPtr< FJsonObject > &

Json

)

Gathers text data from a JSON object and adds it to the package definition.

Parameters

Json	A shared pointer to the JSON object containing the text data.

GeneratePackageAsset()

UArticyPackage * FArticyPackageDef::GeneratePackageAsset

(

UArticyImportData *

Data

)

const

Generates a package asset from the package definition.

Parameters

Data	A pointer to the UArticyImportData object.

Returns

A pointer to the generated UArticyPackage asset.

GetFolder()

FString FArticyPackageDef::GetFolder

(

)

const

Gets the folder path for the package.

Returns

The folder path as a string.

GetFolderName()

FString FArticyPackageDef::GetFolderName

(

)

const

Gets the folder name for the package.

Returns

The folder name as a string.

GetId()

FArticyId FArticyPackageDef::GetId

(

)

const

Gets the ID of the package.

Returns

The package ID as an FArticyId.

GetIsIncluded()

bool FArticyPackageDef::GetIsIncluded

(

)

const

Checks if the package is included.

Returns

True if the package is included, false otherwise.

GetName()

const FString FArticyPackageDef::GetName

(

)

const

Gets the name of the package.

Returns

The package name as a string.

GetPreviousName()

const FString FArticyPackageDef::GetPreviousName

(

)

const

Gets the previous name of the package.

Returns

The previous package name as a string.

GetScriptFragmentHash()

FString FArticyPackageDef::GetScriptFragmentHash

(

)

const

Gets the script fragment hash for the package definition.

Returns

The script fragment hash as a string.

GetTexts()

TMap< FString, FArticyTexts > FArticyPackageDef::GetTexts

(

)

const

Gets the texts map from the package definition.

Returns

A map of text data.

ImportFromJson()

void FArticyPackageDef::ImportFromJson	(	const UArticyArchiveReader &	Archive,
		const TSharedPtr< FJsonObject > &	JsonPackage )

Imports package definition data from a JSON object.

Parameters

Archive	A reference to the ArticyArchiveReader object.
JsonPackage	A shared pointer to the JSON object containing the package definition.

operator==()

bool FArticyPackageDef::operator== ( const FArticyPackageDef & Other ) const

inline

Equality operator for package definitions based on ID.

Parameters

Other

The other package definition to compare with.

Returns

True if the package IDs are equal, false otherwise.

SetName()

void FArticyPackageDef::SetName

(

const FString &

NewName

)

Sets the name of the package.

Parameters

NewName

The new name for the package.

---

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

• Source/ArticyEditor/Public/PackagesImport.h
• Source/ArticyEditor/Private/PackagesImport.cpp