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.Scenes.GSCN.SceneDefinitionSource Class Referencesealed

Captures provenance details for a GSCN scene definition. More...

Static Public Member Functions

static SceneDefinitionSource LooseDefinitionFile (string gscnFilePath)
 Creates a source marker for a loose .gscn file.
static SceneDefinitionSource PackedDefinitionFile (string assetsFilePath, string assetEntryName)
 Creates a source marker for a packed .gscn entry inside an assets file.
static SceneDefinitionSource Generated ()
 Creates a source marker for a definition generated from runtime state or tooling.
static SceneDefinitionSource None ()
 Creates an empty source marker when no provenance is known.

Properties

SceneDefinitionSourceKind Kind [get]
 Gets the high-level source kind.
string? GscnFilePath [get]
 Gets the .gscn 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 GSCN scene definition.

Definition at line 8 of file SceneDefinitionSource.cs.

Member Function Documentation

◆ Generated()

SceneDefinitionSource Gondwana.Scenes.GSCN.SceneDefinitionSource.Generated ( )
static

Creates a source marker for a definition generated from runtime state or tooling.

Returns
A source descriptor identifying runtime-generated content.

◆ LooseDefinitionFile()

SceneDefinitionSource Gondwana.Scenes.GSCN.SceneDefinitionSource.LooseDefinitionFile ( string gscnFilePath)
static

Creates a source marker for a loose .gscn file.

Parameters
gscnFilePathThe gscn file path.
Returns
A source descriptor containing the loose definition file path.

Definition at line 42 of file SceneDefinitionSource.cs.

◆ None()

SceneDefinitionSource Gondwana.Scenes.GSCN.SceneDefinitionSource.None ( )
static

Creates an empty source marker when no provenance is known.

Returns
A descriptor with no persisted source.

◆ PackedDefinitionFile()

SceneDefinitionSource Gondwana.Scenes.GSCN.SceneDefinitionSource.PackedDefinitionFile ( string assetsFilePath,
string assetEntryName )
static

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

Parameters
assetsFilePathThe path to the assets file.
assetEntryNameThe entry name inside the assets file.
Returns
A source descriptor containing the assets file path and entry name.

Definition at line 60 of file SceneDefinitionSource.cs.

Property Documentation

◆ AssetEntryName

string? Gondwana.Scenes.GSCN.SceneDefinitionSource.AssetEntryName
get

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

Definition at line 35 of file SceneDefinitionSource.cs.

◆ AssetsFilePath

string? Gondwana.Scenes.GSCN.SceneDefinitionSource.AssetsFilePath
get

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

Definition at line 29 of file SceneDefinitionSource.cs.

◆ GscnFilePath

string? Gondwana.Scenes.GSCN.SceneDefinitionSource.GscnFilePath
get

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

Definition at line 23 of file SceneDefinitionSource.cs.

◆ Kind

SceneDefinitionSourceKind Gondwana.Scenes.GSCN.SceneDefinitionSource.Kind
get

Gets the high-level source kind.

Definition at line 17 of file SceneDefinitionSource.cs.