#

通用状态-游戏

Tips

1. SDK 保证状态有序串行从 MG 到达 APP；
2. 可重复通知，无需保证通知次数；
3. 通知后 SudMGP 保证状态有序串行从 MG 到达 APP；会按 state 值缓存最新一次的 data 值，供 APP 随时主动获取；
4. ISudFSMMG void onGameStateChange(ISudFSMStateHandle handle, String state, String dataJson)；

0. 测试状态

• state

mg_common_hello_fsm

• data

{
  "msg": "Hello FSM from MG!"
}

• 说明

用于状态测试。

1. 公屏消息（已修改）

• 最低版本: v1.1.30.xx
• state

mg_common_public_message

• data

{
  "type": 0,
  "msg": [
    {
      "phrase": 1,
      "text": {
        "default": "玩家",
        "en-US": "Player"
      }
    },
    {
      "phrase": 2,
      "user": {
        "name": "用户A",
        "uid": "0001",
        "color": "#00FF00"
      }
    },
    {
      "phrase": 1,
      "text": {
        "default": "击败了玩家",
        "en-US": "击败了玩家"
      }
    },
    {
      "phrase": 2,
      "user": {
        "name": "用户B",
        "uid": "0002",
        "color": "#FF0000"
      }
    }
  ]
}

• 说明

向公屏发送消息，字段含义如下
type
0 通知
1 提醒
2 结算
3 其他
msg

<!-- -->内为转义字段：
<!--name:用户昵称|uid:用户UID|color:建议颜色-->
其中name/uid/color均为可选字段，字段为空的情况如下：
<!--name:|uid:|color:-->
SDK仅会缓存最新一条。

• json

• 词组

• 当 phrase=1 时参数说明

• 当 phrase=2 时参数说明

2. 关键词状态

• state

mg_common_key_word_to_hit

• data

{
  "wordType": "text",                       // 必填字段；text:文本包含匹配; number:数字等于匹配(必填字段)；默认:text（你画我猜、你说我猜）；数字炸弹填number；
  "word": "关键",                        // 单个关键词，兼容老版本
  "realWord": "关键词",
  "wordList": ["关键词1", "关键词2", …],    // 必填字段；关键词列表，可以传送多个关键词
"wordLanguage ": "zh-CN",       // 必填字段；关键词语言，默认:zh-CN；
}

• 说明

关键词

3. 游戏结算状态

• 最低版本: v1.1.30.xx
• state

mg_common_game_settle

• data

• PlayerResult = {}

• data

{
  "gameMode": 1, // 游戏模式
  "gameRoundId": "123", // 本局游戏id
  "results": [
    {
      "uid": "用户id", // 用户id
      "rank": 1, // 排名 从 1 开始
      "award": 100, // 奖励
      "score": 100, // 积分
      "isEscaped": 1, // 逃跑
      "killerId": "杀自己的玩家id", // 杀自己的玩家id
      "isAI": 0, // 是否是AI玩家
      "isManaged": 0, // 是否托管完成游戏
      "extras": "" // 扩展信息
    }
  ]
}

• 说明

游戏结算状态

4. 加入游戏按钮点击状态

• state

mg_common_self_click_join_btn

• data

{
  "seatIndex": 0 // 点击头像加入游戏对应的座位号，int 类型，从0开始， 如果seatIndex=-1，则是随机加入一个空位，如果seatIndex 大于座位数，则加入不成功
}

• 说明

用户（本人）点击加入按钮，或者点击头像加入

5. 取消加入(退出)游戏按钮点击状态

• state

mg_common_self_click_cancel_join_btn

• data

{}

• 说明

用户（本人）点击取消加入按钮

6. 准备按钮点击状态

• state

mg_common_self_click_ready_btn

• data

{}

• 说明

用户（本人）点击准备按钮

7. 取消准备按钮点击状态

• state

mg_common_self_click_cancel_ready_btn

• data

{}

• 说明

用户（本人）点击取消准备按钮

8. 开始游戏按钮点击状态

• state

mg_common_self_click_start_btn

• data

{}

• 说明

用户（本人，队长）点击开始游戏按钮

9. 分享按钮点击状态

• state

mg_common_self_click_share_btn

• data

{}

• 说明

用户（本人）点击分享按钮

10. 游戏状态

• state

mg_common_game_state

• data

