Gondwana Game Engine Development (master) - 2.6.1
Gondwana is a cross-platform 2.5D game and rendering engine written in C#/.NET 8. It provides fine-grained control over rendering, timing, and scene composition, with built-in support for parallax, z-ordering, pixel overhang, collision detection, and particle effects. Gondwana targets desktop and web platforms using SkiaSharp for graphics and pluggable audio backends for desktop and browser targets.
Loading...
Searching...
No Matches
Gondwana.Assets.AssetsFileIdentifier Class Referencesealed

Represents an identifier for a specific asset within a file, including its type and name. More...

Public Member Functions

 AssetsFileIdentifier ()
 Initializes a new instance of the AssetsFileIdentifier class.
 AssetsFileIdentifier (AssetsFile resFile, AssetTypes resType, string entry)
 Initializes a new instance of the AssetsFileIdentifier class with the specified asset file, type, and name.
override string ToString ()
 Returns a string representation of this asset identifier.

Properties

AssetsFile AssetsFile = null! [get]
 Gets the AssetsFile that contains the asset.
AssetTypes AssetType [get]
 Gets the type of the asset.
string AssetName = null! [get]
 Gets the name of the asset.
bool IsValid [get]
 Gets a value indicating whether this asset identifier is valid and can retrieve data.
Stream? Data [get]
 Gets the stream containing the asset data.

Detailed Description

Represents an identifier for a specific asset within a file, including its type and name.

Definition at line 8 of file AssetsFileIdentifier.cs.

Constructor & Destructor Documentation

◆ AssetsFileIdentifier() [1/2]

Gondwana.Assets.AssetsFileIdentifier.AssetsFileIdentifier ( )

Initializes a new instance of the AssetsFileIdentifier class.

This parameterless constructor is primarily used for JSON deserialization.

Definition at line 46 of file AssetsFileIdentifier.cs.

◆ AssetsFileIdentifier() [2/2]

Gondwana.Assets.AssetsFileIdentifier.AssetsFileIdentifier ( AssetsFile resFile,
AssetTypes resType,
string entry )

Initializes a new instance of the AssetsFileIdentifier class with the specified asset file, type, and name.

Parameters
resFileThe AssetsFile that contains the asset.
resTypeThe type of the asset.
entryThe name of the asset entry.

Definition at line 54 of file AssetsFileIdentifier.cs.

Member Function Documentation

◆ ToString()

override string Gondwana.Assets.AssetsFileIdentifier.ToString ( )

Returns a string representation of this asset identifier.

Returns
A string containing the asset file path, asset type, and asset name.

Property Documentation

◆ AssetName

string Gondwana.Assets.AssetsFileIdentifier.AssetName = null!
get

Gets the name of the asset.

Definition at line 26 of file AssetsFileIdentifier.cs.

◆ AssetsFile

AssetsFile Gondwana.Assets.AssetsFileIdentifier.AssetsFile = null!
get

Gets the AssetsFile that contains the asset.

Definition at line 14 of file AssetsFileIdentifier.cs.

◆ AssetType

AssetTypes Gondwana.Assets.AssetsFileIdentifier.AssetType
get

Gets the type of the asset.

Definition at line 20 of file AssetsFileIdentifier.cs.

◆ Data

Stream? Gondwana.Assets.AssetsFileIdentifier.Data
get

Gets the stream containing the asset data.

Returns null if the asset cannot be found in the associated AssetsFile.

Definition at line 40 of file AssetsFileIdentifier.cs.

◆ IsValid

bool Gondwana.Assets.AssetsFileIdentifier.IsValid
get

Gets a value indicating whether this asset identifier is valid and can retrieve data.

An identifier is considered valid if its Data property returns a non-null stream.

Definition at line 33 of file AssetsFileIdentifier.cs.