CARLA
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
FCarlaContentPackManifest Struct Reference

Parsed carla-pack.json. More...

#include <ContentPackManifest.h>

Public Member Functions

TArray< FString > GetMapNames () const
 

Static Public Member Functions

static bool IsValidPackName (const FString &InName)
 Name must be usable as a plugin name and mount point ("/<Name>/").
 
static bool LoadFromFile (const FString &InManifestPath, FCarlaContentPackManifest &OutManifest, FString &OutError)
 Read and parse <ManifestPath>. Fills ManifestPath/PackDir.
 
static bool Parse (const FString &JsonText, FCarlaContentPackManifest &OutManifest, FString &OutError)
 Parse a manifest from a JSON string. OutError explains a false return.
 

Public Attributes

FString BaseRelease
 
FString CarlaVersion
 
TArray< FString > Catalogs
 
FString EngineCommit
 
FString EngineVersion
 
TMap< FString, FString > Files
 
FString ManifestPath
 Absolute path of the manifest file this was parsed from.
 
TArray< FCarlaContentPackMap > Maps
 
FString Name
 
FString PackDir
 Absolute path of the pack directory (parent of the manifest).
 
FString Platform
 
FString Version
 

Detailed Description

Parsed carla-pack.json.

Authoritative for map discovery: nothing walks the pack directories looking for .umap files.

{ "name": "NewPack", "version": "1.0.0", "carla_version": "0.10.2", "base_release": "carla-0.10.2-Linux", "engine": { "version": "5.8.0", "commit": "abcdef0" }, "platform": "Linux", "maps": [ { "name", "package", "xodr", "world_partition" } ], "catalogs": [ "Config/Vehicles.json", ... ], "files": { "<relpath>": "sha256:..." } }

Definition at line 39 of file ContentPackManifest.h.

Member Function Documentation

◆ GetMapNames()

TArray< FString > FCarlaContentPackManifest::GetMapNames ( ) const

Definition at line 167 of file ContentPackManifest.cpp.

References Maps.

Referenced by UCarlaContentPackManager::Mount().

◆ IsValidPackName()

bool FCarlaContentPackManifest::IsValidPackName ( const FString &  InName)
static

Name must be usable as a plugin name and mount point ("/<Name>/").

Definition at line 18 of file ContentPackManifest.cpp.

Referenced by Parse().

◆ LoadFromFile()

bool FCarlaContentPackManifest::LoadFromFile ( const FString &  InManifestPath,
FCarlaContentPackManifest &  OutManifest,
FString &  OutError 
)
static

Read and parse <ManifestPath>. Fills ManifestPath/PackDir.

Definition at line 145 of file ContentPackManifest.cpp.

References ManifestPath, PackDir, and Parse().

Referenced by UCarlaContentPackManager::Discover(), and UCarlaContentPackManager::Mount().

◆ Parse()

bool FCarlaContentPackManifest::Parse ( const FString &  JsonText,
FCarlaContentPackManifest &  OutManifest,
FString &  OutError 
)
static

Member Data Documentation

◆ BaseRelease

FString FCarlaContentPackManifest::BaseRelease

◆ CarlaVersion

FString FCarlaContentPackManifest::CarlaVersion

Definition at line 43 of file ContentPackManifest.h.

Referenced by Parse().

◆ Catalogs

TArray<FString> FCarlaContentPackManifest::Catalogs

Definition at line 49 of file ContentPackManifest.h.

Referenced by Parse().

◆ EngineCommit

FString FCarlaContentPackManifest::EngineCommit

Definition at line 46 of file ContentPackManifest.h.

Referenced by Parse().

◆ EngineVersion

FString FCarlaContentPackManifest::EngineVersion

Definition at line 45 of file ContentPackManifest.h.

Referenced by UCarlaContentPackManager::CheckCompatibility(), and Parse().

◆ Files

TMap<FString, FString> FCarlaContentPackManifest::Files

Definition at line 50 of file ContentPackManifest.h.

Referenced by Parse().

◆ ManifestPath

FString FCarlaContentPackManifest::ManifestPath

Absolute path of the manifest file this was parsed from.

Definition at line 53 of file ContentPackManifest.h.

Referenced by LoadFromFile().

◆ Maps

TArray<FCarlaContentPackMap> FCarlaContentPackManifest::Maps

◆ Name

FString FCarlaContentPackManifest::Name

◆ PackDir

FString FCarlaContentPackManifest::PackDir

Absolute path of the pack directory (parent of the manifest).

Definition at line 56 of file ContentPackManifest.h.

Referenced by LoadFromFile(), and UCarlaContentPackManager::Mount().

◆ Platform

FString FCarlaContentPackManifest::Platform

Definition at line 47 of file ContentPackManifest.h.

Referenced by UCarlaContentPackManager::CheckCompatibility(), and Parse().

◆ Version

FString FCarlaContentPackManifest::Version

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