luxeengine/alpha

alpha - deprecated 2015~2016. unrelated to the new engine! view the new engine here - https://luxeengine.com/

alpha (deprecated)

This repo is an archive of the old alpha.

This repo is the old alpha codebase!

• It is no longer maintained
• It is not related to the new code base at all
• It is not representative of the new engine at all
• It was deprecated many years back (2015~2016)
• The new luxe code + engine are not available yet

please see https://luxeengine.com for the new engine!

view alpha documentation

Documentation is now archived in this repo. It can be viewed as md files for some, and downloaded and viewed offline as html files.

license

MIT (LICENSE.md)

alpha's Issues

Tweening options

Look into GTween and it's proxies

Sprite ; uv property changes the source uv coordinates

(specified in image space,not texels)

Sprite.uv = new Rectangle(0,0,32,32);

Camera; tween values for focus not applied unless shaking

yep...

Entity: Destroying entities

Entities don't have a destroy()-method visible in the docs, but there is a _destroy()-method available in the entity code. Calling this will however cause the engine to throw errors (tested in HTML5).

It would be great if it was possible to properly destroy entities through a class method.

Get a -server added to openfl-tools

To open the url on the server

Animation; Ranges for frameset

Rather than having setting individual frames in frameset it would be useful to be able to set a range

Collision ; Add hxcollision library as part of the engine tools

And fix the bugs in hxcollision while at it - and add the raycasting while at it.

Texture; Images that are too big for the graphics card must error out

Yes

Texture; NPOT images on WebGL should be either padded or throw

Preferably an option somewhere.

Camera; rotation origin not respected yet

Camera matrix is generated with the correct rotation but it needs to be translated to -origin before that is applied so that it can rotate "in place" and not around 0,0

Animation; add an importer api

Importing sprite animations from json is possible but requires custom json to best support luxe features.

But, there should be format interchange from existing formats, like TexturePacker.

What other animation software exports a data file that can be supported?

Animation; animation from images, not a sheet

Make it possible to use animation without a sprite sheet

TiledMap; Tiled importer

Implemented :

• object groups
• layers
• properties
• tilesets
• tiles

Still to add :

Encodings?

json

• json

xml

• xml
• base64 xml
• zip xml
• csv xml

gzip xml

Other data :
background color

• json
• xml

version

• json
• xml

Editor; Tags; Add unselectable tag

Such that items (like transparent glow items) can be marked as not selectable, and not interfere with working in the scene view.

Cameras; size, rotation, scaling as well as clean up.

Test, and verify these.

While testing the render texture example of mobile I found that the camera code has no setters or getters for size and is doing redundant work like regenerating the projection every frame instead of only when it actually changes.

Tests; Ideas for tests

• deep hierarchies

Tidy windows build output

There's too many dlls next to the exe when building! It's nice to have one exe. Click -> play.

Guides; Ideas for guides

Component: Init not being called

Sometimes when adding components to an entity, the init() method is never called. It does not happen randomly, yet it's hard to reproduce. Has only ever happened to component classes which inherit multiple user-defined class levels, so it could be related to inheritance.

Moving the init() overload down to the lowest level class (which only extends Component) yields the same result, the init method is never called.

Post effects; implement render chain

Usually I prefer to manage this but having a simple built in effect queue with in/out would be a win.

Animation; animation events

Events exist but are not tied to anything, they are empty.

It should work based on values from the JSON, and have an api to add/remove/clear/call etc.

Tilemaps; Create, Display, Edit, Translate

The api is supposed to handle all the translations for you from world -> tiles and tiles -> world and scaling between them. There are some questions regarding the offsets when drawing isometric, but I think I know how to solve that (using options.offset_x and options.offset_y as center/left/right/top/bottom like with the tile coord conversions).

Create

• create ortho
• create iso
• margin (image margin)
• spacing (tile padding)
• opacity flags
• visible / flags

Display

• display ortho
• display iso

Edit

• set tile id
• remove layers
• remove tilesets

Translate

• ortho world to tile
• iso world to tile
• ortho tile to world
• iso tile to world

Considering

Hexagonal maps are a tiny step away from being supported as well, may be worth the effort quick.

Other notes

Right now all tiles are created as distinct geometries which is perfectly fine (batching is always applied anyway) but at a later stage adding options like the complex geometry version in the old test would be good.

 

Color: get/set sprite->geometry color propagation

Setting sprite.color propagates to sprite.geometry.color, but getting sprite.color does not return sprite.geometry color. Thus they sometimes act as the same value, and sometimes they don't.

This means that only sprite.geometry.color will change if sprite.geometry.color is written, but both colors will be changed if sprite.color is written. Doesn't really make sense.

Debug; Profiler view generates geometry without removing it

It's accumulating (visible by pressing console -> 1 -> 2 (stats with debug geometry counts) -> 1 (enable profiler view) -> 1 (log) -> 1 (stats, note total geometry count is increased, continues to increase with each view of the profiler)

Input; Make consistent mappings for joystick across platforms

For common vendors (xbox one, 360, ps3, ps4)

• mac
• windows
• linux
• html5

Implement lime layer

• html5

