Skip to content

Haxe extern definition for The Flash JavaScript API (jsfl)

License

Notifications You must be signed in to change notification settings

bubblebenj/haxe-jsfl

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Jxfl

For "Javascript Haxe Flash API" is a Haxe extern definition for The Flash JavaScript API (aka jsfl).

###Overview

The Jsfl API lets you create scripts that run in the Flash authoring environment.

Jxfl makes jsfl easier

  • Every function are documented jsdoc style
  • Options values are narrowed to those actually available
  • One for all jsfl API: the proposed API match your Flash version (from Macromedia Flash MX2004 to Adobe Flash Professional CC)
  • Haxe full power while creating jsfl files:
    • Code completion
    • Fully typed system (classes, type inference, type checking and more)
    • Many librairies from haxe, haxe-std are available
    • and much more

How to use

Setup

Install it with haxelib git.

$ haxelib git jxfl git://github.com/bubblebenj/haxe-jsfl.git

An example of HXML.

-lib jxfl
-cp src
-main Main
-js bin/Main.jsfl
-D jsflVersion=CS4

Access the fl

import jsfl.Lib.fl;
var document:Document = fl.getDocumentDOM();

Trace output

When link (-lib jxfl) passes as a library, 'trace' comes to be usable automatically.

trace("Hello World"); // Main.hx:10: Hello World

Example

Scan a item library and output the items name

import jsfl.Item;
import jsfl.Lib.fl;

class Main {
	public static function main() {
		var items:Array<Item> = fl.getDocumentDOM().library.items;
		for (item in items) {
			trace(item.name);
		}
	}
}

##About ###Credits This project is forked from tmskst/haxe-jsfl external definitions which provides Japanese extern definition for the JSAPI.

The API versioning management is greatly inspired from Andi Li Haxe external for jQueryExtern.

The Haxe community for it's support.

###Sources Definitions are copied from:

Version Documentation
CC Extending ADOBE® FLASH® PROFESSIONAL (Last updated 12/6/2013) or http://help.adobe.com/en_US/flash/cs/extend/index.html.
CS6 Not found
CS5, CS5.5 Extending ADOBE® FLASH® PROFESSIONAL CS5 & CS5.5
CS4 Extending ADOBE® FLASH® CS4 PROFESSIONAL
CS3 not found > Unofficial EXTENDING FLASH® CS3 or Unofficial french link EXTENSION DE FLASH
Flash8 not found > Unofficial Macromedia Flash 8 - Extending Flash
MX2004 [Macromedia Flash™MX 2004 - Flash JavaScript Dictionary] (http://download.macromedia.com/pub/documentation/en/flash/mx2004/fl_jsapi.pdf).

About

Haxe extern definition for The Flash JavaScript API (jsfl)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Haxe 100.0%