Struct LuaFileConfg

Namespace

Cobilas.GodotEngine.GDLua

Assembly

com.cobilas.godot.lua.dll

Represents configuration settings for Lua file operations in the Godot engine.

public readonly struct LuaFileConfg : ILuaFileConfg, ILuaContainerConfg

Implements

ILuaFileConfg

ILuaContainerConfg

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

Remarks

This structure provides configuration options for initializing and managing Lua script files, including file paths, Lua state management, and package settings.

Constructors

LuaFileConfg(string, Lua?, bool, bool, bool)

Represents configuration settings for Lua file operations in the Godot engine.

public LuaFileConfg(string filePath, Lua? luaState = null, bool useCLRPackage = false, bool refreshBuffer = false, bool openLibs = true)

Parameters

filePath string

The path to the Lua script file.

luaState Lua

The existing Lua state instance to use, or null to create a new one.

useCLRPackage bool

Whether to enable CLR package access from Lua scripts.

refreshBuffer bool

Whether to refresh the file buffer on each access.

openLibs bool

Whether to load standard Lua libraries.

Remarks

This structure provides configuration options for initializing and managing Lua script files, including file paths, Lua state management, and package settings.

Properties

FilePath

Gets the file path to the Lua script.

public string? FilePath { get; }

Property Value

string

The path to the Lua file, or null if not specified.

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.

RefreshBuffer

Gets a value indicating whether the file buffer should be refreshed on each access.

public bool RefreshBuffer { get; }

Property Value

bool

true to refresh the buffer on each access; 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.