Skip to main content

DeleteGridResponse

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

type DeleteGridResponse {
  gridId: BigInt
  error: UdpErrorCode!
}

Fields​

DeleteGridResponse.gridId ● BigInt scalar​

The deleted grid id on success; null when error is non-zero.

DeleteGridResponse.error ● UdpErrorCode! non-null enum​

A UDP-style error code (the same ErrorType enum the realtime/UDP servers use). NO_ERROR (0) means success; non-zero values describe the failure, e.g. GRID_NOT_FOUND, CANNOT_DELETE_DEFAULT_WORLD_GRID, GRID_HAS_NESTED_CHILDREN, or UNKNOWN_ERROR.

Returned By​

deleteGrid mutation