Skip to content

Namespace Apogee.Reflection

Classes

ApogeeClassAttribute

Describes a partial class derived from to the registry: a source generator writes its from the members marked , and .

ClassInfo

What the registry knows about an class. Members are looked up by script name, inherited ones included.

ComponentAttribute

An unmanaged struct that is an ECS component. Every public instance field is a field of the component (bool, integers, float, double, Vector3, ); a struct with no fields is a tag. A field may carry for what an inspector shows (a range, a category, hidden, read-only).

ComponentInfo

An ECS component: its memory layout, so that the ECS can register it and scripts can read and write it.

EngineObject

The base class of everything scripts can hold. Every object has a (index and generation) in one table: scripts keep the handle, never the object, so a destroyed object is recognised and cannot be used by accident. Derived classes are partial and marked ; the source generator writes .

EnumInfo

An enum scripts can use: its members are strings there ("no_title_bar"), a flags enum is a list of them.

EnumMemberInfo

FieldAccess

Reads and writes a component's fields in its memory as s. data is the start of the component.

FieldDef

One field of a component: where it is, how it is stored, and what an inspector needs to show it.

FieldKinds

FieldText

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 (): booleans are true and false, integers decimal, floats the shortest text that reads back as the same number (with NaN, Infinity and -Infinity), and a , or is its numbers separated by single spaces (1 2 3, 0 0 0 1).

and are not here: what they hold only means something in a world (an entity's id, an asset handle), so whoever has that context writes and reads them.

InspectorMeta

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.

LibraryInfo

A static class whose methods are a global table in scripts.

MethodAttribute

A method that scripts can call. A ValueTuple return gives a script several results.

MethodDef

ParameterDef

PropertyAttribute

A property or field that scripts, serialization and inspectors see. Read-only when it has no public setter.

PropertyDef

A property: the setter is null for a read-only one.

ReloadScope

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).

ScriptCaller

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.

ScriptEnvironment

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).

ScriptFunction

A function a script handed to the engine (a callback, a system). The scripting layer implements it.

ScriptLibraryAttribute

A static partial class whose methods are a global table in scripts (imgui.text(…)).

ScriptRecord

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 ).

ScriptScope

The scope of the module that is loading now, on this thread; libraries that register things for scripts call .

ScriptTable

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.

Signal

Signal<T1, T2, T3, T4>

Signal<T1, T2, T3>

Signal<T1>

Signal<T1, T2>

SignalAttribute

A or property or field that scripts can connect to.

SignalBase

SignalBase<THandler>

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.

SignalDef

TypeRef

The declared type of a property, parameter or result.

TypeRegistry

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.

ValueException

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

Connection

A connection to a signal; default is not connected.

DataPathSegment

One step down into a table: the field , or when that is null the element of a list (counted from 0).

Entity

An ECS entity or component id. Its meaning is the world's; the registry only carries it.

SignalBase<THandler>.Entry

ScriptCaller.Restore

ScriptScope.Restore

Value

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 whose message a script can show.

Interfaces

IScriptEnvironments

Makes s; the scripting layer implements it.

Enums

FieldKind

How a component field is stored.

ScriptDataKind

What a place in a table holds, as a data model sees it.

ValueKind

What a holds.

Delegates

MethodInvoker

Calls a method with arguments already counted; writes its results (none for void, one per tuple item) to results.

PropertyGetter

PropertySetter

ScriptHandler

Receives the arguments of an emitted signal as values.

SignalConnector