Skip to content

Class DefinitionWriter

Namespace: Apogee.Scripting
Assembly: Apogee.Scripting.dll

Writes the engine's API as Luau type definitions (apogee.d.luau) for luau-lsp, from the registry: the classes, enums and script libraries the generator described, and the hand-written natives with the declarations they were registered with. The output depends only on the registry, in a fixed order.

public static class DefinitionWriter

Inheritance

object ← DefinitionWriter

Inherited Members

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

Methods

Write(DefinitionOptions?)

The definitions of everything registered now.

public static string Write(DefinitionOptions? options = null)

Parameters

options DefinitionOptions?

Returns

string

Write(IReadOnlyList<ClassInfo>, IReadOnlyList<EnumInfo>, IReadOnlyList<LibraryInfo>, DefinitionOptions?)

public static string Write(IReadOnlyList<ClassInfo> classes, IReadOnlyList<EnumInfo> enums, IReadOnlyList<LibraryInfo> libraries, DefinitionOptions? options = null)

Parameters

classes IReadOnlyList<ClassInfo>

enums IReadOnlyList<EnumInfo>

libraries IReadOnlyList<LibraryInfo>

options DefinitionOptions?

Returns

string