Skip to main content

createGrid

Create a grid: a named 3D box of chunks that runtime/world (voxel) permissions are scoped to. The box must fit within one of the app's grid assignments (its buildable regions); it MAY be nested inside a broader containing grid such as the open-by-default world grid, but must not partially overlap a peer grid. Requires app-admin ('manage_apps'). Returns a hybrid response — on success grid is populated and error is NO_ERROR; on failure grid is null and error is a UDP-style error code (e.g. NO_MATCHING_GRID_ASSIGNMENT, GRID_OUTSIDE_ASSIGNMENT, GRID_OVERLAPS_EXISTING, GRID_ALREADY_EXISTS).

createGrid(
  input: CreateGridInput!
): CreateGridResponse!

Arguments​

createGrid.input ● CreateGridInput! non-null input​

Target app plus the two opposite corners of the grid box, in chunk coordinates. Corners are normalized to a low/high chunk, so their order does not matter.

Type​

CreateGridResponse object​

Result of createGrid. This is a hybrid result rather than a thrown error: inspect error first. When error is NO_ERROR the call succeeded and grid is populated; otherwise grid is null and error explains why.