GmFunction

A studio-defined function: a named, sandboxed behavior over containers (parameters, declared mutations, optional return, and an authority invoke policy).

type GmFunction {
  functionId: String!
  appId: BigInt!
  name: String!
  containerTypeName: String
  description: String
  returnType: String
  parameters: [GmFunctionParam!]!
  mutations: [GmFunctionMutation!]!
  returnExpression: String
  invokeScope: String!
  invokePolicyJson: String
  autonomousInvocable: Boolean!
  notifications: [GmFunctionNotification!]!
  permissionEffects: [GmFunctionPermissionEffect!]!
  warnings: [String!]!
}

Fields

GmFunction.functionId ● String! non-null scalar

Unique function id (UUID).

GmFunction.appId ● BigInt! non-null scalar

The app (tenant) that owns the function.

GmFunction.name ● String! non-null scalar

Function name (unique per app); used to invoke it.

GmFunction.containerTypeName ● String scalar

Optional container type this function is bound to (null = global).

GmFunction.description ● String scalar

Optional description of the function.

GmFunction.returnType ● String scalar

Optional declared return value type.

GmFunction.parameters ● [GmFunctionParam!]! non-null object

Typed parameters the function accepts.

GmFunction.mutations ● [GmFunctionMutation!]! non-null object

The property writes the function performs when invoked.

GmFunction.returnExpression ● String scalar

Optional expression whose value becomes the invoke result.

GmFunction.invokeScope ● String! non-null scalar

Who may invoke and in what context: player | server | internal.

GmFunction.invokePolicyJson ● String scalar

JSON-encoded invoke policy rule tree.

GmFunction.autonomousInvocable ● Boolean! non-null scalar

Whether an autonomous process (automation/NPC) may use this function as an entry point. Players are unaffected by this flag.

GmFunction.notifications ● [GmFunctionNotification!]! non-null object

Declarative realtime notifications the function emits via Buddy after it commits.

GmFunction.permissionEffects ● [GmFunctionPermissionEffect!]! non-null object

Declarative grid-permission effects (grant/revoke runtime grid ACL rows) applied atomically with the function's mutations.

GmFunction.warnings ● [String!]! non-null scalar

Non-fatal static-analysis warnings from the last upload.

Returned By

gameModelFunction query ● gameModelFunctions query ● gameModelUpsertFunction mutation

Member Of

GmTypeSchema object