Documentation

Introduction

NME is an easy-to-use, cross-platform framework, perfect for game or application development.

The APIs follow the Flash API closely. This should make NME especially familiar if you have Actionscript experience. The API is also easy to understand if you have not worked with Flash before.

If you are new to programming, please visit the New Developers' Guide. This will help introduce you to the Haxe programming language, as well as basic programming concepts.

If you have experience with Actionscript, you be interested in visiting the AS3 Developers' Guide, which includes more details about the simularities (and small differences) between Actionscript 3, Flash, Haxe and NME.

Specifications

You can also consult the documentation for the NMML File Format specification, or the commands supported by NME's Command-Line Tools.

In general, the best approach to learning more about the available API with Haxe or NME is to use a code editor which supports code completion. This will suggest classes, methods and properties to you while you are programming.

However, you can also consult the online pages for the Haxe/NME API. It includes all of the classes available for the Flash, C++, Neko and Javascript targets, as well as the classes covered by NME.

Most of the classes that are under the nme.* package mirror Flash's package and class structure. When compiling for Flash, these will usually map directly to the corresponding class in Flash. For example, "nme.display.Sprite" will literally equal "flash.display.Sprite" when compiling for the Flash target. These classes are usually mapped when targeting HTML5 as well, using classes from Jeash, which provides support for rendering content with Javascript and the HTML5 Canvas element.