{
  "gameState": 0 // gameState=0 (idle 状态，游戏未开始，空闲状态）；gameState=1 （loading 状态，所有玩家都准备好，队长点击了开始游戏按钮，等待加载游戏场景开始游戏）；gameState=2（playing状态，游戏进行中状态）
}

• 说明

游戏状态

11. 结算界面关闭按钮点击状态（2021-12-27 新增）

• state

mg_common_self_click_game_settle_close_btn

• data

{}

• 说明

用户（本人）点击结算界面关闭按钮

12. 结算界面再来一局按钮点击状态（2021-12-27 新增）

• state

mg_common_self_click_game_settle_again_btn

• data

{}

• 说明

用户（本人）点击结算界面再来一局按钮

13. 游戏上报游戏中的声音列表（2021-12-30 新增）

• state

mg_common_game_sound_list

• data

{
  "list": [
    {
      "name": "click", // 声音资源的名字
      "url": "https://www.xxxx/click.mp3", // 声音资源的URL链接
      "type": "mp3" // 声音资源类型
    }
  ]
}

• 说明

游戏上报本游戏中所有的声音资源列表

14. 游通知 app 层播放声音（2021-12-30 新增）

• state

mg_common_game_sound

• data

{
  "isPlay": true, // 是否播放 isPlay==true(播放)，isPlay==false(停止)
  "name": "click", // 要播放的声音文件名，不带后缀
  "type": "mp3", // 声音资源类型
  "times": 1, // 播放次数；注：times == 0 为循环播放
  "url": "https://www.xxxx.xx/xxx.mp3" // 声音资源的url链接
}

• 说明

游戏通知app层播放声音

15. 游戏通知 app 层播放背景音乐状态（2022-01-07 新增）

• state

mg_common_game_bg_music_state

• data

{
  "state": true // 背景音乐的开关状态 true: 开，false: 关
}

• 说明

游戏通知app层播放背景音乐的开关状态

16. 游戏通知 app 层播放音效的状态（2022-01-07 新增）

• state

mg_common_game_sound_state

• data

{
  "state": true // 背景音乐的开关状态 true: 开，false: 关
}

• 说明

游戏通知app层播放音效的状态

17. ASR 状态(开启和关闭语音识别状态，SudMGP v1.1.45.xx 版本新增)

• state

mg_common_game_asr

• data

{
  "isOpen": true // true:打开语音识别 false:关闭语音识别
}

• 说明

开启和关闭语音识别状态

18. 麦克风状态（2022-03-04 新增）

• state

mg_common_self_microphone

• data

{
  "isOn": true, // 麦克风开关状态 true: 开(APP开启RTC推流)；false: 关(APP关闭RTC推流)
    "state": 1,        // 1: 白天 2：黑夜 3：非游戏
}

• 说明

游戏通知app麦克风状态

19. 耳机（听筒，扬声器）状态（2022-03-04 新增）

• state

mg_common_self_headphone

• data

{
  "isOn": true, // 耳机（听筒，喇叭）开关状态 true: 开(APP开启RTC拉流)；false: 关(APP关闭RTC拉流)
    "state": 1,        // 1: 白天 2：黑夜 3：非游戏
}

• 说明

游戏通知app耳机（听筒，喇叭）状态

20. App 通用状态操作结果错误码（2022-05-10 新增）

• state

mg_common_app_common_self_x_resp

• data

{
  "state": "app_common_self_playing", // 字段必填, 参考：游戏业务错误 https://docs.sud.tech/zh-CN/app/Client/APPFST/CommonState.html
  "resultCode": 0, // 字段必填，参考：游戏业务错误 https://docs.sud.tech/zh-CN/app/Server/ErrorCode.html
  "isIn": true, // 当state=app_common_self_in时，字段必填
  "isReady": true, // 当state=app_common_self_ready时，字段必填
  "isPlaying": true, // 当state=app_common_self_playing时，字段必填
  "reportGameInfoExtras": "", // 当state=app_common_self_playing时，字段必填
  "curCaptainUID": "", // 当state=app_common_self_captain时，字段必填
  "kickedUID": "" // 当state=app_common_self_kick时，字段必填
}

• 说明

App通用状态操作错误结果回调状态（注：只回调错误结果）
目前只支持app_common_self_playing

21. 游戏通知 app 层添加陪玩机器人是否成功（2022-05-17 新增）

• state

mg_common_game_add_ai_players

• data

