(详谈)Cocos Creator之自定义项目提示文件

很多小伙伴们都知道Creator用JavaScript写项目是没有代码提示的,可能对于习惯有代码提示的童鞋不友好,想要代码有提示的童鞋,我建议你使用TypeScript写项目。这篇也是针对TypeScript项目的。

1.准备阶段

新建一个'test'空白项目,并打开其根目录
image.png

我们会发现根目录有creator.d.ts这个文件,这个是引擎自带的api提示文件,我们如果想自定义的话,必须取一个和它后缀名相同的文件。例如:wx.d.ts,并放在根目录。
image.png
接下来我们用编辑器打开这个文件进行编辑,因为我们开发的是微信小游戏,经常会用到微信的一些api,但是这些api是没有提示的,我们经常要去翻文档,很不方便。首先我们先声明wx一个模块。
image.png
declare是声明的意思,module是模块的意思,wx是模块名字。我们以wx.showShareMenu()和wx.shareAppMessage()为例。
image.png

wx.showShareMenu()是显示右上角转发按钮的意思,可以看到这个函数是可以带参数的。wx.shareAppMessage()也是一样带有参数,它是点击右上角按钮触发事件,废话不多说开干。
image.png
我在脚本中写"wx"是有提示的,还不会报错,如果没有声明wx,会报红。
image.png
下一步。我们把调用下方法,看见没有提示出来了,还有注释和参数。
image.png

下面上代码

wx.d.ts

interface _showShareMenuObject{
    /**
     * 是否使用带 shareTicket 的转发[详情]
     */
    withShareTicket?: boolean;

    /**
     * 接口调用成功的回调函数
     */
    success?: () => void;

    /**
     * 接口调用失败的回调函数
     */
    fail?: () => void;

    /**
     * 接口调用结束的回调函数(调用成功、失败都会执行)
     */
    complete?: () => void;       
    }


interface _ShareInfo{
        /**
         * 转发标题,不传则默认使用当前小游戏的昵称。
         */
        title: string,
        /**
         * 转发显示图片的链接,可以是网络图片路径或本地图片文件路径或相对代码包根目录的图片文件路径。显示图片长宽比是 5:4
         */
        imageUrl: string;
        /**
         * 查询字符串,必须是 key1=val1&key2=val2 的格式。从这条转发消息进入后,可通过 wx.getLaunchOptionSync() 或 wx.onShow() 获取启动参数中的 query。
         */
        query: string,
        /**
         * 审核通过的图片 ID
         */
        imageUrlId?: string
    }

declare module wx{

    /**
     * 显示当前页面的转发按钮
     * @param object 参数
     */
    export function showShareMenu(object?:_showShareMenuObject):void;

    /**
     * 监听用户点击右上角菜单的「转发」按钮时触发的事件
     */
    export function onShareAppMessage(callback:Function):void;
    
}

test.ts,这个脚本挂在场景的Canvas下


const {ccclass, property} = cc._decorator;

@ccclass
export default class NewClass extends cc.Component {

    onLoad () {
        if (CC_WECHATGAME) {
            let shareObj:_showShareMenuObject = {withShareTicket:true};
            wx.showShareMenu(shareObj);
            wx.onShareAppMessage(()=>{
                console.log("点击转发按钮");
                let shareInfo:_ShareInfo = {
                    title:"aa",
                    imageUrl:"http://img.manew.com/data/attachment/forum/201812/17/101356eauvqvm5b3u0zr9m.png.thumb.jpg",
                    query:null
                };
                return shareInfo;
            });
        }
    }

    start () {

    }

    // update (dt) {}
}

然后是 构建发布
打开->项目->构建发布


image.png

然后打开我们发布的项目,点击预览,使用微信扫扫就可以测试我们的项目了


image.png
测试结果如下图
image.png
image.png
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,214评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,307评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,543评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,221评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,224评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,007评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,313评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,956评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,441评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,925评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,018评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,685评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,234评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,240评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,464评论 1 261
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,467评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,762评论 2 345

推荐阅读更多精彩内容