Skip to content

Class HostGlobal

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

A global that the host sets in its VMs (), which the definitions declare for the scripts that run there.

public sealed record HostGlobal : IEquatable<HostGlobal>

Inheritance

object ← HostGlobal

Implements

IEquatable<HostGlobal>

Inherited Members

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

Constructors

HostGlobal(string, string, string?)

A global that the host sets in its VMs (), which the definitions declare for the scripts that run there.

public HostGlobal(string Name, string Type, string? Doc = null)

Parameters

Name string

The global's name.

Type string

Its type in Luau, such as World.

Doc string?

One line for hover, or null.

Properties

Doc

One line for hover, or null.

public string? Doc { get; init; }

Property Value

string?

Name

The global's name.

public string Name { get; init; }

Property Value

string

Type

Its type in Luau, such as World.

public string Type { get; init; }

Property Value

string