โ† API reference
Query / scripting

luaApiSurface

Structured ctx.* or bridge.* surface for editor completions and hover. Requires script:read.

Arguments

Which scripting surface to describe

Returns [LuaApiEntry!]!

Scalar fields at a glance

pathString!
signatureString!
documentationString
isAsyncBoolean!
handleTypeString
โ†— View the complete LuaApiEntry type

Explore in a view

Scripting
View exact SDL
"""
Structured ctx.* or bridge.* surface for editor completions and hover. Requires script:read.
"""
luaApiSurface(
  """Which scripting surface to describe"""
  role: LuaScriptRole!
): [LuaApiEntry!]! @topic(names: ["scripting"])

Schema reference describes the API contract. Actual access is checked by the platform for every operation.