seed-engine

Version:

A Lightweight 2D game engine using WebGL2. The engine is designed on the focus of creating a bridge between creating and publishing games to the Seed Network as modules.

github.com/JaegarSarauer/SeedGameEngine

JaegarSarauer/SeedGameEngine

333 lines (306 loc) • 24.2 kB

HTML

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <base data-ice="baseUrl" href="../../../"> <title data-ice="title">src/object/GameObject.js | seed-engine</title> <link type="text/css" rel="stylesheet" href="css/style.css"> <link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css"> <script src="script/prettify/prettify.js"></script> <script src="script/manual.js"></script> <meta name="description" content="A Lightweight 2D game engine using WebGL2. The engine is designed on the focus of creating a bridge between creating and publishing games to the Seed Network as modules."><meta property="twitter:card" content="summary"><meta property="twitter:title" content="seed-engine"><meta property="twitter:description" content="A Lightweight 2D game engine using WebGL2. The engine is designed on the focus of creating a bridge between creating and publishing games to the Seed Network as modules."></head> <body class="layout-container" data-ice="rootContainer"> <header> <a href="./">Home</a> <a href="identifiers.html">Reference</a> <a href="source.html">Source</a> <a href="test.html" data-ice="testLink">Test</a> <div class="search-box"> <img src="./image/search.png"> <input class="search-input"> <ul class="search-result"></ul> </div> <a style="position:relative; top:3px;" href="https://github.com/JaegarSarauer/SeedGameEngine"><img width="20px" src="./image/github.png"></a></header> <nav class="navigation" data-ice="nav"><div> <ul> <li data-ice="doc">C<a href="class/src/Engine.js~_Engine.html">_Engine</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-Engine">Engine</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#base">base</a>C<a href="class/src/base/Updateable.js~Updateable.html">Updateable</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#component">component</a>C<a href="class/src/component/Animation.js~Animation.html">Animation</a></li> <li data-ice="doc">C<a href="class/src/component/Audio.js~Audio.html">Audio</a></li> <li data-ice="doc">C<a href="class/src/component/BoxCollider.js~BoxCollider.html">BoxCollider</a></li> <li data-ice="doc">C<a href="class/src/component/CircleCollider.js~CircleCollider.html">CircleCollider</a></li> <li data-ice="doc">C<a href="class/src/component/ClickController.js~ClickController.html">ClickController</a></li> <li data-ice="doc">C<a href="class/src/component/Collider.js~Collider.html">Collider</a></li> <li data-ice="doc">C<a href="class/src/component/Collider2D.js~Collider2D.html">Collider2D</a></li> <li data-ice="doc">C<a href="class/src/component/Component.js~Component.html">Component</a></li> <li data-ice="doc">C<a href="class/src/component/Controller.js~Controller.html">Controller</a></li> <li data-ice="doc">C<a href="class/src/component/Physics.js~Physics.html">Physics</a></li> <li data-ice="doc">C<a href="class/src/component/Physics2D.js~Physics2D.html">Physics2D</a></li> <li data-ice="doc">C<a href="class/src/component/Renderable.js~Renderable.html">Renderable</a></li> <li data-ice="doc">C<a href="class/src/component/Renderable2D.js~Renderable2D.html">Renderable2D</a></li> <li data-ice="doc">C<a href="class/src/component/Renderable2DGrid.js~Renderable2DGrid.html">Renderable2DGrid</a></li> <li data-ice="doc">C<a href="class/src/component/Renderable2DMultitex.js~Renderable2DMultitex.html">Renderable2DMultitex</a></li> <li data-ice="doc">C<a href="class/src/component/RenderableSquare.js~RenderableSquare.html">RenderableSquare</a></li> <li data-ice="doc">C<a href="class/src/component/RenderableText.js~RenderableText.html">RenderableText</a></li> <li data-ice="doc">C<a href="class/src/component/TopDownController.js~TopDownController.html">TopDownController</a></li> <li data-ice="doc">C<a href="class/src/component/Transform.js~Transform.html">Transform</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#const">const</a>V<a href="variable/index.html#static-variable-DEFAULT_F">DEFAULT_F</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-TILEMAP_F">TILEMAP_F</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-KeyCode">KeyCode</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-DEFAULT_V">DEFAULT_V</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#internal">internal</a>C<a href="class/src/internal/Bounds.js~Bounds.html">Bounds</a></li> <li data-ice="doc">C<a href="class/src/internal/Color.js~Color.html">Color</a></li> <li data-ice="doc">C<a href="class/src/internal/Point.js~Point.html">Point</a></li> <li data-ice="doc">C<a href="class/src/internal/PostBoard.js~PostBoard.html">PostBoard</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#manager">manager</a>C<a href="class/src/manager/AudioManager.js~_AudioManager.html">_AudioManager</a></li> <li data-ice="doc">C<a href="class/src/manager/DOMManager.js~_DOMManager.html">_DOMManager</a></li> <li data-ice="doc">C<a href="class/src/manager/EngineManager.js~_EngineManager.html">_EngineManager</a></li> <li data-ice="doc">C<a href="class/src/manager/InputManager.js~_InputManager.html">_InputManager</a></li> <li data-ice="doc">C<a href="class/src/manager/Manager.js~Manager.html">Manager</a></li> <li data-ice="doc">C<a href="class/src/manager/PersistentManager.js~_PersistentManager.html">_PersistentManager</a></li> <li data-ice="doc">C<a href="class/src/manager/PhysicsManager.js~_PhysicsManager.html">_PhysicsManager</a></li> <li data-ice="doc">C<a href="class/src/manager/ProgramManager.js~_ProgramManager.html">_ProgramManager</a></li> <li data-ice="doc">C<a href="class/src/manager/RenderManager.js~_RenderManager.html">_RenderManager</a></li> <li data-ice="doc">C<a href="class/src/manager/SceneManager.js~_SceneManager.html">_SceneManager</a></li> <li data-ice="doc">C<a href="class/src/manager/TextureManager.js~_TextureManager.html">_TextureManager</a></li> <li data-ice="doc">C<a href="class/src/manager/UIManager.js~_UIManager.html">_UIManager</a></li> <li data-ice="doc">C<a href="class/src/manager/UpdateableManager.js~_UpdateableManager.html">_UpdateableManager</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-AudioManager">AudioManager</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-DOMManager">DOMManager</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-EngineManager">EngineManager</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-InputManager">InputManager</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-PersistentManager">PersistentManager</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-PhysicsManager">PhysicsManager</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-ProgramManager">ProgramManager</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-RenderManager">RenderManager</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-SceneManager">SceneManager</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-TextureManager">TextureManager</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-UIManager">UIManager</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-UpdateableManager">UpdateableManager</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#object">object</a>C<a href="class/src/object/GameObject.js~GameObject.html">GameObject</a></li> <li data-ice="doc">C<a href="class/src/object/PersistentObject.js~PersistentObject.html">PersistentObject</a></li> <li data-ice="doc">C<a href="class/src/object/SceneObject.js~SceneObject.html">SceneObject</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#prefab-ui">prefab/ui</a>C<a href="class/src/prefab/ui/UIButton.js~UIButton.html">UIButton</a></li> <li data-ice="doc">C<a href="class/src/prefab/ui/UIElement.js~UIElement.html">UIElement</a></li> <li data-ice="doc">C<a href="class/src/prefab/ui/UIPanel.js~UIPanel.html">UIPanel</a></li> <li data-ice="doc">C<a href="class/src/prefab/ui/UIText.js~UIText.html">UIText</a></li> <li data-ice="doc">C<a href="class/src/prefab/ui/UITextInput.js~UITextInput.html">UITextInput</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#render">render</a>C<a href="class/src/render/Viewport.js~Viewport.html">Viewport</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#render-webgl">render/WebGL</a>C<a href="class/src/render/WebGL/Matrix.js~Matrix.html">Matrix</a></li> <li data-ice="doc">C<a href="class/src/render/WebGL/Matrix3.js~Matrix3.html">Matrix3</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#scene">scene</a>C<a href="class/src/scene/BasicScene.js~BasicScene.html">BasicScene</a></li> <li data-ice="doc">C<a href="class/src/scene/Scene.js~Scene.html">Scene</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#utils">utils</a>C<a href="class/src/utils/Loader.js~Loader.html">Loader</a></li> <li data-ice="doc">C<a href="class/src/utils/Messager.js~Messager.html">Messager</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-degToRad">degToRad</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-radToDeg">radToDeg</a></li> </ul> </div> </nav> <div class="content" data-ice="content"><h1 data-ice="title">src/object/GameObject.js</h1> <pre class="source-code line-number raw-source-code"><code class="prettyprint linenums" data-ice="content">import Updateable from '../base/Updateable'; import Component from '../component/Component'; import Transform from '../component/Transform'; /** * Baseclass GameObject which derives from Updateable. * * Do not derive this class directly! GameObjects are not managed until they are assigned to a manager. * Instead, derive SceneObject or PersistentObject to create objects that exist the scope of a scene, or the scope of the game. * * All objects that should exist in the game screen should derive this. */ export default class GameObject extends Updateable { /** * Default position, size and rotation of the Object. * * @param {Point} position A point of creation in the world. * @param {Point} size A point representing scale of the object. * @param {number} rotation A number representing angular rotation (in degrees). */ constructor(position = new Point(0, 0, 0), size = new Point(32, 32, 1), rotation = 0) { super(); this.className = 'GameObject'; this.components = {}; this.addComponent(new Transform(position, size, rotation)); this.transform = this.getComponent("Transform"); } /** * Adds a component to this game object, and keeps reference to it. * GameObjects will handle their components as they are added to the object. * * @param {Component} component The component assigned to this object. */ addComponent(component) { if (this.components[component.className] == null) { this.components[component.className] = []; } if (component.isUnique && this.components[component.className].length > 0) { throw 'There is already a unique component of type ' + component.className + ' on this GameObject!'; return false; } this.components[component.className].push(component); component.gameObject = this; component.onAddComponent(); return true; } /** * Removes a single component from this GameObject by ID. * * @param {number} componentID Id of the component to remove. */ removeComponent(componentName, componentID) { if (this.components[componentName] == null) return false; for (let i = 0; i < this.components[componentName].length; i++) { if (this.components[componentName][i].id === componentID) { let comp = this.components[componentName][i]; this.components[componentName].splice(i, 1); comp.end(); return true; } } return false; } /** * Removes all Components of the named type. * * @param {string} componentName The name of the components to clear. */ removeComponents(componentName) { if (this.components[componentName] == null) return false; for (let i = this.components[componentName].length - 1; i >= 0; i--) { let comp = this.components[componentName][i]; this.components[componentName].splice(i, 1); comp.end(); } return true; } /** * Removes all components except for the Transform component. */ removeAllComponents() { let compTypes = Object.keys(this.components); for (let i = 0; i < compTypes.length; i++) { let thisCompType = compTypes[i]; if (thisCompType === 'Transform') continue; for (let ii = 0; ii < this.components[thisCompType].length; ii++) { this.components[thisCompType][ii].end(); } this.components[thisCompType] = []; } return true; } /** * Returns a boolean on if there is a component of type {componentName}. * * @param {string} componentName Name of the component type to search for. * * @returns {boolean} true if there is at least one component of this type. */ hasComponent(componentName) { if (this.components[componentName] == null) { return false; } return this.components[componentName].length > 0; } /** * Returns a component of type {componentName}. The second parameter can determine which * Component of that type to return if there are more than 1. * * @param {string} componentName Name of the component type to return. * @param {*} index Index of the component to get. Defaults to first component. */ getComponent(componentName, index = 0) { if (this.components[componentName] == null) { return null; } return this.components[componentName][index]; } /** * Updates all components on this GameObject. */ updateComponents() { let compTypes = Object.keys(this.components); for (let i = 0; i < compTypes.length; i++) { let thisCompType = compTypes[i]; for (let ii = 0; ii < this.components[thisCompType].length; ii++) { this.components[thisCompType][ii].update(); } } } onPause() { let compTypes = Object.keys(this.components); for (let i = 0; i < compTypes.length; i++) { let thisCompType = compTypes[i]; for (let ii = 0; ii < this.components[thisCompType].length; ii++) { this.components[thisCompType][ii].pause(); } } } onUnpause() { let compTypes = Object.keys(this.components); for (let i = 0; i < compTypes.length; i++) { let thisCompType = compTypes[i]; for (let ii = 0; ii < this.components[thisCompType].length; ii++) { this.components[thisCompType][ii].unpause(); } } } /** * Rewritten update() functions which is originally defined in Updateable. * The GameObject adds a pre and post update function, and respective overrideable callbacks * (onPreUpdate and onPostUpdate). */ update() { if (this.hasPaused) return; if (!this.hasStarted) { this.start(); return; } this.preUpdate(); this.onUpdate(); this.updateComponents(); this.postUpdate(); } /** * Called by the GameObject before an update to do default calls for preUpdating. Afterwards it * calls the overrideable function, onPreUpdate. */ preUpdate() { this.onPreUpdate(); } /** * Called by the GameObject after an update to do default calls for postUpdating. Afterwards it * calls the overrideable function, onPostUpdate. */ postUpdate() { this.onPostUpdate(); } /** * Override for Pre Update functionality. */ onPreUpdate() {} /** * Override for Post Update functionality. */ onPostUpdate() {} }</code></pre> </div> <footer class="footer"> Generated by <a href="https://esdoc.org">ESDoc(1.1.0)<img src="./image/esdoc-logo-mini-black.png"></a> </footer> <script src="script/search_index.js"></script> <script src="script/search.js"></script> <script src="script/pretty-print.js"></script> <script src="script/inherited-summary.js"></script> <script src="script/test-summary.js"></script> <script src="script/inner-link.js"></script> <script src="script/patch-for-local.js"></script> </body> </html>