A fast 2D and 3D game engine — TypeScript SDK, C++/WebAssembly core, visual editor. Ship one project to web, desktop, WeChat MiniGames, playable ads, and native Android / iOS.
TypeScript 2d-game-engine3d3d-game-engineandroidcppecsgame-editorgame-enginegamedeviostypescriptwebassemblywebglwebgpuwechat-minigame
refactor(examples): modernize platformer to engine-native systems
esengine6cd6ebc3be88
diff --git a/examples/platformer/assets/prefabs/Coin.esprefab b/examples/platformer/assets/prefabs/Coin.esprefabnew file mode 100644index 000000000..41f4104c0--- /dev/null+++ b/examples/platformer/assets/prefabs/Coin.esprefab@@ -0,0 +1,21 @@+{+ "version": "2",+ "name": "Coin",+ "rootEntityId": "0",+ "entities": [+ {+ "prefabEntityId": "0",+ "name": "Coin",+ "parent": null,+ "children": [],+ "components": [+ { "type": "Transform", "data": { "position": { "x": 0, "y": 0, "z": 0 } } },+ { "type": "Sprite", "data": { "size": { "x": 24, "y": 24 }, "color": { "r": 1, "g": 0.85, "b": 0, "a": 1 }, "texture": "@uuid:c18959bd-f6be-49d3-945b-3d6ecf8ef14f" } },+ { "type": "Coin", "data": { "baseY": 0, "bobTimer": 0 } },+ { "type": "RigidBody", "data": { "bodyType": 0 } },+ { "type": "BoxCollider", "data": { "halfExtents": { "x": 0.12, "y": 0.12 }, "isSensor": true, "categoryBits": 2, "maskBits": 65535 } }+ ],+ "visible": true+ }+ ]+}diff --git a/examples/platformer/assets/prefabs/Coin.esprefab.meta b/examples/platformer/assets/prefabs/Coin.esprefab.metanew file mode 100644index 000000000..06d23ca6a--- /dev/null+++ b/examples/platformer/assets/prefabs/Coin.esprefab.meta@@ -0,0 +1,8 @@+{+ "uuid": "57ad3eb0-4a0c-49b5-bfba-c98418989915",+ "version": "2.0",+ "type": "prefab",+ "importer": {+ "autoMigrate": true+ }+}diff --git a/examples/platformer/assets/scenes/main.esscene b/examples/platformer/assets/scenes/main.essceneindex f38a3c4d2..2c7478ad7 100644--- a/examples/platformer/assets/scenes/main.esscene+++ b/examples/platformer/assets/scenes/main.esscene@@ -1,6 +1,7 @@{"version": "1.0","name": "Main",+ "folders": ["Environment", "Platforms", "Coins", "UI"],"entities": [{"id": 0,@@ -18,9 +19,10 @@"name": "Sky","parent": null,"children": [],+ "folder": "Environment","components": [- { "type": "Transform", "data": { "position": { "x": 0, "y": 0, "z": -1 } } },- { "type": "Sprite", "data": { "size": { "x": 800, "y": 700 }, "texture": "@uuid:74b832b1-40ae-4095-a620-c027735cb482" } }+ { "type": "Transform", "data": { "position": { "x": 0, "y": 0, "z": 0 } } },+ { "type": "Sprite", "data": { "size": { "x": 800, "y": 700 }, "texture": "@uuid:74b832b1-40ae-4095-a620-c027735cb482", "layer": -10 } }],"visible": true},@@ -29,10 +31,12 @@"name": "Ground","parent": null,"children": [],+ "folder": "Environment","components": [{ "type": "Transform", "data": { "position": { "x": 0, "y": -250, "z": 0 } } },{ "type": "Sprite", "data": { "size": { "x": 800, "y": 40 }, "color": { "r": 0.4, "g": 0.7, "b": 0.3, "a": 1 }, "texture": "@uuid:931ebe66-cded-4b32-8444-0737da446c0d" } },- { "type": "Platform", "data": { "width": 800, "height": 40 } }+ { "type": "RigidBody", "data": { "bodyType": 0 } },+ { "type": "BoxCollider", "data": { "halfExtents": { "x": 4.0, "y": 0.2 }, "categoryBits": 1, "maskBits": 65535 } }],"visible": true},@@ -41,10 +45,12 @@"name": "Platform1","parent": null,"children": [],+ "folder": "Platforms","components": [{ "type": "Transform", "data": { "position": { "x": -200, "y": -120, "z": 0 } } },{ "type": "Sprite", "data": { "size": { "x": 160, "y": 24 }, "color": { "r": 0.6, "g": 0.5, "b": 0.3, "a": 1 }, "texture": "@uuid:0258e55e-9aa0-47eb-8092-7386e03f97c7" } },- { "type": "Platform", "data": { "width": 160, "height": 24 } }+ { "type": "RigidBody", "data": { "bodyType": 0 } },+ { "type": "BoxCollider", "data": { "halfExtents": { "x": 0.8, "y": 0.12 }, "categoryBits": 1, "maskBits": 65535 } }],"visible": true},@@ -53,10 +59,12 @@"name": "Platform2","parent": null,"children": [],+ "folder": "Platforms","components": [{ "type": "Transform", "data": { "position": { "x": 100, "y": -20, "z": 0 } } },{ "type": "Sprite", "data": { "size": { "x": 160, "y": 24 }, "color": { "r": 0.6, "g": 0.5, "b": 0.3, "a": 1 }, "texture": "@uuid:0258e55e-9aa0-47eb-8092-7386e03f97c7" } },- { "type": "Platform", "data": { "width": 160, "height": 24 } }+ { "type": "RigidBody", "data": { "bodyType": 0 } },+ { "type": "BoxCollider", "data": { "halfExtents": { "x": 0.8, "y": 0.12 }, "categoryBits": 1, "maskBits": 65535 } }],"visible": true},@@ -65,10 +73,12 @@"name": "Platform3","parent": null,"children": [],+ "folder": "Platforms","components": [{ "type": "Transform", "data": { "position": { "x": -80, "y": 100, "z": 0 } } },{ "type": "Sprite", "data": { "size": { "x": 200, "y": 24 }, "color": { "r": 0.6, "g": 0.5, "b": 0.3, "a": 1 }, "texture": "@uuid:0258e55e-9aa0-47eb-8092-7386e03f97c7" } },- { "type": "Platform", "data": { "width": 200, "height": 24 } }+ { "type": "RigidBody", "data": { "bodyType": 0 } },+ { "type": "BoxCollider", "data": { "halfExtents": { "x": 1.0, "y": 0.12 }, "categoryBits": 1, "maskBits": 65535 } }],"visible": true},@@ -77,91 +87,151 @@"name": "Platform4","parent": null,"children": [],+ "folder": "Platforms","components": [{ "type": "Transform", "data": { "position": { "x": 220, "y": 180, "z": 0 } } },{ "type": "Sprite", "data": { "size": { "x": 140, "y": 24 }, "color": { "r": 0.6, "g": 0.5, "b": 0.3, "a": 1 }, "texture": "@uuid:0258e55e-9aa0-47eb-8092-7386e03f97c7" } },- { "type": "Platform", "data": { "width": 140, "height": 24 } }+ { "type": "RigidBody", "data": { "bodyType": 0 } },+ { "type": "BoxCollider", "data": { "halfExtents": { "x": 0.7, "y": 0.12 }, "categoryBits": 1, "maskBits": 65535 } }],"visible": true},{- "id": 6,- "name": "Player",+ "id": 16,+ "name": "LeftWall","parent": null,"children": [],+ "folder": "Environment","components": [- { "type": "Transform", "data": { "position": { "x": -200, "y": -200, "z": 0 } } },- { "type": "Sprite", "data": { "size": { "x": 32, "y": 48 }, "color": { "r": 0.2, "g": 0.6, "b": 1, "a": 1 }, "texture": "@uuid:2bde6b7d-0dbe-4434-9e30-ed1cd8e3fe82" } },- { "type": "Player", "data": {} }+ { "type": "Transform", "data": { "position": { "x": -420, "y": 0, "z": 0 } } },+ { "type": "RigidBody", "data": { "bodyType": 0 } },+ { "type": "BoxCollider", "data": { "halfExtents": { "x": 0.1, "y": 4.0 }, "categoryBits": 1, "maskBits": 65535 } }],"visible": true},{- "id": 7,- "name": "Coin1",+ "id": 17,+ "name": "RightWall","parent": null,"children": [],+ "folder": "Environment","components": [- { "type": "Transform", "data": { "position": { "x": -200, "y": -80, "z": 0 } } },- { "type": "Sprite", "data": { "size": { "x": 24, "y": 24 }, "color": { "r": 1, "g": 0.85, "b": 0, "a": 1 }, "texture": "@uuid:c18959bd-f6be-49d3-945b-3d6ecf8ef14f" } },- { "type": "Coin", "data": { "baseY": -80, "bobTimer": 0 } }+ { "type": "Transform", "data": { "position": { "x": 420, "y": 0, "z": 0 } } },+ { "type": "RigidBody", "data": { "bodyType": 0 } },+ { "type": "BoxCollider", "data": { "halfExtents": { "x": 0.1, "y": 4.0 }, "categoryBits": 1, "maskBits": 65535 } }],"visible": true},{- "id": 8,- "name": "Coin2",+ "id": 6,+ "name": "Player","parent": null,"children": [],"components": [- { "type": "Transform", "data": { "position": { "x": 100, "y": 20, "z": 0 } } },- { "type": "Sprite", "data": { "size": { "x": 24, "y": 24 }, "color": { "r": 1, "g": 0.85, "b": 0, "a": 1 }, "texture": "@uuid:c18959bd-f6be-49d3-945b-3d6ecf8ef14f" } },- { "type": "Coin", "data": { "baseY": 20, "bobTimer": 0 } }+ { "type": "Transform", "data": { "position": { "x": -200, "y": -180, "z": 0 } } },+ { "type": "Sprite", "data": { "size": { "x": 32, "y": 48 }, "color": { "r": 0.2, "g": 0.6, "b": 1, "a": 1 }, "texture": "@uuid:2bde6b7d-0dbe-4434-9e30-ed1cd8e3fe82", "layer": 1 } },+ { "type": "Player", "data": {} },+ { "type": "RigidBody", "data": { "bodyType": 1 } },+ { "type": "BoxCollider", "data": { "halfExtents": { "x": 0.16, "y": 0.24 }, "categoryBits": 1, "maskBits": 65535 } },+ { "type": "CharacterController", "data": { "maskBits": 65533 } }],"visible": true},+ {+ "id": 7,+ "name": "Coin1",+ "parent": null,+ "folder": "Coins",+ "prefab": "@uuid:57ad3eb0-4a0c-49b5-bfba-c98418989915",+ "overrides": [+ { "prefabEntityId": "0", "type": "property", "componentType": "Transform", "propertyName": "position", "value": { "x": -200, "y": -80, "z": 0 } },+ { "prefabEntityId": "0", "type": "property", "componentType": "Coin", "propertyName": "baseY", "value": -80 }+ ],+ "added": [],+ "removed": []+ },+ {+ "id": 8,+ "name": "Coin2",+ "parent": null,+ "folder": "Coins",+ "prefab": "@uuid:57ad3eb0-4a0c-49b5-bfba-c98418989915",+ "overrides": [+ { "prefabEntityId": "0", "type": "property", "componentType": "Transform", "propertyName": "position", "value": { "x": 100, "y": 20, "z": 0 } },+ { "prefabEntityId": "0", "type": "property", "componentType": "Coin", "propertyName": "baseY", "value": 20 }+ ],+ "added": [],+ "removed": []+ },{"id": 9,"name": "Coin3","parent": null,- "children": [],- "components": [- { "type": "Transform", "data": { "position": { "x": -80, "y": 140, "z": 0 } } },- { "type": "Sprite", "data": { "size": { "x": 24, "y": 24 }, "color": { "r": 1, "g": 0.85, "b": 0, "a": 1 }, "texture": "@uuid:c18959bd-f6be-49d3-945b-3d6ecf8ef14f" } },- { "type": "Coin", "data": { "baseY": 140, "bobTimer": 0 } }+ "folder": "Coins",+ "prefab": "@uuid:57ad3eb0-4a0c-49b5-bfba-c98418989915",+ "overrides": [+ { "prefabEntityId": "0", "type": "property", "componentType": "Transform", "propertyName": "position", "value": { "x": -80, "y": 140, "z": 0 } },+ { "prefabEntityId": "0", "type": "property", "componentType": "Coin", "propertyName": "baseY", "value": 140 }],- "visible": true+ "added": [],+ "removed": []},{"id": 10,"name": "Coin4","parent": null,- "children": [],- "components": [- { "type": "Transform", "data": { "position": { "x": 220, "y": 220, "z": 0 } } },- { "type": "Sprite", "data": { "size": { "x": 24, "y": 24 }, "color": { "r": 1, "g": 0.85, "b": 0, "a": 1 }, "texture": "@uuid:c18959bd-f6be-49d3-945b-3d6ecf8ef14f" } },- { "type": "Coin", "data": { "baseY": 220, "bobTimer": 0 } }+ "folder": "Coins",+ "prefab": "@uuid:57ad3eb0-4a0c-49b5-bfba-c98418989915",+ "overrides": [+ { "prefabEntityId": "0", "type": "property", "componentType": "Transform", "propertyName": "position", "value": { "x": 220, "y": 220, "z": 0 } },+ { "prefabEntityId": "0", "type": "property", "componentType": "Coin", "propertyName": "baseY", "value": 220 }],- "visible": true+ "added": [],+ "removed": []},{"id": 11,"name": "Coin5","parent": null,- "children": [],- "components": [- { "type": "Transform", "data": { "position": { "x": 0, "y": -200, "z": 0 } } },- { "type": "Sprite", "data": { "size": { "x": 24, "y": 24 }, "color": { "r": 1, "g": 0.85, "b": 0, "a": 1 }, "texture": "@uuid:c18959bd-f6be-49d3-945b-3d6ecf8ef14f" } },- { "type": "Coin", "data": { "baseY": -200, "bobTimer": 0 } }+ "folder": "Coins",+ "prefab": "@uuid:57ad3eb0-4a0c-49b5-bfba-c98418989915",+ "overrides": [+ { "prefabEntityId": "0", "type": "property", "componentType": "Transform", "propertyName": "position", "value": { "x": 0, "y": -200, "z": 0 } },+ { "prefabEntityId": "0", "type": "property", "componentType": "Coin", "propertyName": "baseY", "value": -200 }],- "visible": true+ "added": [],+ "removed": []},{"id": 12,- "name": "ScoreDisplay",+ "name": "UICanvas","parent": null,+ "children": [14],+ "folder": "UI",+ "components": [+ { "type": "Transform", "data": {} },+ { "type": "Canvas", "data": { "designResolution": { "x": 800, "y": 600 }, "scaleMode": 2 } },+ { "type": "UINode", "data": {} }+ ],+ "visible": true+ },+ {+ "id": 14,+ "name": "ScoreText",+ "parent": 12,"children": [],"components": [+ { "type": "Transform", "data": {} },+ { "type": "UINode", "data": {+ "position": 1,+ "width": { "value": 300.0, "unit": 0 },+ "height": { "value": 40.0, "unit": 0 },+ "insetLeft": { "value": 0.0, "unit": 1 },+ "marginLeft": { "value": 24.0, "unit": 0 },+ "insetTop": { "value": 0.0, "unit": 1 },+ "marginTop": { "value": 20.0, "unit": 0 }+ } },+ { "type": "Text", "data": { "content": "Score: 0", "fontSize": 28, "color": { "r": 1, "g": 1, "b": 1, "a": 1 }, "align": 0, "verticalAlign": 1 } },{ "type": "ScoreDisplay", "data": { "score": 0 } }],"visible": truediff --git a/examples/platformer/project.esproject b/examples/platformer/project.esprojectindex 0f2e135ec..3388a1a83 100644--- a/examples/platformer/project.esproject+++ b/examples/platformer/project.esproject@@ -9,5 +9,10 @@"width": 800,"height": 600},- "spineVersion": "none"+ "spineVersion": "none",+ "features": {+ "physics": {+ "enabled": true+ }+ }}diff --git a/examples/platformer/src/components.ts b/examples/platformer/src/components.tsindex 3e5eb43d7..8724fd70b 100644--- a/examples/platformer/src/components.ts+++ b/examples/platformer/src/components.ts@@ -1,10 +1,8 @@import { defineComponent } from 'esengine';export const Player = defineComponent('Player', {- speed: 300,- jumpForce: 600,- velocityY: 0,- isGrounded: false,+ speed: 320,+ jumpForce: 640,});export const Coin = defineComponent('Coin', {@@ -15,8 +13,3 @@ export const Coin = defineComponent('Coin', {export const ScoreDisplay = defineComponent('ScoreDisplay', {score: 0,});--export const Platform = defineComponent('Platform', {- width: 0,- height: 0,-});diff --git a/examples/platformer/src/main.ts b/examples/platformer/src/main.tsindex ee183861b..2bcee1ebe 100644--- a/examples/platformer/src/main.ts+++ b/examples/platformer/src/main.ts@@ -2,7 +2,10 @@ import { addSystemToSchedule, Schedule } from 'esengine';import './components';import { playerSystem } from './systems/player';-import { coinSystem } from './systems/coin';+import { coinBobSystem, coinPickupSystem } from './systems/coin';+import { scoreSystem } from './systems/score';-addSystemToSchedule(Schedule.Update, playerSystem);-addSystemToSchedule(Schedule.Update, coinSystem);+addSystemToSchedule(Schedule.FixedPreUpdate, playerSystem);+addSystemToSchedule(Schedule.FixedPostUpdate, coinPickupSystem);+addSystemToSchedule(Schedule.Update, coinBobSystem);+addSystemToSchedule(Schedule.Update, scoreSystem);diff --git a/examples/platformer/src/systems/coin.ts b/examples/platformer/src/systems/coin.tsindex 98ba0f802..1daf24d8f 100644--- a/examples/platformer/src/systems/coin.ts+++ b/examples/platformer/src/systems/coin.ts@@ -1,48 +1,36 @@import {defineSystem, Query, Mut, Res, Time, Transform, Commands,+ PhysicsEvents,} from 'esengine';-import { Coin, Player, ScoreDisplay } from '../components';+import { Coin, ScoreDisplay } from '../components';-const COLLECT_DISTANCE = 30;const BOB_SPEED = 3;const BOB_AMOUNT = 6;-export const coinSystem = defineSystem(- [- Query(Mut(Transform), Mut(Coin)),- Query(Transform, Player),- Query(Mut(ScoreDisplay)),- Res(Time),- Commands(),- ],- (coins, players, scores, time, cmds) => {- let playerX = 0;- let playerY = 0;- let hasPlayer = false;-- for (const [_entity, t, _p] of players) {- playerX = t.position.x;- playerY = t.position.y;- hasPlayer = true;- }-- for (const [entity, transform, coin] of coins) {+export const coinBobSystem = defineSystem(+ [Query(Mut(Transform), Mut(Coin)), Res(Time)],+ (coins, time) => {+ for (const [_entity, transform, coin] of coins) {coin.bobTimer += time.delta * BOB_SPEED;transform.position.y = coin.baseY + Math.sin(coin.bobTimer) * BOB_AMOUNT;+ }+ },+ { name: 'CoinBobSystem' }+);- if (hasPlayer) {- const dx = transform.position.x - playerX;- const dy = transform.position.y - playerY;- const dist = Math.sqrt(dx * dx + dy * dy);-- if (dist < COLLECT_DISTANCE) {- cmds.despawn(entity);- for (const [_e, score] of scores) {- score.score += 1;- }- }+export const coinPickupSystem = defineSystem(+ [Res(PhysicsEvents), Query(Coin), Query(Mut(ScoreDisplay)), Commands()],+ (events, coins, scores, cmds) => {+ for (const ev of events.sensorEnters) {+ let isCoin = false;+ for (const [coinEntity] of coins) {+ if (coinEntity === ev.sensorEntity) { isCoin = true; break; }}+ if (!isCoin) continue;++ cmds.despawn(ev.sensorEntity);+ for (const [_entity, score] of scores) score.score += 1;}},- { name: 'CoinSystem' }+ { name: 'CoinPickupSystem' });diff --git a/examples/platformer/src/systems/player.ts b/examples/platformer/src/systems/player.tsindex 2a58bd9a0..a4b8d9a14 100644--- a/examples/platformer/src/systems/player.ts+++ b/examples/platformer/src/systems/player.ts@@ -1,60 +1,27 @@import {- defineSystem, Query, Mut, Res, Time, Transform, Input,+ defineSystem, Query, Mut, Res, Time, Input,+ CharacterController,} from 'esengine';-import { Player, Platform } from '../components';+import { Player } from '../components';-const GRAVITY = -1200;-const PLAYER_HALF_W = 16;-const PLAYER_HALF_H = 24;+const GRAVITY = -1600;export const playerSystem = defineSystem(- [Query(Mut(Transform), Mut(Player)), Query(Transform, Platform), Res(Time), Res(Input)],- (players, platforms, time, input) => {- for (const [_entity, transform, player] of players) {+ [Query(Mut(CharacterController), Player), Res(Time), Res(Input)],+ (players, time, input) => {+ for (const [_entity, cc, player] of players) {let moveX = 0;- if (input.isKeyDown('ArrowLeft') || input.isKeyDown('KeyA')) {- moveX = -1;- }- if (input.isKeyDown('ArrowRight') || input.isKeyDown('KeyD')) {- moveX = 1;- }+ if (input.isKeyDown('ArrowLeft') || input.isKeyDown('KeyA')) moveX -= 1;+ if (input.isKeyDown('ArrowRight') || input.isKeyDown('KeyD')) moveX += 1;+ cc.velocity.x = moveX * player.speed;- transform.position.x += moveX * player.speed * time.delta;+ // Gravity accumulates every fixed step; move-and-slide zeroes it on landing.+ cc.velocity.y += GRAVITY * time.fixedDelta;- player.velocityY += GRAVITY * time.delta;- transform.position.y += player.velocityY * time.delta;-- player.isGrounded = false;-- for (const [_e, platTransform, plat] of platforms) {- const px = platTransform.position.x;- const py = platTransform.position.y;- const platHalfW = plat.width / 2;- const platHalfH = plat.height / 2;-- const overlapX = Math.abs(transform.position.x - px) < platHalfW + PLAYER_HALF_W;- const playerBottom = transform.position.y - PLAYER_HALF_H;- const platTop = py + platHalfH;-- if (overlapX && playerBottom < platTop && playerBottom > py - platHalfH && player.velocityY <= 0) {- transform.position.y = platTop + PLAYER_HALF_H;- player.velocityY = 0;- player.isGrounded = true;- }- }-- if (player.isGrounded && (input.isKeyPressed('Space') || input.isKeyPressed('ArrowUp') || input.isKeyPressed('KeyW'))) {- player.velocityY = player.jumpForce;- }-- const BOUNDARY = 400;- if (transform.position.x < -BOUNDARY) transform.position.x = -BOUNDARY;- if (transform.position.x > BOUNDARY) transform.position.x = BOUNDARY;- if (transform.position.y < -300) {- transform.position.y = -200;- transform.position.x = -200;- player.velocityY = 0;- }+ const jump = input.isKeyPressed('Space')+ || input.isKeyPressed('ArrowUp')+ || input.isKeyPressed('KeyW');+ if (cc.isOnFloor && jump) cc.velocity.y = player.jumpForce;}},{ name: 'PlayerSystem' }diff --git a/examples/platformer/src/systems/score.ts b/examples/platformer/src/systems/score.tsnew file mode 100644index 000000000..6c14e8152--- /dev/null+++ b/examples/platformer/src/systems/score.ts@@ -0,0 +1,12 @@+import { defineSystem, Query, Mut, Text } from 'esengine';+import { ScoreDisplay } from '../components';++export const scoreSystem = defineSystem(+ [Query(ScoreDisplay, Mut(Text))],+ (query) => {+ for (const [_entity, score, text] of query) {+ text.content = `Score: ${score.score}`;+ }+ },+ { name: 'ScoreSystem' }+);