Namespace Apogee.Reflection¶
Classes¶
Describes a partial class derived from
What the registry knows about an
An unmanaged struct that is an ECS component. Every public instance field is a field of the component (bool, integers,
float, double, Vector3,
An ECS component: its memory layout, so that the ECS can register it and scripts can read and write it.
The base class of everything scripts can hold. Every object has a partial and marked
An enum scripts can use: its members are strings there ("no_title_bar"), a flags enum is a list of them.
Reads and writes a component's fields in its memory as data is the start of the component.
One field of a component: where it is, how it is stored, and what an inspector needs to show it.
A component field as text and back: what a scene file holds in an attribute, and what prefab overrides and the clipboard will hold. The text is the same in every culture
(true and false, integers decimal, floats the shortest text that reads back as the same number (with
NaN, Infinity and -Infinity), and a 1 2 3, 0 0 0 1).
What an inspector needs to know about a property or a component field besides its type: a range for a slider, a step for a drag field, a heading, hidden, read-only. All optional.
A static class whose methods are a global table in scripts.
A method that scripts can call. A ValueTuple return gives a script several results.
A property or field that scripts, serialization and inspectors see. Read-only when it has no public setter.
A property: the setter is null for a read-only one.
What a module registered while it loaded, so that loading it again can take it back: a function that draws, a signal connection, a system. A reload makes a new scope, runs the new module in it, and then either runs the old scope's cleanups (the new code worked) or this one's (it did not, and the old registrations stay).
Which script is calling the engine right now, on this thread: the scripting layer sets it around every method a script calls, so that an engine class that does work for the script (the UI loading a document that has scripts of its own) can run that work as the same owner, under the same limits. Null outside a call from a script.
A place for the scripts of one thing to run in, such as one UI document: a table of globals of its own that falls back to the caller's, so the functions a <script> defines are visible to the
document's onclick="..." attributes and to nothing else. It runs as the script that made it (its owner, its memory and time limits).
A function a script handed to the engine (a callback, a system). The scripting layer implements it.
A static partial class whose imgui.text(…)).
A table the engine makes for scripts: named fields holding values (numbers, strings, booleans, lists). A method that returns one gives the script a new table with those fields; nil fields are left out. It is
read-only and lives in C#, so it is not a table a script gave the engine (that is any other
The scope of the module that is loading now, on this thread; libraries that register things for scripts call
A table a script handed to the engine, kept by reference and read when needed: what UI data models are made of. A place in it is a path of fields and list elements; reading the same path later gives what the script has put there since.
A
The handlers of a signal. Emitting calls a snapshot of them, so a handler may connect or disconnect (itself too) while it runs. An exception from a handler is logged and the others still run: the emitter never sees it.
The declared type of a property, parameter or result.
Every class, enum, component and script library that the source generator described. Each assembly with reflected types registers its own from a module initializer, so the registry is complete before the first lookup.
A value of the wrong type or out of range, or a bad call from a script. Scripts see it as an error with this message.
Structs¶
A connection to a signal; default is not connected.
One step down into a table: the field
An ECS entity or component id. Its meaning is the world's; the registry only carries it.
A value that crosses between the engine and scripts: no boxing for numbers, vectors, entities and enums. The To…
methods check the kind and throw a
Interfaces¶
Makes
Enums¶
How a component field is stored.
What a place in a table holds, as a data model sees it.
What a
Delegates¶
Calls a method with arguments already counted; writes its results (none for void, one per tuple item) to results.
Receives the arguments of an emitted signal as values.