Skip to content

Class LuauVmOptions

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

public sealed class LuauVmOptions

Inheritance

object ← LuauVmOptions

Inherited Members

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

Properties

CanAccessFile

Says whether a script of an owner may read (write false) or write a path of : given the owner, the canonical path and whether it is a write. Null: whatever the file system allows (it only takes writes in writable mounts).

public Func<ScriptOwner, string, bool, bool>? CanAccessFile { get; init; }

Property Value

Func<ScriptOwner, string, bool, bool>?

CanLoadModule

Says whether require may load a module for a script: given the owner of the requiring script and the module's path (mod://cool/ui.luau; engine modules are not asked about). Null: any module inside a root. This is how a mod is confined to its own files and its dependencies'.

public Func<ScriptOwner, string, bool>? CanLoadModule { get; init; }

Property Value

Func<ScriptOwner, string, bool>?

FileSystem

The file system the fs library reads and writes (null: fs finds nothing and writes nothing).

public VirtualFileSystem? FileSystem { get; init; }

Property Value

VirtualFileSystem?

Files

Where require reads scripts from; the real file system by default.

public IScriptFileSystem Files { get; init; }

Property Value

IScriptFileSystem

MemoryLimit

A hard limit on the bytes the VM may allocate while scripts run (0: none). Per-owner limits are softer and finer.

public long MemoryLimit { get; init; }

Property Value

long

Output

Receives what scripts print (and warn, flagged); the log by default.

public Action<ScriptOwner, string, bool>? Output { get; init; }

Property Value

Action<ScriptOwner, string, bool>?

OwnerOfModule

Chooses the owner a required module runs as, from its path; null (or no hook) keeps the requiring script's owner.

public Func<string, ScriptOwner?>? OwnerOfModule { get; init; }

Property Value

Func<string, ScriptOwner?>?

TimeBudgetMilliseconds

The time one call of a script may take when its owner has no budget of its own, in milliseconds (0: none).

public int TimeBudgetMilliseconds { get; init; }

Property Value

int