extra-game-loop 0.3.2 → 0.3.4

package/README.md

@@ -45,7 +45,11 @@ class GameLoop<FixedDeltaTime extends number = number> {
 
   start(): void
   stop(): void
-
   getFramesOfSecond(): number
+
+  /**
+   * This method allows you to manually advance to the next frame.
+   */
+  nextFrame(deltaTime: number): void
 }
 ```

package/lib/{es2015/game-loop.d.ts → game-loop.d.ts}

@@ -23,6 +23,6 @@ export declare class GameLoop<FixedDeltaTime extends number> {
     stop(): void;
     getFramesOfSecond(): number;
     private loop;
-    private nextFrame;
+    nextFrame(deltaTime: number): void;
 }
 export {};

package/lib/game-loop.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"game-loop.js","sourceRoot":"","sources":["../src/game-loop.ts"],"names":[],"mappings":";;;AAAA,yCAAyE;AACzE,iDAA4C;AAwC5C,IAAK,KAGJ;AAHD,WAAK,KAAK;IACR,4BAAmB,CAAA;IACnB,4BAAmB,CAAA;AACrB,CAAC,EAHI,KAAK,KAAL,KAAK,QAGT;AAMD,MAAM,MAAM,GAA4C;IACtD,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE;IACzC,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,OAAO,EAAE;CACzC,CAAA;AAED,MAAa,QAAQ;IAanB,YAAY,OAAyC;QAZpC,QAAG,GAAG,IAAI,8BAAkB,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,CAAA;QAS5D,yBAAoB,GAAG,CAAC,CAAA;QACxB,kBAAa,GAAG,CAAC,CAAA;QA2CjB,SAAI,GAAG,GAAS,EAAE;YAIxB,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAA;YACnC,MAAM,SAAS,GAAG,SAAS,GAAG,IAAI,CAAC,aAAc,CAAA;YACjD,IAAI,CAAC,aAAa,GAAG,SAAS,CAAA;YAC9B,IAAI,CAAC,aAAa,GAAG,SAAS,CAAA;YAE9B,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAA;YAEzB,IAAI,CAAC,QAAQ,GAAG,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAClD,CAAC,CAAA;QApDC,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAA;QAC5C,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAA;QAChD,IAAA,gBAAM,EACJ,IAAI,CAAC,gBAAgB,IAAI,IAAI,CAAC,cAAc,EAC5C,kEAAkE,CACnE,CAAA;QAED,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAA;QAC5B,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAA;QACtC,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAA;QACpC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAA;IAC9B,CAAC;IAED,KAAK;QACH,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAEtB,IAAI,CAAC,aAAa,GAAG,WAAW,CAAC,GAAG,EAAE,CAAA;QACtC,IAAI,CAAC,IAAI,EAAE,CAAA;IACb,CAAC;IAED,IAAI;QACF,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAErB,oBAAoB,CAAC,IAAI,CAAC,QAAS,CAAC,CAAA;QAEpC,OAAO,IAAI,CAAC,QAAQ,CAAA;QACpB,OAAO,IAAI,CAAC,aAAa,CAAA;QACzB,IAAI,CAAC,aAAa,GAAG,CAAC,CAAA;IACxB,CAAC;IAED,iBAAiB;QACf,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE;YACnC,OAAO,IAAI,CAAC,aAAa,KAAK,CAAC;gBAC1B,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,aAAa;gBAC3B,CAAC,CAAC,CAAC,CAAA;SACT;aAAM;YACL,OAAO,CAAC,CAAA;SACT;IACH,CAAC;IAuBD,SAAS,CAAC,SAAiB;QACzB,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,GAAG,CAClC,IAAI,CAAC,oBAAoB,GAAG,SAAS,EACrC,IAAI,CAAC,gBAAgB,CACtB,CAAA;QAED,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;QAEtB,OAAO,IAAI,CAAC,oBAAoB,IAAI,IAAI,CAAC,cAAc,EAAE;YACvD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;YACrC,IAAI,CAAC,oBAAoB,IAAI,IAAI,CAAC,cAAc,CAAA;SACjD;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,cAAc,CAAA;QAC7D,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;QACjC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IACpB,CAAC;CACF;AA5FD,4BA4FC"}

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA2B"}

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "extra-game-loop",
-  "version": "0.3.2",
+  "version": "0.3.4",
   "description": "",
   "keywords": [],
   "files": [
     "lib",
-    "dist"
+    "src"
   ],
-  "main": "lib/es2018/index.js",
-  "types": "lib/es2018/index.d.ts",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "sideEffects": false,
   "repository": "git@github.com:BlackGlory/extra-game-loop.git",
   "author": "BlackGlory <woshenmedoubuzhidao@blackglory.me>",
@@ -18,18 +18,11 @@
     "test": "jest --runInBand --config jest.config.js",
     "test:debug": "node --inspect-brk node_modules/.bin/jest --runInBand",
     "test:coverage": "jest --coverage --config jest.config.js",
-    "prepublishOnly": "run-s clean build bundle",
-    "clean": "run-p clean:*",
-    "clean:build": "rimraf lib",
-    "clean:bundle": "rimraf dist",
-    "build": "run-p build:*",
-    "build:es2015": "run-s build:es2015:*",
-    "build:es2015:compile": "tsc --project tsconfig.build.json --module commonjs --target es2015 --outDir lib/es2015",
-    "build:es2015:patch": "tscpaths -p tsconfig.build.json -s ./src -o ./lib/es2015",
-    "build:es2018": "run-s build:es2018:*",
-    "build:es2018:compile": "tsc --project tsconfig.build.json --module commonjs --target es2018 --outDir lib/es2018",
-    "build:es2018:patch": "tscpaths -p tsconfig.build.json -s ./src -o ./lib/es2018",
-    "bundle": "rollup --config rollup.config.js",
+    "prepublishOnly": "run-s clean build",
+    "clean": "rimraf lib",
+    "build": "run-s build:*",
+    "build:compile": "tsc --project tsconfig.build.json --module commonjs --target es2018 --outDir lib",
+    "build:patch": "tscpaths -p tsconfig.build.json -s ./src -o ./lib",
     "release": "standard-version"
   },
   "husky": {
@@ -39,14 +32,8 @@
     }
   },
   "devDependencies": {
-    "@blackglory/jest-matchers": "^0.3.1",
     "@commitlint/cli": "^17.1.2",
     "@commitlint/config-conventional": "^17.1.0",
-    "@rollup/plugin-commonjs": "^22.0.2",
-    "@rollup/plugin-json": "^4.1.0",
-    "@rollup/plugin-node-resolve": "^14.1.0",
-    "@rollup/plugin-replace": "^4.0.0",
-    "@rollup/plugin-typescript": "^8.5.0",
     "@types/jest": "^27.4.1",
     "@typescript-eslint/eslint-plugin": "^5.37.0",
     "@typescript-eslint/parser": "^5.37.0",
@@ -57,9 +44,6 @@
     "jest": "^27.5.1",
     "npm-run-all": "^4.1.5",
     "rimraf": "^3.0.2",
-    "rollup": "^2.79.0",
-    "rollup-plugin-analyzer": "^4.0.0",
-    "rollup-plugin-terser": "^7.0.2",
     "standard-version": "^9.5.0",
     "ts-jest": "^27.1.4",
     "tscpaths": "^0.0.9",

package/src/game-loop.ts

@@ -0,0 +1,148 @@
+import { FiniteStateMachine, IFiniteStateMachineSchema } from 'extra-fsm'
+import { assert } from '@blackglory/prelude'
+
+interface IGameLoopOptions<FixedDeltaTime extends number = number> {
+  /**
+   * 物理帧一帧经过的时间, 可以通过`1000/fps`得来, 或物理引擎指示的最小deltaTime.
+   */
+  fixedDeltaTime: FixedDeltaTime
+
+  /**
+   * 将渲染帧的deltaTime拆分成物理帧时, 允许的最大渲染帧deltaTime,
+   * 如果实际的渲染帧deltaTime超过此值, 则它会被重置为此值.
+   * 这可以在性能较差的设备上解决因物理帧执行需要带时间过长而导致渲染帧率无限下降的"死亡螺旋"问题.
+   */
+  maximumDeltaTime: number
+
+  /**
+   * 每帧运行一次, 运行早于fixedUpdate.
+   * 在此处理用户输入等与物理计算无关的操作, 在update里改变的状态直到下一物理帧时才会反应.
+   */
+  update: (deltaTime: number) => void
+
+  /**
+   * 每物理帧运行一次, 运行晚于update, 早于lateUpdate.
+   * deltaTime固定等于fixedDeltaTime.
+   * 一帧中可能运行零次, 一次, 或数十次, 不应在此处理物理计算以外的繁重操作.
+   */
+  fixedUpdate: (deltaTime: FixedDeltaTime) => void
+
+  /**
+   * 每帧运行一次, 运行晚于fixedUpdate, 能获得alpha.
+   * 出于各种原因, 你可能会想使用它.
+   */
+  lateUpdate: (deltaTime: number, alpha: number) => void
+
+  /**
+   * 每帧运行一次, 总是运行在fixedUpdate和udpate之后.
+   */
+  render: (alpha: number) => void
+}
+
+enum State {
+  Stopped = 'stopped'
+, Running = 'running'
+}
+
+type Event =
+| 'start'
+| 'stop'
+
+const schema: IFiniteStateMachineSchema<State, Event> = {
+  [State.Stopped]: { start: State.Running }
+, [State.Running]: { stop: State.Stopped }
+}
+
+export class GameLoop<FixedDeltaTime extends number> {
+  private readonly fsm = new FiniteStateMachine(schema, State.Stopped)
+  private readonly fixedDeltaTime: FixedDeltaTime
+  private readonly maximumDeltaTime: number
+  private readonly update: (deltaTime: number) => void
+  private readonly fixedUpdate: (fixedDeltaTime: FixedDeltaTime) => void
+  private readonly lateUpdate: (deltaTime: number, alpha: number) => void
+  private readonly render: (alpha: number) => void
+  private requstId?: number
+  private lastTimestamp?: number
+  private deltaTimeAccumulator = 0
+  private lastDeltaTime = 0
+
+  constructor(options: IGameLoopOptions<FixedDeltaTime>) {
+    this.fixedDeltaTime = options.fixedDeltaTime
+    this.maximumDeltaTime = options.maximumDeltaTime
+    assert(
+      this.maximumDeltaTime >= this.fixedDeltaTime
+    , 'maximumDeltaTime must be greater than or equal to fixedDeltaTime'
+    )
+
+    this.update = options.update
+    this.fixedUpdate = options.fixedUpdate
+    this.lateUpdate = options.lateUpdate
+    this.render = options.render
+  }
+
+  start(): void {
+    this.fsm.send('start')
+
+    this.lastTimestamp = performance.now()
+    this.loop()
+  }
+
+  stop(): void {
+    this.fsm.send('stop')
+
+    cancelAnimationFrame(this.requstId!)
+
+    delete this.requstId
+    delete this.lastTimestamp
+    this.lastDeltaTime = 0
+  }
+
+  getFramesOfSecond(): number {
+    if (this.fsm.matches(State.Running)) {
+      return this.lastDeltaTime !== 0
+           ? 1000 / this.lastDeltaTime
+           : 0
+    } else {
+      return 0
+    }
+  }
+
+  private loop = (): void => {
+    // requestAnimationFrame的实现存在陷阱, 它提供的timestamp参数有时会比`performance.now()`早.
+    // 因此主动调用`performance.now()`来获取时间戳.
+    // https://stackoverflow.com/questions/50895206/exact-time-of-display-requestanimationframe-usage-and-timeline
+    const timestamp = performance.now()
+    const deltaTime = timestamp - this.lastTimestamp!
+    this.lastDeltaTime = deltaTime
+    this.lastTimestamp = timestamp
+
+    this.nextFrame(deltaTime)
+
+    this.requstId = requestAnimationFrame(this.loop)
+  }
+
+  /**
+   * nextFrameUpdateFirst依序做以下几件事:
+   * 1. 响应用户输入, 为这一帧的游戏世界做出非物理方面的更新, 例如角色转向, 改变武器瞄准角度等.
+   * 2. 响应游戏世界从上一帧更新后到这一帧更新之前发生的物理变化.
+   *    注意, 如果渲染帧率比物理帧率快, 且运行性能良好, 则物理帧不一定会在此帧更新.
+   * 3. 渲染经过更新后的最新状态, 渲染器可以根据alpha参数执行插值渲染.
+   */
+  nextFrame(deltaTime: number): void {
+    this.deltaTimeAccumulator = Math.min(
+      this.deltaTimeAccumulator + deltaTime
+    , this.maximumDeltaTime
+    )
+
+    this.update(deltaTime)
+
+    while (this.deltaTimeAccumulator >= this.fixedDeltaTime) {
+      this.fixedUpdate(this.fixedDeltaTime)
+      this.deltaTimeAccumulator -= this.fixedDeltaTime
+    }
+
+    const alpha = this.deltaTimeAccumulator / this.fixedDeltaTime
+    this.lateUpdate(deltaTime, alpha)
+    this.render(alpha)
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from './game-loop'