Skip to main content

Common zlua library

LayerRole
CSharpAssemblies / types / members / construction
zluaType-construction helpers, opaque, boxing, arrays, delegates, generic method closing (inflate)
Instance userdataMembers via metatable, not via zlua

Full API: 05-LIB, reference. This page lists only the most common. make_generic_method / register_method are not provided (see Spec §9).

Type arguments (typeArg)​

Most construction APIs accept the same typeArg set (05-LIB §3): zlua.types.*, type tables, type-name strings, System.Type (from zlua.typeof). Exception: GTAP prefixes accept System.Type only.

APIPurpose
zlua.types.int32, etc.Preset type arguments
zlua.typeof(typeTable)≡ C# typeof, returns System.Type
zlua.get_type_from_name(name)Analogous to Type.GetType (AQN, generics, arrays)

Overloads​

When multiple same-name candidates exist, the short name uses dispatch; pick one with a full-signature key (lazy on miss, then cached). Colon short names need Bind-time [LuaAlias] / XML:

demo['Run(System.Int32)'](demo, 5)
local run_i32 = demo['Run(System.Int32)']
run_i32(demo, 20)

Parameter parentheses come from native __zlua_create_signature(...) (you may wrap as zlua.signature); they cannot be a metatable key alone. See Method overloads.

Generic types and arrays​

local ListInt = zlua.make_generic_type(
CSharp.mscorlib['System.Collections.Generic.List`1'],
zlua.types.int32)

local arr = zlua.new_szarray_by_element_type(zlua.types.int32, 4)
local t = zlua.to_table(arr)
local bytes = zlua.to_bytes(float_arr) -- CLR blittable; not bool[] / char[]

Generic methods​

Open generic methods use zlua.inflate (full typeArg; cache the closure) or GTAP (prefixes only zlua.typeof(...)):

local GetRb = zlua.inflate(GameObject, "GetComponent", Rigidbody)
local rb = GetRb(go)
-- or: go:GetComponent(zlua.typeof(Rigidbody))

See Generics, Method calls.

Opaque / ref​

APIPurpose
get_opaquevalue / set_opaquevalueRead/write Opaque within a sync call chain (ref/in/out default Push)
to_user_dataCopy Opaque into Struct/Class userdata (long-lived; see OPAQUE)

ref struct: pass same-type Type(...) userdata to write back. See ref/out/in.

Boxing / view​

APIPurpose
zlua.box(typeArg, value)Value type → ByObj userdata
zlua.unbox(boxed)ByObj → primitive / ByVal userdata
zlua.cast(obj, targetType)Same identity, new IMT view

Delegate​

local d = zlua.to_delegate(fn, ActionIntType) -- second arg must be closed

Usually unnecessary when the parameter is already a concrete Action/Func. See Function.

Other (look up Spec when needed)​

mdarray family, Native __zlua_* table — 05-LIB §8, §12.