Namespace Apogee.Host¶
Namespaces¶
Classes¶
Asset identity for scripts, as the global assets: an asset is named by its path (res://models/car.glb), which people read, and has a UID (uid://4k2m9x7q1w3ze), which stays the same when
the file is renamed or moved. A reference is the text path|uid://…; a path alone and a uid://… alone are also references. models.load and the other loaders take a path or a uid:// directly.
What a game's game.xml says about its window, as the defaults of the engine's window settings.
The engine's own settings (window., graphics., audio.*) and what makes them do something.
What goes over the finished picture: the game's UI, then the dev tools on top of it. The UI renderer is made the first frame after a document was loaded, so a script that only has ImGui panels never compiles the UI shader.
What a game asks of the program that runs it, as the script table game: ending the run (a menu's Quit), and whether the Escape key still ends it. A shipped game's
menu does the first; one with a pause menu of its own does the second, since Escape is its key.
What
The log file and the crash reports of a run, in the player's folder (user://logs and user://crashes).
A script running in a world: the entry script has been executed and its callbacks are registered; the loops step it frame by frame.
The schema of one setting: its key (dotted lower-case words, such as audio.volume or mod.coolmod.show_hints), its type, its default, and for a number its range or for a choice its
choices. The values themselves live in a
The player's settings, as the settings global: typed values under dotted keys (audio.volume, mod.coolmod.show_hints) that the engine and the game define (user://settings.xml as the ones that differ from their defaults. Keys the game does not define (a mod that is switched off) are kept as they are. The store belongs to the main thread.
Keeps a window and the window.* settings together: fullscreen follows the setting, and the size the player gives the window while it is not fullscreen is stored.
The session's world drawn through its main camera (the entity with
Enums¶
What a setting holds.