README.md

lua-objects Documentation

New here? The Quick Start writes a class that sends events and removes an instance of it in about 5 minutes.

Start

• Quick Start: get the code, write a class that sends events, remove an instance

Use

• API reference: the module, ObjectBase, setup and teardown, events, known issues
• lua-class API: the class model: newClass(), class members, getters and setters, superCall(), multiple inheritance
• lua-events-mixin: the events on their own, for objects that aren't lua-class classes
• dmc-objects: classes for Solar2D display objects, built on this one

Contribute

• Development: which files are copies, tests, possible future changes
• Issues

Project Structure

README.md                   landing page and Quick Start
LICENSE
docs/                       this documentation
dmc_lua/
├── lua_objects.lua         the module: ObjectBase
├── lua_class.lua           from lua-class (copy)
└── lua_events_mix.lua      from lua-events-mixin (copy)
Snakefile                   build rules, for DMC-Lua-Library
spec/
├── object_base_spec.lua    tests of ObjectBase (busted)
└── lua_objects_spec.lua    tests of the class model