Gondwana.Drawing.Tilesheets.GTS.TilesheetDefinitionSource Class Reference

Captures provenance details for a tilesheet definition. More...

Static Public Member Functions
static TilesheetDefinitionSource	LooseDefinitionFile (string gtsFilePath)
	Creates a source marker for a loose .gts file.
static TilesheetDefinitionSource	PackedDefinitionFile (string assetsFilePath, string assetEntryName)
	Creates a source marker for a packed .gts entry inside an assets file.
static TilesheetDefinitionSource	Generated ()
	Creates a source marker for definitions generated by tooling.
static TilesheetDefinitionSource	None ()
	Creates an empty source marker when no provenance is known.

Properties
TilesheetDefinitionSourceKind	Kind [get]
	Gets the high-level source kind.
string?	GtsFilePath [get]
	Gets the .gts path when loaded from a loose definition file.
string?	AssetsFilePath [get]
	Gets the .gaf path when loaded from a packed definition file.
string?	AssetEntryName [get]
	Gets the packed entry name when loaded from a packed definition file.

Detailed Description

Captures provenance details for a tilesheet definition.

Definition at line 8 of file TilesheetDefinitionSource.cs.

Member Function Documentation

Generated()

TilesheetDefinitionSource Gondwana.Drawing.Tilesheets.GTS.TilesheetDefinitionSource.Generated ( )

static

Creates a source marker for definitions generated by tooling.

Returns

A source descriptor for generated definitions.

LooseDefinitionFile()

TilesheetDefinitionSource Gondwana.Drawing.Tilesheets.GTS.TilesheetDefinitionSource.LooseDefinitionFile ( string gtsFilePath )

static

Creates a source marker for a loose .gts file.

Parameters

gtsFilePath

The loose .gts file path.

Returns

A source descriptor for a loose definition file.

Exceptions

ArgumentException

Thrown when gtsFilePath is null or whitespace.

Definition at line 43 of file TilesheetDefinitionSource.cs.

None()

TilesheetDefinitionSource Gondwana.Drawing.Tilesheets.GTS.TilesheetDefinitionSource.None ( )

static

Creates an empty source marker when no provenance is known.

Returns

A source descriptor with no provenance.

PackedDefinitionFile()

TilesheetDefinitionSource Gondwana.Drawing.Tilesheets.GTS.TilesheetDefinitionSource.PackedDefinitionFile ( string assetsFilePath, string assetEntryName )

static

Creates a source marker for a packed .gts entry inside an assets file.

Parameters

assetsFilePath	The assets file path.
assetEntryName	The packed .gts entry name.

Returns

A source descriptor for a packed definition file.

Exceptions

ArgumentException

Thrown when required arguments are null or whitespace.

Definition at line 62 of file TilesheetDefinitionSource.cs.

Property Documentation

AssetEntryName

string? Gondwana.Drawing.Tilesheets.GTS.TilesheetDefinitionSource.AssetEntryName

get

Gets the packed entry name when loaded from a packed definition file.

Definition at line 35 of file TilesheetDefinitionSource.cs.

AssetsFilePath

string? Gondwana.Drawing.Tilesheets.GTS.TilesheetDefinitionSource.AssetsFilePath

get

Gets the .gaf path when loaded from a packed definition file.

Definition at line 29 of file TilesheetDefinitionSource.cs.

GtsFilePath

string? Gondwana.Drawing.Tilesheets.GTS.TilesheetDefinitionSource.GtsFilePath

get

Gets the .gts path when loaded from a loose definition file.

Definition at line 23 of file TilesheetDefinitionSource.cs.

Kind

TilesheetDefinitionSourceKind Gondwana.Drawing.Tilesheets.GTS.TilesheetDefinitionSource.Kind

get

Gets the high-level source kind.

Definition at line 17 of file TilesheetDefinitionSource.cs.