Skip to content

Class GameStart

Namespace: Apogee.Host
Assembly: Apogee.Host.dll

What starts: a game folder and how to run it.

public sealed record GameStart : IEquatable<GameStart>

Inheritance

object ← GameStart

Implements

IEquatable<GameStart>

Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()

Properties

Folder

The game's folder: res://, and where its game.xml and data/*.pack are.

public required string Folder { get; init; }

Property Value

string

Key

The key of the game's packs. Null: the one in the environment (APOGEE_PACK_KEY).

public PackKey? Key { get; init; }

Property Value

PackKey?

PacksOnly

The game is its packs: the folder's loose files are not mounted as res://, only data/*.pack are. Not together with .

public bool PacksOnly { get; init; }

Property Value

bool

RealAudio

Open the audio device (false: a silent audio system).

public bool RealAudio { get; init; }

Property Value

bool

RealSteam

Start Steam (false: Steam is off).

public bool RealSteam { get; init; }

Property Value

bool

RunScripts

False makes everything a game has without running the packages' scripts (or loading the entry scene): what an editor edits before Play.

public bool RunScripts { get; init; }

Property Value

bool

Scene

Scene text loaded into the world before the scripts run (what Play starts from). Null: the entry scene of game.xml, if it has one.

public string? Scene { get; init; }

Property Value

string?

UserFolder

The folder of the player's files (user://). Null: the one game.xml names, or one named after the game folder when there is no game.xml.

public string? UserFolder { get; init; }

Property Value

string?

Watch

Import changed assets into res://imported and reload what changes.

public bool Watch { get; init; }

Property Value

bool