{
    "resultCode": 0, //返回码 0：成功，非0：不成功
    "userIds": ["123", ...] // 加入成功的playerId列表
}

• 说明

游戏通知app层添加陪玩机器人是否成功

22. 游戏通知 app 层添当前网络连接状态（2022-06-21 新增）

• state

mg_common_game_network_state

• data

{
  "state": 1 // 0:closed, 1: connected
}

• 说明

游戏通知app层添当前网络连接状态

23. 游戏通知 app 获取积分

• state

mg_common_game_get_score

• data

{}

• 说明

游戏通知app获取积分

24. 游戏通知 app 带入积分

• state

mg_common_game_set_score

• data

{
  "lastRoundScore": 0, // 本人当前积分
  "incrementalScore": 10, // 充值积分
  "totalScore": 10 // 充值后总积分
}

• 说明

游戏通知app带入积分

25. 创建订单

• state

mg_common_game_create_order

• data

{
  "cmd": "", // 触发的行为动作，比如打赏，购买等
  "fromUid": "", // 付费用户uid
  "toUid": "", // 目标用户uid
  "value": 123, // 所属的游戏价值
  "payload": "{}" // 扩展数据 json 字符串, 特殊可选
}

• cmd 事件数据参数对应表

1.德州扑克专业版，游戏ID=1557194155570024449

2.TeenPatti专业版，游戏ID=1557194487352053761

3.太空杀，游戏ID=1559736844916183041

4.狼人杀，游戏ID=1472142747708284929

role_id 说明（1：狼人，2：村民，3：预言家，4：女巫，5：猎人，6：守卫） index 说明（1：狼人，2：村民，3：预言家，4：女巫，5：猎人，6：守卫）

5.棒球

6.谁是卧底

7.飞行棋

8.五子棋专业版/gobangpro

9.UMO

10.排雷兵

11.骰宝/Chuck-A-Luck

12.大胃王/Big Eater

13.777/Slots

14.魔法塔罗/MAGIC TAROT

15.炸金花/TEEN PATTI

16.超级转轮/SUPER WHEEL

17.疯狂赛车/Crazy Racing

18.跳一跳/jumpjump

19.大富翁

20.蛇梯

21.连连看

22.巴洛特/baloot

• 说明

创建订单

26. 游戏通知 app 玩家角色(仅对狼人杀有效)

• state

  mg_common_player_role_id

• data

• 狼人杀

{
    "playersRoleId": [{"uid": "玩家id", "roleId": 0||1||2||3||4||5||6}, {"uid": "玩家id", "roleId": 0||1||2||3||4||5||6}, .....],     // roleId: (0:不知道，1狼人，2村民，3预言家，4女巫，5猎人，6好人)
}

• 谁是卧底

{
    "playersRoleId": [{"uid": "玩家id", "roleId": 1||2}, {"uid": "玩家id", "roleId": 1||2}, .....],     // roleId: (1平民，2卧底)
}

• 说明

游戏通知app玩家角色

27. 游戏通知 app 玩家被扔便便(仅对你画我猜有效)

• state

mg_common_self_click_poop

• data

{}

• 说明

游戏通知app玩家被扔便便

28. 游戏通知 app 玩家被点赞(仅对你画我猜有效)

• state

mg_common_self_click_good

• data

{}

• 说明

游戏通知app玩家被点赞

29. 游戏通知 app 游戏 FPS(仅对碰碰，多米诺骨牌，飞镖达人生效)

• state

mg_common_game_fps

• data

{
  "fps": 60
}

• 说明

游戏通知app游戏FPS

30. 游戏通知 app 游戏弹框

• state

mg_common_alert

• data

{
  "state": "show" // show:显示，close:关闭
}

• 说明

游戏通知app游戏弹框

31. 游戏通知 app 最坑队友（只支持友尽闯关）

• state

mg_common_worst_teammate

• data

{
  "uid": "123" // 最坑队友的uid
}

• 说明

游戏通知app最坑队友

32. 游戏通知 app 因玩家逃跑导致游戏结束（只支持友尽闯关）

• state

mg_common_game_over_tip

• data

{
  "uids": ["123", "345"] // 逃跑玩家的uid数组
}

• 说明

游戏通知app因玩家逃跑导致游戏结束

33. 游戏通知 app 玩家颜色（支持友尽闯关 与 ludo）

• state

mg_common_game_player_color

• data

