← API reference
Query / scripting

luaTypeDefinitions

Type definitions for a scripting role, rendered from the surface the validator checks against. Requires script:read.

Arguments

Which scripting surface to describe

Returns String!

Explore in a view

Scripting
View exact SDL
"""
Type definitions for a scripting role, rendered from the surface the validator checks against. Requires script:read.
"""
luaTypeDefinitions(
  """Which scripting surface to describe"""
  role: LuaScriptRole!
): String! @topic(names: ["scripting"])

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