Skip to main content

RangedChannelMessageInput

Input for publishing a channel message that only reaches members near an origin chunk. A member receives it when one of its live actors is in the same app within maxDistance chunks of the origin, measured as the straight-line (Euclidean) distance between chunk coordinates, boundary included; a member with no live actor does not receive it. Members receive an ordinary ChannelMessageNotification. The sender must have the channel send_messages permission, exactly as for sendChannelMessage.

input RangedChannelMessageInput {
  channelId: BigInt!
  uuid: String!
  payload: String!
  appId: BigInt!
  chunk: ChunkCoordinatesInput!
  maxDistance: Int!
  sequenceNumber: Int
}

Fields​

RangedChannelMessageInput.channelId ● BigInt! non-null scalar​

The channel id (groups.group_id) to publish to.

RangedChannelMessageInput.uuid ● String! non-null scalar​

The sender's actor UUID (your own actor's UUID). Must be exactly 32 bytes when encoded as UTF-8.

RangedChannelMessageInput.payload ● String! non-null scalar​

The message payload, base64-encoded. Opaque to the server; decode per your application protocol. Max 1024 bytes.

RangedChannelMessageInput.appId ● BigInt! non-null scalar​

The app the origin chunk is in. Must be the app this token is scoped to (the game server answers INVALID_APP_ID otherwise).

RangedChannelMessageInput.chunk ● ChunkCoordinatesInput! non-null input​

The origin chunk distance is measured from, usually the chunk of the sending actor. A chunk is a 16x16x16 voxel cube.

RangedChannelMessageInput.maxDistance ● Int! non-null scalar​

Largest straight-line distance from the origin chunk, in chunks, at which a member still receives the message: 0 (the origin chunk only) to 2147483647. Not capped at 8 and not the Chebyshev ring count spatial sends use.

RangedChannelMessageInput.sequenceNumber ● Int scalar​

Client-assigned correlation id for this datagram: a uint8 (0-255) that wraps at gameClientBootstrap.sequenceNumberModulo (256); defaults to 0 if omitted. For CORRELATION ONLY — it is NOT an idempotency key and the server does not dedupe replays. Echoed on any GenericErrorResponse for this send, delivered on the udpNotifications subscription.

Member Of​

sendRangedChannelMessage mutation