Struct LuaContainerConfg

Namespace

Cobilas.GodotEngine.GDLua

Assembly

com.cobilas.godot.lua.dll

Represents the configuration used to initialize a LuaContainer instance.

public readonly struct LuaContainerConfg : ILuaContainerConfg

Implements

ILuaContainerConfg

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

Remarks

This structure defines options for setting up the Lua environment, including whether to load CLR packages, open Lua libraries, and reuse an existing Lua state.

Constructors

LuaContainerConfg(Lua?, bool, bool)

Represents the configuration used to initialize a LuaContainer instance.

public LuaContainerConfg(Lua? luaState = null, bool useCLRPackage = false, bool openLibs = true)

Parameters

luaState Lua

useCLRPackage bool

openLibs bool

Remarks

This structure defines options for setting up the Lua environment, including whether to load CLR packages, open Lua libraries, and reuse an existing Lua state.

Properties

Default

Gets a default configuration for the LuaContainer.

public static LuaContainerConfg Default { get; }

Property Value

LuaContainerConfg

Remarks

The default configuration uses no predefined Lua state, disables CLR package loading, and enables standard Lua libraries.

LuaState

Gets the current Lua state instance.

public Lua? LuaState { get; }

Property Value

Lua

The Lua state object, or null if not initialized.

OpenLibs

Gets a value indicating whether standard Lua libraries should be loaded.

public bool OpenLibs { get; }

Property Value

bool

true to load standard Lua libraries; otherwise, false.

UseCLRPackage

Gets a value indicating whether the CLR package should be available in Lua.

public bool UseCLRPackage { get; }

Property Value

bool

true to enable CLR package access from Lua; otherwise, false.