{
  "players": [
    { "uid": "123", "color": 1 },
    { "uid": "123", "color": 2 },
    { "uid": "123", "color": 3 }
  ]
}

//color:1是粉色，2是紫色，3是绿色，4是蓝色，5是黄色，6是橙色，7是红色

• 说明

游戏通知app玩家颜色

34. 游戏通知 app 玩家头像的坐标（支持 ludo, 飞镖, umo, 多米诺, teenpatti, texasholdem）

• state

mg_common_game_player_icon_position

• data

{
  "uid": "123", // 玩家id
  "position": { "x": 0, "y": 0, "width": 0, "height": 0 } // 头像坐标及大小
}

• 说明

游戏通知app玩家头像的坐标

35. 游戏通知 app 退出游戏（只支持 teenpattipro 与 德州 pro）

• state

mg_common_self_click_exit_game_btn

• data

{}

• 说明

游戏通知app玩家头像的坐标

36. 游戏通知 app 是否要开启带入积分（只支持 teenpattipro 与 德州 pro）

• state

mg_common_game_is_app_chip

• data

{
  "isAppChip": 1 // 0:不开启，1：开启
}

• 说明

游戏通知app是否要开启带入积分

37. 游戏通知 app 当前游戏的设置信息（只支持德州 pro，teenpatti pro）

• state

mg_common_game_rule

• data

{
  "gameMode": {
    // 字段查下如下说明
  }
}

• 德州结构为

{
  "smallBlind": 1, // 小盲
  "ante": 0, // 前注
  "isStraddle": 0, // 0：关闭，1自由，2强制
  "sBuyIn": 100, // 带入值/最小带入配置
  "bBuyIn": 200, // 最大带入，无限（0）
  "isAutoStart": 2, // 是否自动开始
  "tableDuration": 0.5, // 牌桌时长配置（小时）
  "thinkTime": 2 // 思考时间（秒）
}

• teenpatti 结构为

{
  "ante": 10, // 底分
  "darkCard": 2, // 暗牌回合
  "isAutoStart": 2, // 是否自动开始
  "potLimit": 1000, // 最大带入
  "round": 10, // 最大回合
  "singleLimit": 32, // 单注限
  "tableDuration": 0.5, // 牌桌时长配置（小时）
  "thinkTime": 15 // 思考时间（秒）
}

• 说明

游戏通知app当前游戏的设置信息

38. 游戏通知 app 进行玩法设置（只支持德州 pro，teenpatti pro）

• state

mg_common_game_settings

• data

{}

• 说明

游戏通知app进行玩法设置

39. 游戏通知 app 钱币不足（只支持德州 pro，teenpatti pro）

• state

mg_common_game_money_not_enough

• data

{}

• 说明

游戏通知app钱币不足

40. 游戏通知 app 下发定制 ui 配置表（支持ludo和五子棋）

• state

mg_common_game_ui_custom_config

• data

{}

• 说明

游戏通知app下发定制ui配置表

41. 设置app提供给游戏可点击区域(赛车)

坐标系原点：左上角,单位为像素

• state

mg_common_set_click_rect

• data

{
    "list":
    [
    {
      "x": 0,               //可点击区域的x
      "y": 0,               //可点击区域的y
      "width": 0,           //可点击区域的width
      "height": 0,          //可点击区域的height
    }
    ]
}

• 说明

游戏客户端通知APP指令动作设置点击区域

42. 通知app提供对应uids列表玩家的数据(赛车)

• state

mg_common_users_info

• data

{
    "uids": ["uid1", "uid2"...]
}

• 说明

通知app提供对应uids列表玩家的数据

43. 通知app游戏前期准备完成(赛车)

• state

mg_common_game_prepare_finish

• data

{
}

• 说明

通知app游戏前期准备完成

44. 通知app游戏主界面已显示(赛车)

• state

mg_common_show_game_scene

• data

{
}

• 说明

通知app游戏主界面已显示

45. 通知app游戏主界面已隐藏(赛车)

• state

mg_common_hide_game_scene

• data

{
}

• 说明

通知app游戏主界面已隐藏

46. 通知app点击了游戏的金币按钮(赛车)

• state

mg_common_self_click_gold_btn

{
}

• 说明

通知app点击了游戏的金币按钮

47. 通知app棋子到达终点(ludo)

• state

mg_common_game_piece_arrive_end

