README.md

open-game

npm i open-game --save

Examples

• Flappy bird

Table of Contents

• Actor
  • Parameters
  • reset
  • update
  • render
  • aabb
    • Parameters
  • isItOn
    • Parameters
  • isOut
• Game
  • Parameters
  • reset
  • init
    • Parameters
  • progress
    • Parameters
  • loadResources
    • Parameters
  • drawImageAlignCenterByName
    • Parameters
  • drawImageByName
    • Parameters
  • registCallback
    • Parameters
• Scene
  • Parameters
  • update
  • render
  • enter
  • click
    • Parameters

Actor

Actor 类

Parameters

• game Game 游戏实例
• size

Returns Actor Instance

reset

重置参数值

Returns void

update

更新参数值

Returns void

render

渲染自己

Returns void

aabb

碰撞判断

Parameters

• x
• y
• w
• h
• target Actor

Returns boolean

isItOn

给定一组 x, y判断是否在角色身上

Parameters

• cX
• cY

Returns boolean

isOut

判断是否已经出去在画布之外

Returns boolean

Game

Game 类

Parameters

• canvas Object DOM对象，或者node.js 下 require('canvas').createCanvas()
• Image Function 图片构造函数，浏览器下为 window.Image, node.js 下为 require('canvas').Image
• width Number 期望的画布宽度，浏览器下全拼为 document.documentElement.clientWidth
• height Number 期望的画布高度，浏览器下全拼为 document.documentElement.clientHeight
• widthRange [Number]? 画布宽度取值范围，不设置则宽度严格等于 width
• heightRange [Number]? 画布高度取值范围，不设置则宽度严格等于 heigth

reset

重置游戏参数, 例如积分

Returns void

init

初始化并开始游戏

Parameters

• resources Array.Object 游戏所需静态资源对象 key => value 格式， key 为资源名称，value为object，格式如下 { type: 'image', // audio, video, image name: 'name', // 资源名称，预加载后会存入 this.R 方便随时获取 url: 'https://urladress/', // 资源地址 map: 'https://urladress/' // 图片资源对应的定位信息文件, 仅 type = image 有效 }

Returns void

progress

显示资源加载 loading 效果

Parameters

• percent
• resources Array.URL 游戏所需静态资源url列表

Returns void

loadResources

加载游戏所需静态资源

Parameters

• resources Array.Object 游戏所需静态资源对象 key => value 格式， key 为资源名称，value为object，格式如下 { type: 'image', // audio, video, image name: 'name', // 资源名称，预加载后会存入 this.R 方便随时获取 url: 'https://urladress/', // 资源地址 map: 'https://urladress/' // 图片资源对应的定位信息文件, 仅 type = image 有效 }

Returns void

drawImageAlignCenterByName

水平居中绘制图片获取图片切片

Parameters

• name string 图片名称
• y number 在画布上的y坐标

Returns void

drawImageByName

绘制图片获取图片切片

Parameters

• name string 图片名称
• x number 在画布上的x坐标
• y number 在画布上的y坐标

Returns void

registCallback

注册帧回调函数

Parameters

• frames number 多少帧之后
• handler function 执行的事件函数

Returns void

Scene

Scene 类

Parameters

• game Game 游戏实例
• name

Returns Scene Instance

update

更新各成员

Returns void

render

渲染各成员

Returns void

enter

进入场景

Returns void

click

点击事件

Parameters

• x
• y

Returns void