package room.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Command data Operation frame data, used for client to send to the server, and the server broadcasts to all clients in the room 操作帧数据, 用于客户端发送给服务器，服务器广播给房间内所有客户端

Used in: FrameData, ReqSync

• string uid = 1

  player uid

  player uid

• float x = 2

  joystick x axis value

  x position

• float y = 3

  joystick y axis value

  y position

• int32 action = 4

  player action

  action

• bytes custom = 5

  custom data

  custom data

Frame data

Used in: NtfFrame

• uint32 frame_index = 1

  frame index

• repeated CmdData cmds = 2

  operation data

MsgID

• MSG_ID_INVALID = 0

• MSG_ID_HEARTBEAT = 1

• MSG_ID_ROOM_JOIN = 1000

• MSG_ID_ROOM_EXIT = 1001

• MSG_ID_ROOM_SYNC = 1002

NoticeID

• NOTICE_ID_INVALID = 0

• NOTICE_ID_ROOM_JOINED = 100

• NOTICE_ID_ROOM_EXIT = 101

• NOTICE_ID_ROOM_SYNC = 102

Notice client to sync frame data Room will send this notice every frame to all clients in the room 房间会每帧向房间内所有客户端发送此同步信息

• repeated FrameData frames = 1

  frame data 帧数据

Notice client to exit room when client exit room, server will send this notice to all clients in the room 当客户端退出房间时，服务器会向房间内所有客户端发送此通知

• repeated string uids = 1

  need remove player uids 需要移除的玩家uid

Notice client to join room when client join room, server will send this notice to all clients in the room if client is already in the room, notice will not be sent 当客户端加入房间时，服务器会向房间内所有客户端发送此通知

• repeated Player players = 1

  need add player info 需要添加的玩家信息

Player info

Used in: NtfRoomJoined

• string uid = 1

• string nickname = 2

• string avatar = 3

Client leave room

(message has no fields)

Client join room

• string token = 1

  room jwt token contains: uid,room_id 房间jwt token包含: uid,room_id

• uint32 last_frame_index = 2

  last frame index: default 0, if client has cache data and want to reconnect from a frame index, set this value to the corresponding frame index 最后一帧的索引: 默认为0, 如果客户端本地有缓存数据，想要从某个帧索引重新连接，设置这个值为对应的帧索引

Client sync frame data

• optional CmdData cmd = 1

Common response Common response message, all Response messages should be returned to the client as the message field of this message 通用响应消息，所有Response消息都应该作为此消息的message字段返回给客户端

• RoomErrorCode error_code = 1

• bytes message = 2

Room error code

Used in: Response

• ROOM_ERROR_CODE_OK = 0

• ROOM_ERROR_CODE_INVALID = 1

• ROOM_ERROR_CODE_NOT_FOUND = 2

• ROOM_ERROR_CODE_FULL = 3

• ROOM_ERROR_CODE_ALREADY_IN = 4

• ROOM_ERROR_CODE_NOT_IN = 5

• ROOM_ERROR_CODE_NOT_READY = 6

• ROOM_ERROR_CODE_ALREADY_READY = 7

• ROOM_ERROR_CODE_NOT_STARTED = 8

• ROOM_ERROR_CODE_ALREADY_STARTED = 9

• ROOM_ERROR_CODE_NOT_ENDED = 10

• ROOM_ERROR_CODE_ALREADY_ENDED = 11

• ROOM_ERROR_CODE_NOT_SYNC = 12

• ROOM_ERROR_CODE_ALREADY_SYNC = 13

Server response to client leave room

(message has no fields)

Server response to client join room

• int64 random_seed = 1

  room random seed 房间随机种子

Server response to client sync frame data

(message has no fields)