{
    "uid": "",          // 玩家id
    "pieceIndex": 0,    // 棋子编号 0 ~ 3
}

• 说明

 通知app棋子到达终点

48. 通知app玩家是否托管

• state

mg_common_game_player_managed_state

{
    "uid": "",    // 玩家id
    "managed": 0,    // 0: 未托管 1：托管
}

• 说明

通知app玩家是否托管

49. 游戏通知app爆词的内容

• state

mg_common_game_send_burst_word

{
    "text": "",    // 爆词
}

• 说明

游戏通知app爆词的内容

50. 游戏向app发送玩家实时排名（只支持怪物消消乐）

• state

mg_common_game_player_ranks

{
    "ranks": [
        {"uid": "userid", "rank": 1},
        {"uid": "userid", "rank": 2}
    ]    // 所有玩家排名变化推送
}

• 说明

游戏向app发送玩家实时排名

51. 游戏向app发送玩家即时变化的单双牌（只支持okey101）

• state

mg_common_game_player_pair_singular

{
    "pairs": [
        {"uid": "userid", "pair": 1},    // pair: 1 双，0 单
        {"uid": "userid", "pair": 0}
    ]    // 玩家单双牌推送
}

• 说明

游戏向app发送玩家即时变化的单双牌

52. 游戏向app发送获取玩家持有的道具卡（只支持大富翁）

• state

mg_common_game_player_monopoly_cards

{
}

• 说明

 游戏向app发送获取玩家持有的道具卡

53. 游戏向app发送玩家实时积分（只支持怪物消消乐）

• state

mg_common_game_player_scores

{
    "scores": [
        {"uid": "userid", "score": 10},
        {"uid": "userid", "score": 20}
    ]    // 所有玩家积分变化推送
}

• 说明

游戏向app发送玩家实时积分

54. 游戏通知app销毁游戏（只支持部分概率类游戏）

• state

mg_common_destroy_game_scene

{
}

• 说明

游戏通知app销毁游戏

55. 游戏通知app击球状态（只支持桌球）

• state

mg_common_game_billiards_hit_state

{
    "uid": "user id",    // 操作玩家的id
    "state": 0,   // 请查看下面state状态说明
}

• 说明

  state状态说明:
  0: 母球击空或者第一击没击中目标球
  2-7: 连杆
  8: 白球进洞
  9: 没有足够的撞库数量
  10: 开球时进了黑八
  11: 提前进了黑八
  12: 没有有效进球
  13: 有有效进球
  14: 超时
  

游戏通知app击球状态

56. 游戏向app发送获取玩家持有的指定点数道具卡（只支持飞行棋）

• state

mg_common_game_player_props_cards

{
}

• 说明

 游戏向app发送获取玩家持有的指定点数道具卡

57. 游戏向app发送获游戏通用数据

• state

mg_common_game_info_x

{
    "eventName": "",        // 事件名称 ，（注：具体游戏参考如下）
    "data": "{JSON string}" // 具体的数据，为一个JSON字符串， （注：具体游戏参考如下）
}

• 怪物消消乐
• 排名上升，排名下降 "event_name" key字段为 monstercrush_ranking_up_and_down "data" 字段为具体的数据，为一个JSON字符串; 其中 uid为相关玩家的id，ranking为具体升降名次，rangking 大于0则问升，小于0为降, rank: 当前排名

    {
        "eventName": "monstercrush_ranking_up_and_down",
        "data": "{\"uid\": \"user id\",\"ranking\": 0, \"rank\": 0}"
    }
  

• 双彩虹清屏 "event_name" key字段为 monstercrush_clear_game_board "data" 字段为具体的数据，为一个JSON字符串; 其中 uid为相关玩家的id

    {
        "eventName": "monstercrush_clear_game_board",
        "data": "{\"uid\": \"user id\"}"
    }
  

• ludo(飞行棋)

• 玩法设置信息 "event_name" key字段为 ludo_setting_info "data" 字段为具体的数据，为一个JSON字符串; 其中 model为经典或者快速，chess_num 为棋子个数，item为是否开启道具

    {
        "eventName": "ludo_setting_info",
        "data": "{\"model\": 1, \"chess_num\": 4, \"item\":1}", // 注 (model: 1 经典，0 快速; chess_num: 2 两个棋子，4 四个棋子; item: 0 无道具，1 有道具)
    }
  

• 说明

 游戏向app发送获游戏通用数据