Elpy.js - 2D JavaScript game engine.
!
logo
|
Demo |
Game examples |
| :---: | :---: |
Docs
-
Install
-
Basic usage example
-
Engine
-
create()
-
add()
-
key()
-
keydown()
-
keyup()
-
mousemove()
-
click()
-
tick()
-
nextTick()
-
checkObjectInViewport()
-
fixingCamera()
-
unfixingCamera()
-
destroy()
-
on()
-
Event 'load'
-
Event 'animation'
-
load()
-
Engine getters
-
Object
-
run()
-
move()
-
fly()
-
jump()
-
fall()
-
push()
-
rotate()
-
stop()
-
destroy()
-
collision()
-
on()
-
Event 'collision'
-
Event 'move'
-
Event 'rotate'
-
Event 'destroy'
-
Event 'state'
-
Event 'jump'
-
Event 'fall'
-
Event 'fly'
-
Event object
-
removeCollision()
-
Object getters
-
Object setters
-
Development
-
License
!
games
Install
#### Download
Latest builds are available in the project
releases page .
#### CDN
``
js
`
`
js
`
Basic usage example
`
html
Elpy.js
`
Engine
$3
`
js
`
$3
name
| | The object name must be unique. |
x | | Position of the object along the x-axis. |
y | | Position of the object along the y-axis. |
width | | Object width in pixels. |
height | | Object height in pixels. |
options | | Additional object parameters. |
_min example_
`js
`
_max example_
`js
`
obstacle | | To determine if an object is an obstacle if there is a collision with the object. If the object was not added to the collision then the object will pass through another object. If an object has been added to a collision, then by default the object will stop on collision. If it is necessary that the collision event occur and the object passes through the object, then the obstacle property can be switched to false. |
pushing | | Will the object move if it is pushed through the push method. |
disabledEvents | | Disables all events for an object. |
type | , | A simple string that allows you to add your own data. It is convenient to use to set the type of an object in order to distinguish them from each other later. |
custom | , | An object where you can add your fields and use them via object.options.custorm. |
color | | Set object color. |
image | , | Set image. Two data types can be used: String or Object. image: 'path/to/image/' image: { path: 'path/to/image/', repeat: true }. |
images | | Can be used if the object has several images that can be changed through the state. For example, the image of the position when the player goes to the right or left. You can also make animation of switching frames through the animate property (Object getters ). The switching time is set in the time property. |
$3
object | |
`js
`
$3
callback | |
`js
`
$3
callback | |
`js
`
$3
callback | |
`js
`
$3
callback | |
`js
`
$3
callback | |
`js
`
$3
callback | |
`js
`
$3
callback | |
`js
`
$3
object | |
`js
`
$3
object | |
fixedCamera | |
_min example_
`js
`
_max example_
`js
`
$3
`js
`
$3
`js
`
$3
event | |
callback | |
`js
`
'load'
`js
`
'animation'
|
|
|
`js
`
$3
document.readyState === 'complete'. If the engine has not loaded and is in a black window state, you can call load manually after all operations with the engine (creating objects, adding objects, etc.).
`js
`
Engine getters
| Returns the width of the canvas. |
| Returns the height of the canvas. |
| Returns information on object and field offset. |
| Returns all added objects. |
`js
`
Object
$3
step | | 1 |
_min example_
`js
`
_max example_
`js
`
$3
x | |
y | |
`js
`
$3
degrees | | 0 |
distance | | 0 |
step | | 1 |
_min example_
`js
`
_max example_
`js
`
$3
height | | 0 |
multiplier | | 0.1 |
forced | | false |
_min example_
`js
`
_max example_
`js
`
$3
multiplier | | 0.1 |
_min example_
`js
`
_max example_
`js
`
$3
object | |
`js
`
$3
degrees | | 0 |
x | | 0 |
y | | 0 |
_min example_
`js
`
_max example_
`js
`
$3
`js
`
$3
`js
`
$3
object | , |
`js
`
$3
event | |
callback | |
`js
`
'collision'
object | |
side | |
`js
`
'move'
`js
`
'rotate'
`js
`
'destroy'
`js
`
'state'
`js
`
'jump'
event | | link |
`js
`
'fall'
event | | link |
`js
`
'fly'
event | | link |
`js
`
stopped | | The property will be true if the object has been stopped. |
paused | | The property will be true if the object has been paused. |
stop() | | Stop object. If he was in a state: jump, fall, fly. |
pause() | | Pause object. If he was in a state: jump, fall, fly. |
resume() | | Resume object. If it was paused. |
jump, fall, fly.
`js
`
$3
object | |
`js
`
Object getters
| Returns the name of the object. |
| Returns object options. |
| Returns the object's previous moves. |
| Returns the coordinates where the object is moving. |
| Returns the offset coordinates of an object. |
| Is it possible to push an object. |
| Is the object in a jump. |
| Is the object in fly. |
| Does the object exist. |
| Position of the object along the x-axis. |
| Position of the object along the y-axis. |
| Object width in pixels. |
| Object height in pixels. |
| Returns the current state of the object. |
| Is the object animated. |
| Whether collision is canceled with other objects that go to it. |
| The degrees the object is rotated. |
| Is the object added. |
`js
`
Object setters
| Position of the object along the x-axis. |
| Position of the object along the y-axis. |
| Object width in pixels. |
| Object height in pixels. |
| Used to switch textures. |
| Whether to animate the object. |
| Cancels collision with other objects that go to it. |
| Is the object added. |
`js
`
Development
`
``
License
MIT