自定义消息

在 Cocos Creator 编辑器架构中，所有的交互都是通过消息通信实现的，本文将讲解如何自定义一条消息。

查看公开消息列表

在编辑器的顶部菜单栏中找到 开发者 -> 消息列表，可以打开消息管理面板，面板里显示了编辑器各系统公开的消息以及其说明。

定义一条消息

只有在 package.json 文件的 contributions.messages 字段里定义过的消息才能被使用。消息的定义如下所示：

{
    "name": "hello-world",
    "contributions": {
        "messages": {
            "test-messasge": {
                "public": false,
                "description": "",
                "doc": "",
                "methods": []
            }
        }
    }
}

test-messasge 为消息名称，下面我们逐一讲解每个属性的含义。

public

类型 {string} 可选

是否对外显示这条消息，如果为 true，则会在消息管理面板显示这条消息的基本信息。

description

类型 {string} 可选

消息摘要信息，如果 public 为 true，则会在消息管理面板显示，支持 i18n:key 语法。

doc

类型 {string} 可选

消息文档说明，如果 public 为 true，则会在消息管理面板显示，支持 i18n:key 语法。

这个文档使用 markdown 格式撰写并渲染。

methods

类型 {string[]} 可选

消息触发的方法队列。

这是一个字符串数组，字符串为扩展或者面板上的方法（methods）。 如果是触发扩展主程序的方法，则直接定义 methodName，如果要触发扩展里定义的面板上的方法，则要填写 panelName.methodName。

下面的示例中，send-to-package 将触发扩展主程序中的 sendMessage 方法，send-to-panel 将触发 test-panel 面板中的 sendMessage 方法。

{
    "name": "hello-world",
    "panels": {
        "test-panel": {
            ...
        }
    },
    "contributions": {
        "messages": {
            "send-to-package": {
                "methods": [
                    "sendMessage"
                ]
            },
            "send-to-panel": {
                "methods": [
                    "test-panel.sendMessage"
                ]
            }
        }
    }
}

关于更多消息机制，请参考文档 消息系统。