alethia-engine v1.1.31

Alethia Engine

Example Project

GitHub Page

The Alethia Engine aims to provide a small, simple, and efficient 2 dimensional rendering engine for applications and games. With essentially only two new types (Scene and Asset), developers do not have to worry about having droves of unutilized features while also having a simple starting point to build a product designed for the users needs.

Scenes can be created like so:

import { Scene } from 'alethia-engine'

let overide = {
  id: 'my-new-scene'
}
let scene = new Scene(overide)

Assets can be created like so:

import { Asset } from 'alethia-engine'

let overide = {
  x: 50,
  y: 100
}
let asset = new Asset(overide)

To create a new Asset type, simply extend the class:

import { Asset } from 'alethia-engine'

class Tile extends Asset {
  constructor (sprite, x, y) {
    super({
      sprite: sprite,
      x: x,
      y: y,
      width: 25,
      height: 25,
      solid: false
    })
  }
}

Scene

Methods

  unfollow(): undefined // Stops the camera from following any Asset
  
  follow(asset:Asset): undefined // Makes the scene camera follow an asset on move
  
  addAsset(asset:Asset): undefined // Adds an asset to the scene
  
  scroll(x:Number, y:Number): undefined // Scrolls the scene from relative coordinates
  
  scrollTo(x:Number, y:Number): undefined // Scrolls the scene to fixed coordinates
  
  setScale(z:Number): undefined // Modifies the scale/zoom of the Scene
  
  keyPressed(key:String): Boolean // Returns true if the key is being pressed
  
  unselectAll(): undefined // Unselects all selected assets

Listeners

  oncreation(undefined):Function
  
  tickListeners:Object

Properties

  elem:Element // See Scriptleaf Element API
  
  state:State // See Scriptleaf State API
  
  floor:DOM Element // The background element
  
  background:String // URL to image
  
  fixedBackground:String // URL to image
  
  innerWidth:Number // The x cells in the scene
  
  innerHeight:Number // The y cells in the scene
  
  mouseBox:DOM Element // The mouse drag Element. Will apply object values as default on creation. Can be disabled by making == false
  
  mousePosition:Array // [x, y] of mouse position
  
  mouseDown:Number || false // Will be the value of the mousedown.button event value or false on mouse up

Asset

Methods

  changeSprite(imgURL:String): undefined // Changes DOM Element background to the image

  move(x:Number, y:Number): undefined // Moves Asset to relative position
  
  place(x:Number, y:Number): undefined // Places Asset at specific point
  
  focus(): undefined // Moves scene camera to focus on Asset
  
  destroyInstance(): undefined // Destroys instance of Asset
  
  getScene(): Scene || false // Returns the Scene Object or false if not attached
  
  rotate(deg:Number): undefined // Rotates DOM Element's transform
  
  select(): onselect listener return value
  
  unselect(): onunselect listener return value

Listeners

  oncreation(undefined) // Fired after the Asset's instance is created
  
  ontick(undefined) // Can be a function or an array of functions
  
  ondestroy(undefined) // Fires when the a Asset's instance is destroyed via the destroyInstance method
  
  oncollision(collidedObject:Asset):Boolean // if returns false, overlapping movement will not incur. Default returns false when collision is between two solid Assets.
  
  onselect(undefined) // By default fires whenever the asset is clicked or included in a drag box
  
  onunselect(undefined) // By default fires whenever the background is clicked
  
  onwaypointarrival(undefined) // Fires when arriving at waypoint. If does not return true, the active waypoint will be deleted. If returns array, the waypoint will be updated to that array

Properties

  elem:Element // See Scriptleaf Element API
  
  state:State // See Scriptleaf State API
  
  scene:Scene // The scene to which the Asset belongs
  
  follow:Boolean // Wether the camera will (on creation) or is (if already created) follow the Asset
  
  selectable:Boolean // If falsy, clicking and mouseboxes will not select the Asset
  
  waypoint:Array // [x, y] will travel asset.speed each tick towards waypoint
  
  speed:Number // The default speed when following a waypoint
  
  moveX:Number // Moves relatively on each tick, after the ontick method fires
  
  moveY:Number // Moves relatively on each tick, after the ontick method fires
  
  x:Number // The x grid coordinate in which the Asset is occupying
  
  y:Number // The y grid coordinate in which the Asset is occupying
  
  id:String // Will default to a random string if not expressed on creation