← API reference
Query / scripting

listLuaSamples

List the platform's Lua sample scripts. Metadata only — fetch source with getLuaSample. Every sample is type-checked and executed by tests. Requires script:read.

Arguments

Only samples for this scripting role (default: all)

Only samples of this tier (default: all)

Returns [LuaSampleSummary!]!

Scalar fields at a glance

idString!
titleString!
descriptionString!
apis[String!]!
↗ View the complete LuaSampleSummary type

Explore in a view

Scripting
View exact SDL
"""
List the platform's Lua sample scripts. Metadata only — fetch source with getLuaSample. Every sample is type-checked and executed by tests. Requires script:read.
"""
listLuaSamples(
  """Only samples for this scripting role (default: all)"""
  role: LuaScriptRole
  """Only samples of this tier (default: all)"""
  tier: LuaSampleTier
): [LuaSampleSummary!]! @topic(names: ["scripting"])

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