WebView 组件参考

WebView 是一种显示网页的组件,该组件让你可以在游戏里面集成一个小的浏览器。

webview

点击 属性检查器 下面的添加组件按钮,然后从添加 UI 组件中选择WebView,即可添加 WebView 组件到节点上。

WebView 的脚本接口请参考 WebView API

WebView 属性

属性功能说明
Url指定一个 URL 地址,这个地址以 HTTP 或者 HTTPS 开头,请填写一个有效的 URL 地址 。
WebViewEventsWebView 的回调事件,当 webview 在加载网页过程中,加载网页结束后或者加载网页出错时会调用此函数。

WebView 事件

WebViewEvents 事件

属性功能说明
Target带有脚本组件的节点。
Component脚本组件名称。
Handler指定一个回调函数,当网页加载过程中、加载完成后或者加载出错时会被调用,该函数会传一个事件类型参数进来。详情见WebView 事件回调参数 章节
CustomEventData用户指定任意的字符串作为事件回调的最后一个参数传入。

WebView 事件回调参数

名称功能说明
LOADING表示网页正在加载过程中。
LOADED表示网页加载已经完毕。
ERROR表示网页加载出错了。

详细说明

目前此组件只支持Web(PC 和手机)、iOS 和 Android 平台,Mac 和 Windows 平台暂时还不支持,如果在场景中使用此组件,那么在 PC 的模拟器里面预览的时候可能看不到效果。

此控件暂时不支持加载指定 HTML 文件或者执行 Javascript 脚本。

通过脚本代码添加回调

方法一

这种方法添加的事件回调和使用编辑器添加的事件回调是一样的,通过代码添加,你需要首先构造一个 cc.Component.EventHandler 对象,然后设置好对应的 target, component, handler 和 customEventData 参数。

  1. //here is your component file
  2. cc.Class({
  3. name:'cc.MyComponent',
  4. extends: cc.Component,
  5. properties:{
  6. webview: cc.WebView,
  7. },
  8. onLoad:function(){
  9. var webviewEventHandler =new cc.Component.EventHandler();
  10. webviewEventHandler.target =this.node;//这个 node 节点是你的事件处理代码组件所属的节点
  11. webviewEventHandler.component ="cc.MyComponent";
  12. webviewEventHandler.handler ="callback";
  13. webviewEventHandler.customEventData ="foobar";
  14. this.webview.webviewEvents.push(webviewEventHandler);
  15. },
  16. //注意参数的顺序和类型是固定的
  17. callback:function(webview, eventType, customEventData){
  18. //这里 webview 是一个 WebView 组件对象实例
  19. // 这里的 eventType === cc.WebView.EventType enum 里面的值
  20. //这里的 customEventData 参数就等于你之前设置的 "foobar"
  21. }
  22. });

方法二

通过 webview.node.on('loaded', …) 的方式来添加

  1. //假设我们在一个组件的 onLoad 方法里面添加事件处理回调,在 callback 函数中进行事件处理:
  2. cc.Class({
  3. extends: cc.Component,
  4. properties:{
  5. webview: cc.WebView,
  6. },
  7. onLoad:function(){
  8. this.webview.node.on('loaded',this.callback,this);
  9. },
  10. callback:function(event){
  11. //这里的 event 是一个 EventCustom 对象,你可以通过 event.detail 获取 WebView 组件
  12. var webview =event.detail;
  13. //do whatever you want with webview
  14. //另外,注意这种方式注册的事件,也无法传递 customEventData
  15. }
  16. });

同样的,你也可以注册 loading, error 事件,这些事件的回调函数的参数与 loaded 的参数一致。

如何与 WebView 内部页面进行交互

调用 WebView 内部页面

  1. cc.Class({
  2. extends: cc.Component,
  3. properties:{
  4. webview: cc.WebView,
  5. },
  6. onLoad:function(){
  7. // 这里的 Test 是你 webView 内部页面代码里定义的全局函数
  8. this.webview.evaluateJS('Test()');
  9. }
  10. });

注意: Web 平台上的跨域问题需要自行解决

WebView 内部页面调用外部的代码

目前 Android 与 IOS 用的机制是,通过截获 url 的跳转,判断 url 前缀的关键字是否与之相同,如果相同则进行回调。

  • 通过 setJavascriptInterfaceScheme 设置 url 前缀关键字
  • 通过 setOnJSCallback 设置回调函数,函数参数为 url
  1. cc.Class({
  2. extends: cc.Component,
  3. properties:{
  4. webview: cc.WebView,
  5. },
  6. onLoad:function(){
  7. var scheme ="TestKey";// 这里是与内部页面约定的关键字
  8. function jsCallback (url){
  9. // 这里的返回值是内部页面的 url 数值,
  10. // 需要自行解析自己需要的数据
  11. var str = url.replace(scheme +'://','');
  12. var data = JSON.stringify(str);// {a: 0, b: 1}
  13. }
  14. this.webview.setJavascriptInterfaceScheme(scheme);
  15. this.webview.setOnJSCallback(jsCallback);
  16. }
  17. });
  18. // 因此当你需要通过内部页面交互 WebView 时,
  19. // 应当设置内部页面 url 为:TestKey://(后面你想要回调到 WebView 的数据)
  20. // WebView 内部页面代码
  21. <html>
  22. <body>
  23. <dev>
  24. <input type="button" value="触发" onclick="onClick()"/>
  25. </dev>
  26. </body>
  27. <script>
  28. function onClick (){
  29. // 其中一个设置URL方案
  30. document.location ='TestKey://{a: 0, b: 1}';
  31. }
  32. </script>
  33. </html>

由于 Web 平台的限制,导致无法通过这种机制去实现,但是内部页面可以通过以下方式进行交互。

  1. // WebView 内部页面代码
  2. <html>
  3. <body>
  4. <dev>
  5. <input type="button" value="触发" onclick="onClick()"/>
  6. </dev>
  7. </body>
  8. <script>
  9. function onClick (){
  10. // 这里的 parent 其实就是外部的 window
  11. // 这样一来就可以访问到定义在 cc 的函数了
  12. parent.cc.TestCode();
  13. // 如果 TestCode 是定义在 window 上,则
  14. parent.TestCode();
  15. }
  16. </script>
  17. </html>

再强调一遍: Web 平台上的跨域问题需要自行解决