Animation; Hold on frame

To be able to hold on individual frames

"like 1, 3, 4, hold 10, 2"

Documentator; Type Parameters not exported

verts:Array<Float> will export as :Array instead, need to parse and export type parameters

Audio; expose api from nme for now

Events; Components; typed data passing for handlers, like with states

No need for Dynamic here, when it can be typed smartly

Input; Make a key event type

that passes keys in a code in a code complete friendly way, and forwards the raw event from the platform in .raw as well.

Sprite; rotation

Sprite.rotation = degrees;

Input: static (pressed, released, down) methods

Allow the user to check if buttons or inputs are pressed, held or released through static input methods. Would make it possible to place input dependant code in components only, rather than having to propagate them from the main class.

Events; Implement the messaging system into the core structure

lime; Retina fixes from Martin

Merge them!

@grapefrukt are they ready yet?

submit fix to haxelib for the no .current file

This shouldn't be such an obscure error.

Sprite; Different geometry

It should be possible to hot swap sprite geometry but right now that fails to rebind the colors (and possibly more) to the new geometry.

Maybe :

• Geometry switch by setting .geometry has a setter that does the reworking, including dropping the existing geometry?
• geometry passed into constructor is respected.

There is a note here :
Sprite is the controlling party - basically anything set on the geometry prior to the sprite, will be overridden by the sprite on assignment or handing in the constructor. This goes for color, depth, texture, shaders, etc.

That means :

var geom = ... 
geom.depth = 0;

var sprite = new Sprite( {geometry:geom, depth:1 } );

//geom.depth is now 1, not 0 because it's owner takes precedence

Also note that the geometry you pass in is not added to a batcher by the sprite, it assumes you have or will add it (draw does this for you) but if you manually make geometry you are always expected to add it to a batcher anyway, so the sprite will not attempt to re add it.

• draw automatically adds to the default (or specified) batcher
• Sprite, unless given a custom geometry, or asked not to, will add to the default (or specified) batcher
• Manually created geometry handed to sprite is always expected to manage it's own lifetime anyway.

shutdown -> destroy

Keep consistency between the function names

1.x.x roadmap - feature ideas/suggestions

1.x feature update ideas, no specific order

• more font support
• better particles

Ideas

audio improvements

• filters? these will be native only.

more font support

• drawing as vectors
• ttf

 

1.0 roadmap

This is not a complete list

Things that need to be done, each must have

• test
• guide (and guide code)
• docs/api

The list

• Input/touch/gamepads
• drawing api
• color
• tweening
• events / signals
• sprites
• sprite animation
• assets
• state machines
• audio
• textures / render textures
• shaders
• depth / groups / blend modes
• cameras
• fonts
• collision
• tilemaps
• physics

Progress

Input/gamepads

• test
• guide
• docs

drawing api

• test
• guide
• docs

color

• test
• guide
• docs

tweening

• test
• guide
• docs

events / signals

• test
• guide
• docs

sprites

• test
• guide
• docs

sprite animation

• test
• guide
• docs

assets

• test
• guide
• docs

state machines

• test
• guide
• docs

audio

• test
• guide
• docs

textures / render textures

• test
• guide
• docs

shaders

• test
• guide
• docs

depth / groups / blend modes

• test
• guide
• docs

cameras

• test
• guide
• docs

fonts

• test
• guide
• docs

collision

• test
• guide
• docs

tilemaps

• test
• guide
• docs

tbd

physics

• test
• guide
• docs

 

Folders : Samples should be named templates

Geometry; Only first set of UV's sent

Currently :

8 sets are stored (uv0 - uv7).
Only uv0 is sent to the GPU when batching currently in the VBO's.

This is more relevant in 3D, hence the 1.x

html5; safer fallbacks for cross domain errors and shutdown

Errors when attempting to load textures in cross domain should fallback better

• fallback for cross policy errors
• fallback for when engine shutdown is called, it should not juts hang

Input; Make console key work across non-US keys

Sometimes the value is different, so far confirmed different on Italian.

Events; make a way for an event system to sever all connections

For example, instead of removing 20 listeners in the menu, just kill all connections in one go

events.clear_listeners or something.

Audio; HTML5 not implemented on lime level

Haven't needed or tested this yet (but implementing it is quick and easy).

Draw; ellipse, polygon

Drawing ellipses is useful.

It should include the start/end angle

• draw ellipse ring
• draw ellipse solid
• draw ngon solid
• draw ngon outline

Input; make a named binding wrapper

Usability; create Typedef types for generic constructors

For example, Geometry has a lot of parameters, and Sprite are all created by json like syntax. If this was a typedef it's possible to get code hinting ( i think ) so typing them would be great (and @optional can be used where needed, giving compile time errors for exact required values)

Input; Make consistent enum for key names across platforms

Particles; Broken since migrating to new Entity types?

It seems the particles are freaking out (tests/test_particles) and are spinning wildly with the incorrect origin, and worse when opening the debug console onto the stats page there is a peculiar crash SO.

Particles need to be reorganized slightly with fixes and additions I made to openfl-simple-particles and then made sure to be stable again since migrating to the new Entity code.