UdpErrorCode

Error codes returned by UDP game servers (and surfaced on GenericErrorResponse.errorCode) in response to a spatial/realtime message. NO_ERROR (0) indicates success; every other value indicates a failure. The numeric value is the byte sent on the wire; GraphQL exposes the name. Note: a failed message does not always produce an error — some auth failures are dropped silently (see the docs).

enum UdpErrorCode {
  NO_ERROR
  UNKNOWN_ERROR
  EMAIL_NOT_FOUND
  BAD_PASSWORD
  EMAIL_ALREADY_EXISTS
  INVALID_TOKEN
  APP_NOT_FOUND
  UNAUTHORIZED
  APP_NOT_LOADED
  EMAIL_TOO_SHORT
  EMAIL_TOO_LONG
  PASSWORD_TOO_SHORT
  PASSWORD_TOO_LONG
  GAME_TOKEN_WRONG_SIZE
  NAME_TOO_LONG
  INVALID_REQUEST
  EMAIL_INVALID
  INVALID_TOKEN_LENGTH
  INVALID_APP_ID
  CHUNK_NOT_FOUND
  USER_NOT_AUTHENTICATED
  INVALID_STATE_DATA
  USER_NOT_APP_ADMIN
  GRID_OUTSIDE_ASSIGNMENT
  NO_MATCHING_GRID_ASSIGNMENT
  INVALID_GRID_COORDINATES
  GRID_ALREADY_EXISTS
  GRID_OVERLAPS_EXISTING
  GAMERTAG_ALREADY_EXISTS
  GRID_NOT_FOUND
  CANNOT_DELETE_DEFAULT_WORLD_GRID
  GRID_HAS_NESTED_CHILDREN
  TOKEN_EXPIRED
}

Values

`UdpErrorCode.NO_ERROR`

No error (0). The message was accepted.

`UdpErrorCode.UNKNOWN_ERROR`

Unspecified server error (1). Retry; if it persists, report it.

`UdpErrorCode.EMAIL_NOT_FOUND`

No account matches the supplied email (login validation).

`UdpErrorCode.BAD_PASSWORD`

The password did not match (login validation).

`UdpErrorCode.EMAIL_ALREADY_EXISTS`

Registration failed because the email is already in use.

`UdpErrorCode.INVALID_TOKEN`

The game token was rejected (expired, malformed, or revoked). Re-authenticate against the Management API to obtain a fresh token.

`UdpErrorCode.APP_NOT_FOUND`

No app matches the supplied appId.

`UdpErrorCode.UNAUTHORIZED`

The caller lacks the runtime/grid permission required for this action. Grid permissions can load asynchronously, so the first message to a newly entered region may transiently return this — retry shortly.

`UdpErrorCode.APP_NOT_LOADED`

The app exists but is not currently loaded/active on this server.

`UdpErrorCode.EMAIL_TOO_SHORT`

Email failed minimum-length validation.

`UdpErrorCode.EMAIL_TOO_LONG`

Email failed maximum-length validation.

`UdpErrorCode.PASSWORD_TOO_SHORT`

Password failed minimum-length validation.

`UdpErrorCode.PASSWORD_TOO_LONG`

Password failed maximum-length validation.

`UdpErrorCode.GAME_TOKEN_WRONG_SIZE`

The game token is not the expected length. Use the exact token returned by login (do not trim or re-encode it).

`UdpErrorCode.NAME_TOO_LONG`

A supplied name exceeded the maximum length.

`UdpErrorCode.INVALID_REQUEST`

The message was malformed or failed validation. Check the byte layout.

`UdpErrorCode.EMAIL_INVALID`

Email failed format validation.

`UdpErrorCode.INVALID_TOKEN_LENGTH`

The supplied token was not a valid length.

`UdpErrorCode.INVALID_APP_ID`

The appId was missing, zero, or not a valid value.

`UdpErrorCode.CHUNK_NOT_FOUND`

No chunk exists at the referenced coordinates.

`UdpErrorCode.USER_NOT_AUTHENTICATED`

This client has no authenticated session on the server. Complete the UDP token handshake (or open the UDP proxy) before sending spatial messages.

`UdpErrorCode.INVALID_STATE_DATA`

The state/payload bytes were invalid for this message type.

`UdpErrorCode.USER_NOT_APP_ADMIN`

Requires app-admin privileges (the 'manage_apps' permission).

`UdpErrorCode.GRID_OUTSIDE_ASSIGNMENT`

The target coordinates fall outside any grid assigned to the caller.

`UdpErrorCode.NO_MATCHING_GRID_ASSIGNMENT`

No grid assignment covers the referenced coordinates.

`UdpErrorCode.INVALID_GRID_COORDINATES`

The grid coordinates were invalid.

`UdpErrorCode.GRID_ALREADY_EXISTS`

A grid already exists at these coordinates.

`UdpErrorCode.GRID_OVERLAPS_EXISTING`

The requested grid overlaps an existing grid.

`UdpErrorCode.GAMERTAG_ALREADY_EXISTS`

The requested gamertag is already taken.

`UdpErrorCode.GRID_NOT_FOUND`

`UdpErrorCode.CANNOT_DELETE_DEFAULT_WORLD_GRID`

`UdpErrorCode.GRID_HAS_NESTED_CHILDREN`

`UdpErrorCode.TOKEN_EXPIRED`

The app-scoped gameplay token has expired. Refresh it (same app, via refreshAppToken) before it lapses, or re-portal through the Overworld for a fresh token, then re-authorize the realtime session.

Member Of

CreateGridResponse object ● DeleteGridResponse object ● GenericErrorResponse object ● TeleportResponse object

Values​

Member Of​

Values

Member Of