diff --git a/404.html b/404.html index fd4fbe2..ce7e453 100644 --- a/404.html +++ b/404.html @@ -1 +1 @@ -File not found - API Reference

404 Page not found

Page not found, sorry.

\ No newline at end of file +File not found - API Reference

404 Page not found

Page not found, sorry.

\ No newline at end of file diff --git a/index.html b/index.html index dbfe79d..5a89614 100644 --- a/index.html +++ b/index.html @@ -90,4 +90,4 @@

package ::full::

all have the same data type. The data type of a Vector's elements is known as the Vector's base type. The base type can be any class, including built in classes and custom classes. The base type is specified when declaring a Vector variable as well -as when creating an instance by calling the class constructor.

\ No newline at end of file +as when creating an instance by calling the class constructor.

\ No newline at end of file diff --git a/openfl/Assets.html b/openfl/Assets.html index df9eee8..e29088f 100644 --- a/openfl/Assets.html +++ b/openfl/Assets.html @@ -52,4 +52,4 @@ .navbar .container img { margin: 5px 0 0 4px; } -

Alias

\ No newline at end of file +

Alias

\ No newline at end of file diff --git a/openfl/Lib.html b/openfl/Lib.html index beb41fa..9406537 100644 --- a/openfl/Lib.html +++ b/openfl/Lib.html @@ -264,4 +264,4 @@ or parentheses, and do not specify parameters of the function to call. For example, use functionName, not functionName() or functionName(param).

delay

The delay, in milliseconds, until the function is executed.

args

An optional list of arguments that are passed to the closure function.

Returns:

Unique numeric identifier for the timed process. Use this identifier to -cancel the process, by calling the clearTimeout() method.

statictrace(arg:Dynamic):Void

\ No newline at end of file +cancel the process, by calling the clearTimeout() method.

statictrace(arg:Dynamic):Void

\ No newline at end of file diff --git a/openfl/Memory.html b/openfl/Memory.html index 0bfde33..942c67b 100644 --- a/openfl/Memory.html +++ b/openfl/Memory.html @@ -57,4 +57,4 @@ writing to the ByteArray object, known as "domain memory"

The Memory API provides access to domain memory using Memory.select on an existing ByteArray on the Flash target, and falls back to -standard access on other targets.

Static methods

staticinlinegetByte(position:Int):Int

Get a byte from the specified memory address

Parameters:

position

An existing address in the selected ByteArray memory

Returns:

An 8-bit integer value

staticinlinegetDouble(position:Int):Float

Get a double from the specified memory address

Parameters:

position

An existing address in the selected ByteArray memory

Returns:

A 64-bit floating point value

staticinlinegetFloat(position:Int):Float

Get a float from the specified memory address

Parameters:

position

An existing address in the selected ByteArray memory

Returns:

A 32-bit floating-point value

staticinlinegetI32(position:Int):Int

Get an int from the specified memory address

Parameters:

position

An existing address in the selected ByteArray memory

Returns:

A 32-bit integer value

staticinlinegetUI16(position:Int):Int

Return an unsigned int from the specified memory address

Parameters:

position

An existing address in the selected ByteArray memory

Returns:

An unsigned 16-bit integer value

staticselect(byteArray:ByteArray):Void

Selects the ByteArray to use for subsequent domain memory access

Parameters:

byteArray

A ByteArray object to use for memory

staticinlinesetByte(position:Int, v:Int):Void

Set a byte at the specified memory address

Parameters:

position

An existing address in the selected ByteArray memory

v

An 8-bit byte value

staticinlinesetDouble(position:Int, v:Float):Void

Set a double at the specified memory address

Parameters:

position

An existing address in the selected ByteArray memory

v

A 64-bit floating-point value

staticinlinesetFloat(position:Int, v:Float):Void

Set a float at the specified memory address

Parameters:

position

An existing address in the selected ByteArray memory

v

A 32-bit floating-point value

staticinlinesetI16(position:Int, v:Int):Void

Set an int at the specified memory address

Parameters:

position

An existing address in the selected ByteArray memory

v

A 16-bit integer value

staticinlinesetI32(position:Int, v:Int):Void

Set a long int at the specified memory address

Parameters:

position

An existing address in the selected ByteArray memory

v

A 32-bit integer value

\ No newline at end of file +standard access on other targets.

Static methods

staticinlinegetByte(position:Int):Int

Get a byte from the specified memory address

Parameters:

position

An existing address in the selected ByteArray memory

Returns:

An 8-bit integer value

staticinlinegetDouble(position:Int):Float

Get a double from the specified memory address

Parameters:

position

An existing address in the selected ByteArray memory

Returns:

A 64-bit floating point value

staticinlinegetFloat(position:Int):Float

Get a float from the specified memory address

Parameters:

position

An existing address in the selected ByteArray memory

Returns:

A 32-bit floating-point value

staticinlinegetI32(position:Int):Int

Get an int from the specified memory address

Parameters:

position

An existing address in the selected ByteArray memory

Returns:

A 32-bit integer value

staticinlinegetUI16(position:Int):Int

Return an unsigned int from the specified memory address

Parameters:

position

An existing address in the selected ByteArray memory

Returns:

An unsigned 16-bit integer value

staticselect(byteArray:ByteArray):Void

Selects the ByteArray to use for subsequent domain memory access

Parameters:

byteArray

A ByteArray object to use for memory

staticinlinesetByte(position:Int, v:Int):Void

Set a byte at the specified memory address

Parameters:

position

An existing address in the selected ByteArray memory

v

An 8-bit byte value

staticinlinesetDouble(position:Int, v:Float):Void

Set a double at the specified memory address

Parameters:

position

An existing address in the selected ByteArray memory

v

A 64-bit floating-point value

staticinlinesetFloat(position:Int, v:Float):Void

Set a float at the specified memory address

Parameters:

position

An existing address in the selected ByteArray memory

v

A 32-bit floating-point value

staticinlinesetI16(position:Int, v:Int):Void

Set an int at the specified memory address

Parameters:

position

An existing address in the selected ByteArray memory

v

A 16-bit integer value

staticinlinesetI32(position:Int, v:Int):Void

Set a long int at the specified memory address

Parameters:

position

An existing address in the selected ByteArray memory

v

A 32-bit integer value

\ No newline at end of file diff --git a/openfl/Vector.html b/openfl/Vector.html index add1c1d..b202064 100644 --- a/openfl/Vector.html +++ b/openfl/Vector.html @@ -138,7 +138,7 @@ this method.

Parameters:

callback

The function to run on each item in the Vector. This function is invoked with three arguments: the current item from the Vector, the index of the item, and the Vector object:

-
	 	function callback(item:T, index:Int, vector:Vector<T>):Bool {
+
	 	function callback(item:T, index:Int, vector:Vector<T>):Bool {
 	 		// your code here
 }

The callback function should return a Boolean value.

thisObject

The object that the identifer this in the callback function @@ -197,7 +197,7 @@ ending point is specified from the end of the Vector, where -1 is the last element.

Returns:

A Vector that consists of a range of elements from the original Vector.

staticinlinesome(this:IVector<T>, callback:Function, ?thisObject:Dynamic):Bool

Parameters:

callback

The function to run on each item in the Vector. This function is invoked with three arguments: the current item from the Vector, the index of the item, and the Vector object:

-
function callback(item:T, index:Int, vector:Vector<T>):Bool
+
function callback(item:T, index:Int, vector:Vector<T>):Bool

The callback function should return a Boolean value.

thisObject

The object that the identifer this in the callback function refers to when the function is called. ***Ignored on targets other than neko and js.

Returns:

A Boolean value of true if any items in the Vector return true for the specified function; otherwise, false.

staticinlinesort(this:IVector<T>, sortBehavior:(T, T) ‑> Int):Void

Sorts the elements in the Vector object, and also returns a sorted Vector object. @@ -237,4 +237,4 @@ argument is passed that is not an instance of the base type, an exception occurs at run time.

Parameters:

value

An instance of the base type of the Vector to be inserted at the beginning of the Vector.

Returns:

An integer representing the new length of the Vector.

Throws:

TypeError

If any argument is not an instance of the base type T of the -Vector.

RangeError

If this method is called while fixed is true.

\ No newline at end of file +Vector.

RangeError

If this method is called while fixed is true.

\ No newline at end of file diff --git a/openfl/desktop/Clipboard.html b/openfl/desktop/Clipboard.html index ddcc961..bd02af5 100644 --- a/openfl/desktop/Clipboard.html +++ b/openfl/desktop/Clipboard.html @@ -242,7 +242,7 @@ use a handler function to provide the data for a file dragged from an AIR application to the file system, the operating system calls the data handler function as soon as the drag gesture leaves the AIR -application?typically resulting in an undesireable pause as the file +application — typically resulting in an undesireable pause as the file data is downloaded or created. You can use a URLFilePromise for this purpose instead.

Note that the underlying data can change between the time the handler @@ -274,4 +274,4 @@ key press or mouse click). In AIR, this restriction only applies to content outside of the application security -sandbox.

TypeError

format or handler is null.

\ No newline at end of file +sandbox.

TypeError

format or handler is null.

\ No newline at end of file diff --git a/openfl/desktop/ClipboardFormats.html b/openfl/desktop/ClipboardFormats.html index f3b322c..2108e96 100644 --- a/openfl/desktop/ClipboardFormats.html +++ b/openfl/desktop/ClipboardFormats.html @@ -56,4 +56,4 @@ }

The ClipboardFormats class defines constants for the names of the standard data formats used with the Clipboard class. Flash Player 10 only supports -TEXT_FORMAT, RICH_TEXT_FORMAT, and HTML_FORMAT.

Variables

@:value(cast 0)@:impl@:enuminlineread onlyHTML_FORMAT:ClipboardFormats = 0

HTML data.

@:value(cast 1)@:impl@:enuminlineread onlyRICH_TEXT_FORMAT:ClipboardFormats = 1

Rich Text Format data.

@:value(cast 2)@:impl@:enuminlineread onlyTEXT_FORMAT:ClipboardFormats = 2

String data.

\ No newline at end of file +TEXT_FORMAT, RICH_TEXT_FORMAT, and HTML_FORMAT.

Variables

@:value(cast 0)@:impl@:enuminlineread onlyHTML_FORMAT:ClipboardFormats = 0

HTML data.

@:value(cast 1)@:impl@:enuminlineread onlyRICH_TEXT_FORMAT:ClipboardFormats = 1

Rich Text Format data.

@:value(cast 2)@:impl@:enuminlineread onlyTEXT_FORMAT:ClipboardFormats = 2

String data.

\ No newline at end of file diff --git a/openfl/desktop/ClipboardTransferMode.html b/openfl/desktop/ClipboardTransferMode.html index 980ea3a..08e71f6 100644 --- a/openfl/desktop/ClipboardTransferMode.html +++ b/openfl/desktop/ClipboardTransferMode.html @@ -60,4 +60,4 @@ values of the transferMode parameter of the Clipboard.getData() method. The transfer mode provides a hint about whether to return a reference or a -copy when accessing an object contained on a clipboard.

Variables

@:value(cast 0)@:impl@:enuminlineread onlyCLONE_ONLY:ClipboardTransferMode = 0

The Clipboard object should only return a copy.

@:value(cast 1)@:impl@:enuminlineread onlyCLONE_PREFERRED:ClipboardTransferMode = 1

The Clipboard object should return a copy if available and a reference if not.

@:value(cast 2)@:impl@:enuminlineread onlyORIGINAL_ONLY:ClipboardTransferMode = 2

The Clipboard object should only return a reference.

@:value(cast 3)@:impl@:enuminlineread onlyORIGINAL_PREFERRED:ClipboardTransferMode = 3

The Clipboard object should return a reference if available and a copy if not.

\ No newline at end of file +copy when accessing an object contained on a clipboard.

Variables

@:value(cast 0)@:impl@:enuminlineread onlyCLONE_ONLY:ClipboardTransferMode = 0

The Clipboard object should only return a copy.

@:value(cast 1)@:impl@:enuminlineread onlyCLONE_PREFERRED:ClipboardTransferMode = 1

The Clipboard object should return a copy if available and a reference if not.

@:value(cast 2)@:impl@:enuminlineread onlyORIGINAL_ONLY:ClipboardTransferMode = 2

The Clipboard object should only return a reference.

@:value(cast 3)@:impl@:enuminlineread onlyORIGINAL_PREFERRED:ClipboardTransferMode = 3

The Clipboard object should return a reference if available and a copy if not.

\ No newline at end of file diff --git a/openfl/desktop/DockIcon.html b/openfl/desktop/DockIcon.html index e7f6ac3..2b1433e 100644 --- a/openfl/desktop/DockIcon.html +++ b/openfl/desktop/DockIcon.html @@ -226,4 +226,4 @@ event specified by the type parameter.

When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

Parameters:

type

The type of event.

Returns:

A value of true if a listener of the specified type -will be triggered; false otherwise.

\ No newline at end of file +will be triggered; false otherwise.

\ No newline at end of file diff --git a/openfl/desktop/Icon.html b/openfl/desktop/Icon.html index f2de415..97a3e1d 100644 --- a/openfl/desktop/Icon.html +++ b/openfl/desktop/Icon.html @@ -194,4 +194,4 @@ event specified by the type parameter.

When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

Parameters:

type

The type of event.

Returns:

A value of true if a listener of the specified type -will be triggered; false otherwise.

\ No newline at end of file +will be triggered; false otherwise.

\ No newline at end of file diff --git a/openfl/desktop/InteractiveIcon.html b/openfl/desktop/InteractiveIcon.html index 532b338..a142942 100644 --- a/openfl/desktop/InteractiveIcon.html +++ b/openfl/desktop/InteractiveIcon.html @@ -206,4 +206,4 @@ event specified by the type parameter.

When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

Parameters:

type

The type of event.

Returns:

A value of true if a listener of the specified type -will be triggered; false otherwise.

\ No newline at end of file +will be triggered; false otherwise.

\ No newline at end of file diff --git a/openfl/desktop/InvokeEventReason.html b/openfl/desktop/InvokeEventReason.html index 845d183..acb5fd6 100644 --- a/openfl/desktop/InvokeEventReason.html +++ b/openfl/desktop/InvokeEventReason.html @@ -58,4 +58,4 @@ user logging in.

@:value(cast 1)@:impl@:enuminlineread onlyNOTIFICATION:InvokeEventReason = 1

iOS only; indicates that the InvokeEvent occurred because the application was invoked on receiving a remote notification.

@:value(cast 2)@:impl@:enuminlineread onlyOPEN_URL:InvokeEventReason = 2

Mobile only; indicates that the InvokeEvent occurred because the application was invoked by another application or by the system.

@:value(cast 3)@:impl@:enuminlineread onlySTANDARD:InvokeEventReason = 3

Indicates that the InvokeEvent occured for any reason other than login -or open url.

\ No newline at end of file +or open url.

\ No newline at end of file diff --git a/openfl/desktop/NativeApplication.html b/openfl/desktop/NativeApplication.html index d934242..f9a7887 100644 --- a/openfl/desktop/NativeApplication.html +++ b/openfl/desktop/NativeApplication.html @@ -1,7 +1,7 @@ -openfl.desktop.NativeApplication - API Reference

The NativeApplication class represents this AIR application.

+

The NativeApplication class represents this OpenFL application.

The NativeApplication class provides application information, application-wide functions, and dispatches application-level events.

The NativeApplication object is a singleton object, created automatically at startup. Get the NativeApplication instance of an application with the -static property NativeApplication.nativeApplication.

Static variables

staticread onlynativeApplication:NativeApplication

The singleton instance of the NativeApplication object.

staticread onlysupportsDefaultApplication:Bool

Indicates whether setAsDefaultApplication(), +static property NativeApplication.nativeApplication.

Static variables

staticread onlynativeApplication:NativeApplication

The singleton instance of the NativeApplication object.

staticread onlysupportsDefaultApplication:Bool

Indicates whether setAsDefaultApplication(), removeAsDefaultApplication(), and isSetAsDefaultApplication() are supported on the current platform.

+

OpenFL target support: Not currently supported, except when targeting AIR.

If true, then the above methods will work as documented. If false, then setAsDefaultApplication() and removeDefaultApplication() do -nothing and isSetAsDefaultApplication() returns false.

See also:

staticread onlysupportsDockIcon:Bool

Indicates whether AIR supports dock-style application icons on the +nothing and isSetAsDefaultApplication() returns false.

See also:

staticread onlysupportsDockIcon:Bool

Indicates whether OpenFL supports dock-style application icons on the current operating system.

+

OpenFL target support: Not currently supported, except when targeting AIR.

If true, the NativeApplication.icon property is of type DockIcon.

The Mac OS X user interface provides an application "dock" containing icons for applications that are running or are frequently used.

@@ -73,6 +75,7 @@ lead to programming errors (if some possible target operating systems are not considered).

staticread onlysupportsMenu:Bool

Specifies whether the current operating system supports a global application menu bar.

+

OpenFL target support: Not currently supported, except when targeting AIR.

When true, the NativeApplication.menu property can be used to define (or access) a native application menu.

Be sure to use the NativeApplication.supportsMenu property to @@ -80,9 +83,11 @@ bar. Using other means (such as Capabilities.os) to determine support can lead to programming errors (if some possible target operating systems are not considered).

staticread onlysupportsStartAtLogin:Bool

Indicates whether startAtLogin is supported on the current platform.

+

OpenFL target support: Not currently supported, except when targeting AIR.

If true, then startAtLogin works as documented. If false, then -startAtLogin has no effect.

See also:

staticread onlysupportsSystemTrayIcon:Bool

Specifies whether AIR supports system tray icons on the current +startAtLogin has no effect.

See also:

staticread onlysupportsSystemTrayIcon:Bool

Specifies whether OpenFL supports system tray icons on the current operating system.

+

OpenFL target support: Not currently supported, except when targeting AIR.

If true, the NativeApplication.icon property is of type SystemTrayIcon.

The Windows user interface provides the "system tray" region of the task @@ -107,6 +112,7 @@ application.

This property is not supported on platforms that do not support the NativeWindow class.

@:value(null)read onlyicon:InteractiveIcon = null

The application icon.

+

OpenFL target support: Not currently supported, except when targeting AIR.

Use NativeApplication.supportsDockIcon and NativeApplication.supportsSystemTrayIcon to determine the icon class. The type will be one of the subclasses of InteractiveIcon. On macOS, @@ -165,9 +171,11 @@ AIR Profile Support for more information regarding API support across multiple profiles.

removeAsDefaultApplication(extension:String):Void

Removes this application as the default for opening files with the specified extension.

+

OpenFL target support: Not currently supported, except when targeting AIR.

Note: This method can only be used with file types listed in the fileTypes statement in the application descriptor.

setAsDefaultApplication(extension:String):Void

Sets this application as the default application for opening files with the specified extension.

+

OpenFL target support: Not currently supported, except when targeting AIR.

Note: This method can only be used with file types declared in the fileTypes statement in the application descriptor.

Inherited Variables

Inherited Methods

Defined by EventDispatcher

@:value({ useWeakReference : false, priority : 0, useCapture : false })addEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event @@ -290,4 +298,4 @@ event specified by the type parameter.

When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

Parameters:

type

The type of event.

Returns:

A value of true if a listener of the specified type -will be triggered; false otherwise.

\ No newline at end of file +will be triggered; false otherwise.

\ No newline at end of file diff --git a/openfl/desktop/NativeProcess.html b/openfl/desktop/NativeProcess.html index a88a4b8..860a48e 100644 --- a/openfl/desktop/NativeProcess.html +++ b/openfl/desktop/NativeProcess.html @@ -2,10 +2,11 @@ openfl.desktop.NativeProcess - API Reference

The NativeProcess class provides command line integration and general -launching capabilities. The NativeProcess class lets an AIR application -execute native processes on the host operating system. The AIR applcation -can monitor the standard input (stdin) and standard output (stdout) stream -of the process as well as the process's standard error (stderr) stream.

+launching capabilities. The NativeProcess class lets an OpenFL application +execute native processes on the host operating system. The OpenFL +application can monitor the standard input (stdin) and standard output +(stdout) stream of the process as well as the process's standard error +(stderr) stream.

The NativeProcess class and its capabilities are only available to Haxe "sys" targets and AIR applications installed with a native installer -(extended desktop profile applications). When debugging an AIR application, +("extendedDesktop" profile applications). When debugging an AIR application, you can pass the -profile extendedDesktop argument to ADL to enable the NativeProcess functionality. At runtime, you can check the NativeProcess.isSupported property to to determine whether native process -communication is supported.

Static variables

@:value(true)staticread onlyisSupported:Bool = true

ndicates if running native processes is supported in the current -profile. This property returns true only when running on Haxe "sys" -targets or the Adobe AIR extendedDesktop profile. In addition, +communication is supported.

Static variables

@:value(true)staticread onlyisSupported:Bool = true

Indicates if running native processes is supported in the current +OpenFL target. This property returns true only when running on Haxe +"sys" targets or the Adobe AIR "extendedDesktop" profile. In addition, NativeProcess.isSupported is always false for applications installed as an .air file. You must package an AIR application using the ADT --target native flag in order to use the NativeProcess class in AIR.

Constructor

new()

Constructs an uninitialized NativeProcess object. Call the start() +-target native flag or the -target bundle flag in order to use the +NativeProcess class in AIR.

Constructor

new()

Constructs an uninitialized NativeProcess object. Call the start() method to start the process.

Variables

read onlyrunning:Bool

Indicates if this native process is currently running. The process is running if you have called the start() method and the NativeProcess object has not yet dispatched an exit event. A NativeProcess instance @@ -272,4 +275,4 @@ event specified by the type parameter.

When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

Parameters:

type

The type of event.

Returns:

A value of true if a listener of the specified type -will be triggered; false otherwise.

\ No newline at end of file +will be triggered; false otherwise.

\ No newline at end of file diff --git a/openfl/desktop/NativeProcessStartupInfo.html b/openfl/desktop/NativeProcessStartupInfo.html index f1558e5..a9b75a8 100644 --- a/openfl/desktop/NativeProcessStartupInfo.html +++ b/openfl/desktop/NativeProcessStartupInfo.html @@ -57,9 +57,9 @@

This class provides the basic information used to start a process on the host operating system. It is constructed and passed to the start() method of a NativeProcess object.

-

Native process access is only available to AIR applications installed with -native installers (applications in the extended desktop profile) and Haxe -"sys" targets.

Constructor

new()

Constructs an empty NativeProcessStartupInfo object.

Variables

arguments:Vector<String>

The command line arguments that will be passed to the process on +

Native process access is only available to Haxe "sys" targets and AIR +applications installed with native installers (applications in the +"extendedDesktop" profile).

Constructor

new()

Constructs an empty NativeProcessStartupInfo object.

Variables

arguments:Vector<String>

The command line arguments that will be passed to the process on startup.

Each string in the arguments Vector will be passed as a separate argument to the executable, regardless of what characters the string @@ -73,4 +73,4 @@ path the the executable (within the bundle), not just the path to the app file.

workingDirectory:File

The File object that references the initial working directory for the new native process. If assigned a value where isDirectory is false, an -ArgumentError is thrown.

\ No newline at end of file +ArgumentError is thrown.

\ No newline at end of file diff --git a/openfl/desktop/NotificationType.html b/openfl/desktop/NotificationType.html index b5801e4..84e8100 100644 --- a/openfl/desktop/NotificationType.html +++ b/openfl/desktop/NotificationType.html @@ -58,4 +58,4 @@ parameter of the DockIcon bounce() method and the type parameter of the NativeWindow notifyUser() method.

See also:

Variables

@:value(cast 0)@:impl@:enuminlineread onlyCRITICAL:NotificationType = 0

Specifies that a notification alert is critical in nature and the user should attend to it promptly.

@:value(cast 1)@:impl@:enuminlineread onlyINFORMATIONAL:NotificationType = 1

Specifies that a notification alert is informational in nature and the -user can safely ignore it.

\ No newline at end of file +user can safely ignore it.

\ No newline at end of file diff --git a/openfl/desktop/SystemIdleMode.html b/openfl/desktop/SystemIdleMode.html index 220b4b5..a48463d 100644 --- a/openfl/desktop/SystemIdleMode.html +++ b/openfl/desktop/SystemIdleMode.html @@ -59,4 +59,4 @@ NativeApplication class.

See also:

Variables

@:value(cast 0)@:impl@:enuminlineread onlyKEEP_AWAKE:SystemIdleMode = 0

Prevents the system from dropping into an idle mode.

On Android, the application must specify the Android permissions for DISABLE_KEYGUARD and WAKE_LOCK in the application descriptor or the -operating system will not honor this setting.

@:value(cast 1)@:impl@:enuminlineread onlyNORMAL:SystemIdleMode = 1

The system follows the normal "idle user" behavior.

\ No newline at end of file +operating system will not honor this setting.

@:value(cast 1)@:impl@:enuminlineread onlyNORMAL:SystemIdleMode = 1

The system follows the normal "idle user" behavior.

\ No newline at end of file diff --git a/openfl/desktop/SystemTrayIcon.html b/openfl/desktop/SystemTrayIcon.html index ac96818..599c757 100644 --- a/openfl/desktop/SystemTrayIcon.html +++ b/openfl/desktop/SystemTrayIcon.html @@ -199,4 +199,4 @@ event specified by the type parameter.

When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

Parameters:

type

The type of event.

Returns:

A value of true if a listener of the specified type -will be triggered; false otherwise.

\ No newline at end of file +will be triggered; false otherwise.

\ No newline at end of file diff --git a/openfl/desktop/Updater.html b/openfl/desktop/Updater.html index 0e10d5e..da269d4 100644 --- a/openfl/desktop/Updater.html +++ b/openfl/desktop/Updater.html @@ -105,4 +105,4 @@

Note: Specifying the version parameter is required for security reasons. By requiring the application to verify the version number in the AIR file, the application will not inadvertantly install an older version, -which might contain a security vulnerability that has been fixed.

\ No newline at end of file +which might contain a security vulnerability that has been fixed.

\ No newline at end of file diff --git a/openfl/desktop/index.html b/openfl/desktop/index.html index 002d880..d048bba 100644 --- a/openfl/desktop/index.html +++ b/openfl/desktop/index.html @@ -100,11 +100,12 @@

package ::full::

The transfer mode provides a hint about whether to return a reference or a copy when accessing an object contained on a clipboard.

DockIcon

The DockIcon class represents the macOS-style dock icon.

Icon

The Icon class represents an operating system icon.

InteractiveIcon

The InteractiveIcon class is the base class for the operating system icons associated with applications.

InvokeEventReason

The InvokeEventReason class enumerates values returned by the reason -property of an InvokeEvent object.

NativeApplication

The NativeApplication class represents this AIR application.

NativeProcess

The NativeProcess class provides command line integration and general -launching capabilities. The NativeProcess class lets an AIR application -execute native processes on the host operating system. The AIR applcation -can monitor the standard input (stdin) and standard output (stdout) stream -of the process as well as the process's standard error (stderr) stream.

NativeProcessStartupInfo

This class provides the basic information used to start a process on the +property of an InvokeEvent object.

NativeApplication

The NativeApplication class represents this OpenFL application.

NativeProcess

The NativeProcess class provides command line integration and general +launching capabilities. The NativeProcess class lets an OpenFL application +execute native processes on the host operating system. The OpenFL +application can monitor the standard input (stdin) and standard output +(stdout) stream of the process as well as the process's standard error +(stderr) stream.

NativeProcessStartupInfo

This class provides the basic information used to start a process on the host operating system. It is constructed and passed to the start() method of a NativeProcess object.

NotificationType

The NotificationType class defines constants for use in the priority parameter of the DockIcon bounce() method and the type parameter of the @@ -112,4 +113,4 @@

package ::full::

These constants are used in the systemIdleMode property of the NativeApplication class.

SystemTrayIcon

Updater

The Updater class is used to update the currently running application with a different version. To use it, instantiate an Updater object and then call -its update() method.

\ No newline at end of file +its update() method.

\ No newline at end of file diff --git a/openfl/display/AVM1Movie.html b/openfl/display/AVM1Movie.html index 0dccf62..e45bf8b 100644 --- a/openfl/display/AVM1Movie.html +++ b/openfl/display/AVM1Movie.html @@ -373,7 +373,7 @@ property of the scrollRect Rectangle object. You can scroll an object up and down by setting the y property of the scrollRect Rectangle object. If the display object is rotated -90� and you scroll it left and right, the display object actually scrolls +90° and you scroll it left and right, the display object actually scrolls up and down.

@:betashader:Shader

BETA**

Applies a custom Shader object to use when rendering this display object (or its children) when using hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to @@ -425,16 +425,16 @@ to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

@:keepy:Float

Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

Inherited Methods

Defined by DisplayObject

getBounds(targetCoordinateSpace:DisplayObject):Rectangle

Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object. Consider the following code, which shows how the rectangle returned can @@ -521,4 +521,4 @@ event specified by the type parameter.

When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

Parameters:

type

The type of event.

Returns:

A value of true if a listener of the specified type -will be triggered; false otherwise.

\ No newline at end of file +will be triggered; false otherwise.

\ No newline at end of file diff --git a/openfl/display/Application.html b/openfl/display/Application.html index d1e24f3..8034c03 100644 --- a/openfl/display/Application.html +++ b/openfl/display/Application.html @@ -54,4 +54,4 @@ margin: 5px 0 0 4px; }

The Application class is a Lime Application instance that uses -OpenFL Window by default when a new window is created.

Constructor

new()

Methods

\ No newline at end of file +OpenFL Window by default when a new window is created.

Constructor

new()

Methods

\ No newline at end of file diff --git a/openfl/display/Bitmap.html b/openfl/display/Bitmap.html index 6e91d98..12e8b41 100644 --- a/openfl/display/Bitmap.html +++ b/openfl/display/Bitmap.html @@ -386,7 +386,7 @@ property of the scrollRect Rectangle object. You can scroll an object up and down by setting the y property of the scrollRect Rectangle object. If the display object is rotated -90� and you scroll it left and right, the display object actually scrolls +90° and you scroll it left and right, the display object actually scrolls up and down.

@:betashader:Shader

BETA**

Applies a custom Shader object to use when rendering this display object (or its children) when using hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to @@ -438,16 +438,16 @@ to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

@:keepy:Float

Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

Inherited Methods

Defined by DisplayObject

getBounds(targetCoordinateSpace:DisplayObject):Rectangle

Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object. Consider the following code, which shows how the rectangle returned can @@ -534,4 +534,4 @@ event specified by the type parameter.

When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

Parameters:

type

The type of event.

Returns:

A value of true if a listener of the specified type -will be triggered; false otherwise.

\ No newline at end of file +will be triggered; false otherwise.

\ No newline at end of file diff --git a/openfl/display/BitmapData.html b/openfl/display/BitmapData.html index fb005df..ebebd4c 100644 --- a/openfl/display/BitmapData.html +++ b/openfl/display/BitmapData.html @@ -95,12 +95,17 @@ is 8,191 pixels in width or height, and the total number of pixels cannot exceed 16,777,215 pixels. (So, if a BitmapData object is 8,191 pixels wide, it can only be 2,048 pixels high.) In Flash Player 9 and earlier, the limitation -is 2,880 pixels in height and 2,880 in width.

Static methods

staticfromBase64(base64:String, type:String):BitmapData

Available on Android, Linux, Neko, Windows, iOS, macOS

Creates a new BitmapData instance from Base64-encoded data synchronously. This means -that the BitmapData will be returned immediately (if supported).

+is 2,880 pixels in height and 2,880 in width.

Static methods

staticfromBase64(base64:String, type:String):BitmapData

Available on Android, Linux, Neko, Windows, iOS, macOS

Creates a new BitmapData instance from Base64-encoded data +synchronously. This means that the BitmapData will be returned +immediately (if supported). The bytes must be of a supported bitmap file +format, such as PNG or JPG. To use raw ARGB pixel data, call +setPixels or setVector instead.

HTML5 and Flash do not support creating BitmapData synchronously, so these targets -always return null. Other targets will return null if decoding was unsuccessful.

Parameters:

base64

Base64-encoded data

type

The MIME-type for the encoded data ("image/jpeg", etc)

Returns:

A new BitmapData if successful, or null if unsuccessful

@:value({ rawAlpha : null })staticfromBytes(bytes:ByteArray, ?rawAlpha:ByteArray):BitmapData

Available on Android, Linux, Neko, Windows, iOS, macOS

Creates a new BitmapData from bytes (a haxe.io.Bytes or openfl.utils.ByteArray) -synchronously. This means that the BitmapData will be returned immediately (if -supported).

+always return null. Other targets will return null if decoding was unsuccessful.

Parameters:

base64

Base64-encoded data

type

The MIME-type for the encoded data ("image/jpeg", etc)

Returns:

A new BitmapData if successful, or null if unsuccessful

@:value({ rawAlpha : null })staticfromBytes(bytes:ByteArray, ?rawAlpha:ByteArray):BitmapData

Available on Android, Linux, Neko, Windows, iOS, macOS

Creates a new BitmapData from bytes (a haxe.io.Bytes or +openfl.utils.ByteArray) synchronously. This means that the BitmapData +will be returned immediately (if supported). The bytes must be of a +supported bitmap file format, such as PNG or JPG. To use raw ARGB pixel +data, call setPixels or setVector instead.

HTML5 and Flash do not support creating BitmapData synchronously, so these targets always return null. Other targets will return null if decoding was unsuccessful.

The optional rawAlpha parameter makes it easier to process images that have alpha @@ -676,4 +681,4 @@ setPixel32() method.

Parameters:

changeRect

The area of the BitmapData object that has changed. If you do not specify a value for this parameter, the entire area of the BitmapData object is considered -changed.

\ No newline at end of file +changed.

\ No newline at end of file diff --git a/openfl/display/BitmapDataChannel.html b/openfl/display/BitmapDataChannel.html index e593274..9350aa5 100644 --- a/openfl/display/BitmapDataChannel.html +++ b/openfl/display/BitmapDataChannel.html @@ -63,4 +63,4 @@ parameters of the openfl.display.BitmapData.copyChannel() method
  • The channelOptions parameter of the openfl.display.BitmapData.noise() method
  • The openfl.filters.DisplacementMapFilter.componentX and -openfl.filters.DisplacementMapFilter.componentY properties
  • Variables

    @:value(cast 8)@:impl@:enuminlineread onlyALPHA:BitmapDataChannel = 8

    The alpha channel.

    @:value(cast 4)@:impl@:enuminlineread onlyBLUE:BitmapDataChannel = 4

    The blue channel.

    @:value(cast 2)@:impl@:enuminlineread onlyGREEN:BitmapDataChannel = 2

    The green channel.

    @:value(cast 1)@:impl@:enuminlineread onlyRED:BitmapDataChannel = 1

    The red channel.

    \ No newline at end of file +openfl.filters.DisplacementMapFilter.componentY properties

    Variables

    @:value(cast 8)@:impl@:enuminlineread onlyALPHA:BitmapDataChannel = 8

    The alpha channel.

    @:value(cast 4)@:impl@:enuminlineread onlyBLUE:BitmapDataChannel = 4

    The blue channel.

    @:value(cast 2)@:impl@:enuminlineread onlyGREEN:BitmapDataChannel = 2

    The green channel.

    @:value(cast 1)@:impl@:enuminlineread onlyRED:BitmapDataChannel = 1

    The red channel.

    \ No newline at end of file diff --git a/openfl/display/BlendMode.html b/openfl/display/BlendMode.html index 8ef6c34..5101e95 100644 --- a/openfl/display/BlendMode.html +++ b/openfl/display/BlendMode.html @@ -139,4 +139,4 @@

    For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400(because 0xDD - -0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).

    \ No newline at end of file +0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).

    \ No newline at end of file diff --git a/openfl/display/CairoRenderer.html b/openfl/display/CairoRenderer.html index e13018e..568564b 100644 --- a/openfl/display/CairoRenderer.html +++ b/openfl/display/CairoRenderer.html @@ -176,4 +176,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/display/CanvasRenderer.html b/openfl/display/CanvasRenderer.html index 6fdd524..22625e3 100644 --- a/openfl/display/CanvasRenderer.html +++ b/openfl/display/CanvasRenderer.html @@ -176,4 +176,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/display/CapsStyle.html b/openfl/display/CapsStyle.html index 67ad3b7..4e3143f 100644 --- a/openfl/display/CapsStyle.html +++ b/openfl/display/CapsStyle.html @@ -64,4 +64,4 @@

    The three types of caps: NONE, ROUND, and SQUARE.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyNONE:CapsStyle = 0

    Used to specify no caps in the caps parameter of the openfl.display.Graphics.lineStyle() method.

    @:value(cast 1)@:impl@:enuminlineread onlyROUND:CapsStyle = 1

    Used to specify round caps in the caps parameter of the openfl.display.Graphics.lineStyle() method.

    @:value(cast 2)@:impl@:enuminlineread onlySQUARE:CapsStyle = 2

    Used to specify square caps in the caps parameter of the -openfl.display.Graphics.lineStyle() method.

    \ No newline at end of file +openfl.display.Graphics.lineStyle() method.

    \ No newline at end of file diff --git a/openfl/display/ChildAccess.html b/openfl/display/ChildAccess.html index 94f6de5..0979c93 100644 --- a/openfl/display/ChildAccess.html +++ b/openfl/display/ChildAccess.html @@ -72,4 +72,4 @@

    You can use array access to reach child instances as well. This is useful if the child object has the name of a DisplayObject property, or if it uses special characters:

    var movieClip:ChildAccess<MovieClip> = movieClip;
    -movieClip.sprite["sprite2"].x = 100;

    Static variables

    staticalpha:Float

    Accesses the alpha property.

    staticantiAliasType:AntiAliasType

    Accesses the antiAliasType property (for TextField instances only).

    staticautoSize:TextFieldAutoSize

    Accesses the autoSize property (for TextField instances only).

    staticbackground:Bool

    Accesses the background property (for TextField instances only).

    staticbackgroundColor:Int

    Accesses the backgroundColor property (for TextField instances only).

    staticbitmapData:BitmapData

    Accesses the bitmapData property (for Bitmap instances only).

    staticblendMode:BlendMode

    Accesses the blendMode property.

    staticborder:Bool

    Accesses the border property (for TextField instances only).

    staticborderColor:Int

    Accesses the borderColor property (for TextField instances only).

    staticread onlybottomScrollV:Int

    Accesses the bottomScrollV property (for TextField instances only).

    staticbuttonMode:Bool

    Accesses the buttonMode property (for Sprite instances only).

    staticcacheAsBitmap:Bool

    Accesses the cacheAsBitmap property.

    staticcacheAsBitmapMatrix:Matrix

    Accesses the cacheAsBitmapMatrix property.

    staticread onlycaretIndex:Int

    Accesses the caretIndex property (for TextField instances only).

    staticcondenseWhite:Bool

    Accesses the condenseWhite property (for TextField instances only).

    staticread onlycurrentFrame:Int

    Accesses the currentFrame property (for MovieClip instances only).

    staticread onlycurrentFrameLabel:String

    Accesses the currentFrameLabel property (for MovieClip instances only).

    staticread onlycurrentLabel:String

    Accesses the currentLabel property (for MovieClip instances only).

    staticread onlycurrentLabels:Array<FrameLabel>

    Accesses the currentLabels property (for MovieClip instances only).

    staticread onlycurrentScene:Scene

    Accesses the currentScene property (for MovieClip instances only).

    staticdeblocking:Int

    Accesses the deblocking property (for Video instances only).

    staticdefaultTextFormat:TextFormat

    Accesses the defaultTextFormat property (for TextField instances only).

    staticdisplayAsPassword:Bool

    Accesses the displayAsPassword property (for TextField instances only).

    staticdoubleClickEnabled:Bool

    Accesses the doubleClickEnabled property (for InteractiveObject instances only).

    staticread onlydropTarget:DisplayObject

    Accesses the dropTarget property (for Sprite instances only).

    staticembedFonts:Bool

    Accesses the embedFonts property (for TextField instances only).

    staticenabled:Bool

    Accesses the enabled property (for MovieClip instances only).

    staticfilters:Array<BitmapFilter>

    Accesses the filters property.

    staticfocusRect:Null<Bool>

    Accesses the focusRect property (for InteractiveObject instances only).

    staticread onlyframesLoaded:Int

    Accesses the framesLoaded property (for MovieClip instances only).

    staticread onlygraphics:Graphics

    Accesses the graphics property (for Shape or Sprite instances only).

    staticgridFitType:GridFitType

    Accesses the gridFitType property (for TextField instances only).

    staticheight:Float

    Accesses the height property.

    statichitArea:Sprite

    Accesses the hitArea property (for Sprite instances only).

    statichtmlText:UTF8String

    Accesses the htmlText property (for TextField instances only).

    staticread onlyisPlaying:Bool

    Accesses the isPlaying property (for MovieClip instances only).

    staticread onlylength:Int

    Accesses the length property (for TextField instances only).

    staticread onlyloaderInfo:LoaderInfo

    Accesses the loaderInfo property.

    staticmask:DisplayObject

    Accesses the mask property.

    staticmaxChars:Int

    Accesses the maxChars property (for TextField instances only).

    staticread onlymaxScrollH:Int

    Accesses the maxScrollH property (for TextField instances only).

    staticread onlymaxScrollV:Int

    Accesses the maxScrollV property (for TextField instances only).

    staticmouseChildren:Bool

    Accesses the mouseChildren property (for DisplayObjectContainer instances only).

    staticmouseEnabled:Bool

    Accesses the mouseEnabled property (for InteractiveObject instances only).

    staticmouseWheelEnabled:Bool

    Accesses the mouseWheelEnabled property (for TextField instances only).

    staticread onlymouseX:Float

    Accesses the mouseX property.

    staticread onlymouseY:Float

    Accesses the mouseY property.

    staticmultiline:Bool

    Accesses the multiline property (for TextField instances only).

    staticname:String

    Accesses the name property.

    staticneedsSoftKeyboard:Bool

    Accesses the needsSoftKeyboard property (for InteractiveObject instances only).

    staticread onlynumChildren:Int

    Accesses the numChildren property (for DisplayObjectContainer instances only).

    staticread onlynumLines:Int

    Accesses the numLines property (for TextField instances only).

    staticread onlynumTiles:Int

    Accesses the numTiles property (for Tilemap instances only).

    staticopaqueBackground:Null<Int>

    Accesses the opaqueBackground property.

    staticpixelSnapping:PixelSnapping

    Accesses the pixelSnapping property (for Bitmap instances only).

    staticrestrict:UTF8String

    Accesses the restrict property (for TextField instances only).

    staticread onlyroot:DisplayObject

    Accesses the root property.

    staticrotation:Float

    Accesses the rotation property.

    staticscale9Grid:Rectangle

    Accesses the scale9Grid property.

    staticscaleX:Float

    Accesses the scaleX property.

    staticscaleY:Float

    Accesses the scaleY property.

    staticread onlyscenes:Array<Scene>

    Accesses the scenes property (for MovieClip instances only).

    staticscrollH:Int

    Accesses the scrollH property (for TextField instances only).

    staticscrollRect:Rectangle

    Accesses the scrollRect property.

    staticscrollV:Int

    Accesses the scrollV property (for TextField instances only).

    staticselectable:Bool

    Accesses the selectable property (for TextField instances only).

    staticread onlyselectionBeginIndex:Int

    Accesses the selectionBeginIndex property (for TextField instances only).

    staticread onlyselectionEndIndex:Int

    Accesses the selectionEndIndex property (for TextField instances only).

    staticshader:Shader

    Accesses the shader property.

    staticsharpness:Float

    Accesses the sharpness property (for TextField instances only).

    staticsmoothing:Bool

    Accesses the smoothing property (for Video or Bitmap instances only).

    staticsoftKeyboardInputAreaOfInterest:Rectangle

    Accesses the softKeyboardInputAreaOfInterest property (for InteractiveObject instances only).

    staticread onlystage:Stage

    Accesses the stage property.

    staticstyleSheet:StyleSheet

    Accesses the styleSheet property (for TextField instances only).

    statictabChildren:Bool

    Accesses the tabChildren property (for DisplayObjectContainer instances only).

    statictabEnabled:Bool

    Accesses the tabEnabled property (for InteractiveObject instances only).

    statictabIndex:Int

    Accesses the tabIndex property (for InteractiveObject instances only).

    statictext:UTF8String

    Accesses the text property (for StaticText or TextField instances only).

    statictextColor:Int

    Accesses the textColor property (for TextField instances only).

    staticread onlytextHeight:Float

    Accesses the textHeight property (for TextField instances only).

    staticread onlytextWidth:Float

    Accesses the textWidth property (for TextField instances only).

    statictileAlphaEnabled:Bool

    Accesses the tileAlphaEnabled property (for Tilemap instances only).

    statictileBlendModeEnabled:Bool

    Accesses the tileBlendModeEnabled property (for Tilemap instances only).

    statictileColorTransformEnabled:Bool

    Accesses the tileColorTransformEnabled property (for Tilemap instances only).

    statictileset:Tileset

    Accesses the tileset property (for Tilemap instances only).

    staticread onlytotalFrames:Int

    Accesses the totalFrames property (for MovieClip instances only).

    statictransform:Transform

    Accesses the transform property.

    statictype:TextFieldType

    Accesses the type property (for TextField instances only).

    staticuseHandCursor:Bool

    Accesses the useHandCursor property (for Sprite instances only).

    staticread onlyvideoWidth:Int

    Accesses the videoWidth property (for Video instances only).

    staticvisible:Bool

    Accesses the visible property.

    staticwidth:Float

    Accesses the width property.

    staticwordWrap:Bool

    Accesses the wordWrap property (for TextField instances only).

    staticx:Float

    Accesses the x property.

    staticy:Float

    Accesses the y property.

    Static methods

    staticaddChild(this:T, child:DisplayObject):DisplayObject

    Accesses the addChild method (for DisplayObjectContainer instances only).

    staticaddChildAt(this:T, child:DisplayObject, index:Int):DisplayObject

    Accesses the addChildAt method (for DisplayObjectContainer instances only).

    @:value({ useWeakReference : false, priority : 0, useCapture : false })staticaddEventListener<T2>(this:T, type:EventType<T2>, listener:T2 ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

    Accesses the addEventListener method.

    staticaddFrameScript(this:T, index:Int, method:() ‑> Void):Void

    Accesses the addFrameScript method (for MovieClip instances only).

    staticaddTile(this:T, tile:Tile):Tile

    Accesses the addTile method (for Tilemap instances only).

    staticaddTileAt(this:T, tile:Tile, index:Int):Tile

    Accesses the addTileAt method (for Tilemap instances only).

    staticaddTiles(this:T, tiles:Array<Tile>):Array<Tile>

    Accesses the addTiles method (for Tilemap instances only).

    staticappendText(this:T, text:String):Void

    Accesses the appendText method (for TextField instances only).

    staticareInaccessibleObjectsUnderPoint(this:T, point:Point):Bool

    Accesses the areInaccessibleObjectsUnderPoint method (for DisplayObjectContainer instances only).

    staticattachNetStream(this:T, netStream:NetStream):Void

    Accesses the attachNetStream method (for Video instances only).

    staticattachTimeline(this:T, timeline:Timeline):Void

    Accesses the attachTimeline method (for MovieClip instances only).

    staticclear(this:T):Void

    Accesses the clear method (for Video instances only).

    staticcontains(this:T, child:Dynamic):Bool

    Accesses the contains method (for Tilemap or DisplayObjectContainer instances only).

    staticdispatchEvent(this:T, event:Event):Bool

    Accesses the dispatchEvent method.

    staticgetBounds(this:T, targetCoordinateSpace:DisplayObject):Rectangle

    Accesses the getBounds method.

    staticgetCharBoundaries(this:T, charIndex:Int):Rectangle

    Accesses the getCharBoundaries method (for TextField instances only).

    staticgetCharIndexAtPoint(this:T, x:Float, y:Float):Int

    Accesses the getCharIndexAtPoint method (for TextField instances only).

    staticgetChildAt(this:T, index:Int):DisplayObject

    Accesses the getChildAt method (for DisplayObjectContainer instances only).

    staticgetChildByName(this:T, name:String):DisplayObject

    Accesses the getChildByName method (for DisplayObjectContainer instances only).

    staticgetChildIndex(this:T, child:DisplayObject):Int

    Accesses the getChildIndex method (for DisplayObjectContainer instances only).

    staticgetFirstCharInParagraph(this:T, charIndex:Int):Int

    Accesses the getFirstCharInParagraph method (for TextField instances only).

    staticgetLineIndexAtPoint(this:T, x:Float, y:Float):Int

    Accesses the getLineIndexAtPoint method (for TextField instances only).

    staticgetLineIndexOfChar(this:T, charIndex:Int):Int

    Accesses the getLineIndexOfChar method (for TextField instances only).

    staticgetLineLength(this:T, lineIndex:Int):Int

    Accesses the getLineLength method (for TextField instances only).

    staticgetLineMetrics(this:T, lineIndex:Int):TextLineMetrics

    Accesses the getLineMetrics method (for TextField instances only).

    staticgetLineOffset(this:T, lineIndex:Int):Int

    Accesses the getLineOffset method (for TextField instances only).

    staticgetLineText(this:T, lineIndex:Int):String

    Accesses the getLineText method (for TextField instances only).

    staticgetObjectsUnderPoint(this:T, point:Point):Array<DisplayObject>

    Accesses the getObjectsUnderPoint method (for DisplayObjectContainer instances only).

    staticgetParagraphLength(this:T, charIndex:Int):Int

    Accesses the getParagraphLength method (for TextField instances only).

    staticgetRect(this:T, targetCoordinateSpace:DisplayObject):Rectangle

    Accesses the getRect method.

    @:value({ endIndex : -1, beginIndex : -1 })staticgetTextFormat(this:T, beginIndex:Int = -1, endIndex:Int = -1):TextFormat

    Accesses the getTextFormat method (for TextField instances only).

    staticgetTileAt(this:T, index:Int):Tile

    Accesses the getTileAt method (for Tilemap instances only).

    staticgetTileIndex(this:T, tile:Tile):Int

    Accesses the getTileIndex method (for Tilemap instances only).

    staticgetTiles(this:T):TileContainer

    Accesses the getTiles method (for Tilemap instances only).

    staticglobalToLocal(this:T, pos:Point):Point

    Accesses the globalToLocal method.

    @:value({ scene : null })staticgotoAndPlay(this:T, frame:Any, ?scene:String):Void

    Accesses the gotoAndPlay method (for MovieClip instances only).

    @:value({ scene : null })staticgotoAndStop(this:T, frame:Any, ?scene:String):Void

    Accesses the gotoAndStop method (for MovieClip instances only).

    statichasEventListener(this:T, type:String):Bool

    Accesses the hasEventListener method.

    statichitTestObject(this:T, obj:DisplayObject):Bool

    Accesses the hitTestObject method.

    @:value({ shapeFlag : false })statichitTestPoint(this:T, x:Float, y:Float, shapeFlag:Bool = false):Bool

    Accesses the hitTestPoint method.

    staticinvalidate(this:T):Void

    Accesses the invalidate method.

    staticlocalToGlobal(this:T, point:Point):Point

    Accesses the localToGlobal method.

    staticnextFrame(this:T):Void

    Accesses the nextFrame method (for MovieClip instances only).

    staticnextScene(this:T):Void

    Accesses the nextScene method (for MovieClip instances only).

    staticplay(this:T):Void

    Accesses the play method (for MovieClip instances only).

    staticprevFrame(this:T):Void

    Accesses the prevFrame method (for MovieClip instances only).

    staticprevScene(this:T):Void

    Accesses the prevScene method (for MovieClip instances only).

    staticremoveChild(this:T, child:DisplayObject):DisplayObject

    Accesses the removeChild method (for DisplayObjectContainer instances only).

    staticremoveChildAt(this:T, index:Int):DisplayObject

    Accesses the removeChildAt method (for DisplayObjectContainer instances only).

    @:value({ endIndex : 0x7FFFFFFF, beginIndex : 0 })staticremoveChildren(this:T, beginIndex:Int = 0, endIndex:Int = 0x7FFFFFFF):Void

    Accesses the removeChildren method (for DisplayObjectContainer instances only).

    @:value({ useCapture : false })staticremoveEventListener<T2>(this:T, type:EventType<T2>, listener:T2 ‑> Void, useCapture:Bool = false):Void

    Accesses the removeEventListener method.

    staticremoveTile(this:T, tile:Tile):Tile

    Accesses the removeTile method (for Tilemap instances only).

    staticremoveTileAt(this:T, index:Int):Tile

    Accesses the removeTileAt method (for Tilemap instances only).

    @:value({ endIndex : 0x7fffffff, beginIndex : 0 })staticremoveTiles(this:T, beginIndex:Int = 0, endIndex:Int = 0x7fffffff):Void

    Accesses the removeTiles method (for Tilemap instances only).

    staticreplaceSelectedText(this:T, value:String):Void

    Accesses the replaceSelectedText method (for TextField instances only).

    staticreplaceText(this:T, beginIndex:Int, endIndex:Int, newText:String):Void

    Accesses the replaceText method (for TextField instances only).

    staticrequestSoftKeyboard(this:T):Bool

    Accesses the requestSoftKeyboard method (for InteractiveObject instances only).

    staticsetChildIndex(this:T, child:DisplayObject, index:Int):Void

    Accesses the setChildIndex method (for DisplayObjectContainer instances only).

    staticsetSelection(this:T, beginIndex:Int, endIndex:Int):Void

    Accesses the setSelection method (for TextField instances only).

    @:value({ endIndex : -1, beginIndex : -1 })staticsetTextFormat(this:T, format:TextFormat, beginIndex:Int = -1, endIndex:Int = -1):Void

    Accesses the setTextFormat method (for TextField instances only).

    staticsetTileIndex(this:T, tile:Tile, index:Int):Void

    Accesses the setTileIndex method (for Tilemap instances only).

    staticsetTiles(this:T, group:TileContainer):Void

    Accesses the setTiles method (for Tilemap instances only).

    staticsortTiles(this:T, compareFunction:(Tile, Tile) ‑> Int):Void

    Accesses the sortTiles method (for Tilemap instances only).

    @:value({ bounds : null, lockCenter : false })staticstartDrag(this:T, lockCenter:Bool = false, ?bounds:Rectangle):Void

    Accesses the startDrag method (for Sprite instances only).

    staticstop(this:T):Void

    Accesses the stop method (for MovieClip instances only).

    staticstopAllMovieClips(this:T):Void

    Accesses the stopAllMovieClips method (for DisplayObjectContainer instances only).

    staticstopDrag(this:T):Void

    Accesses the stopDrag method (for Sprite instances only).

    staticswapChildren(this:T, child1:DisplayObject, child2:DisplayObject):Void

    Accesses the swapChildren method (for DisplayObjectContainer instances only).

    staticswapChildrenAt(this:T, index1:Int, index2:Int):Void

    Accesses the swapChildrenAt method (for DisplayObjectContainer instances only).

    staticswapTiles(this:T, tile1:Tile, tile2:Tile):Void

    Accesses the swapTiles method (for Tilemap instances only).

    staticswapTilesAt(this:T, index1:Int, index2:Int):Void

    Accesses the swapTilesAt method (for Tilemap instances only).

    statictoString(this:T):String

    Accesses the toString method.

    staticwillTrigger(this:T, type:String):Bool

    Accesses the willTrigger method.

    \ No newline at end of file +movieClip.sprite["sprite2"].x = 100;

    Static variables

    staticalpha:Float

    Accesses the alpha property.

    staticantiAliasType:AntiAliasType

    Accesses the antiAliasType property (for TextField instances only).

    staticautoSize:TextFieldAutoSize

    Accesses the autoSize property (for TextField instances only).

    staticbackground:Bool

    Accesses the background property (for TextField instances only).

    staticbackgroundColor:Int

    Accesses the backgroundColor property (for TextField instances only).

    staticbitmapData:BitmapData

    Accesses the bitmapData property (for Bitmap instances only).

    staticblendMode:BlendMode

    Accesses the blendMode property.

    staticborder:Bool

    Accesses the border property (for TextField instances only).

    staticborderColor:Int

    Accesses the borderColor property (for TextField instances only).

    staticread onlybottomScrollV:Int

    Accesses the bottomScrollV property (for TextField instances only).

    staticbuttonMode:Bool

    Accesses the buttonMode property (for Sprite instances only).

    staticcacheAsBitmap:Bool

    Accesses the cacheAsBitmap property.

    staticcacheAsBitmapMatrix:Matrix

    Accesses the cacheAsBitmapMatrix property.

    staticread onlycaretIndex:Int

    Accesses the caretIndex property (for TextField instances only).

    staticcondenseWhite:Bool

    Accesses the condenseWhite property (for TextField instances only).

    staticread onlycurrentFrame:Int

    Accesses the currentFrame property (for MovieClip instances only).

    staticread onlycurrentFrameLabel:String

    Accesses the currentFrameLabel property (for MovieClip instances only).

    staticread onlycurrentLabel:String

    Accesses the currentLabel property (for MovieClip instances only).

    staticread onlycurrentLabels:Array<FrameLabel>

    Accesses the currentLabels property (for MovieClip instances only).

    staticread onlycurrentScene:Scene

    Accesses the currentScene property (for MovieClip instances only).

    staticdeblocking:Int

    Accesses the deblocking property (for Video instances only).

    staticdefaultTextFormat:TextFormat

    Accesses the defaultTextFormat property (for TextField instances only).

    staticdisplayAsPassword:Bool

    Accesses the displayAsPassword property (for TextField instances only).

    staticdoubleClickEnabled:Bool

    Accesses the doubleClickEnabled property (for InteractiveObject instances only).

    staticread onlydropTarget:DisplayObject

    Accesses the dropTarget property (for Sprite instances only).

    staticembedFonts:Bool

    Accesses the embedFonts property (for TextField instances only).

    staticenabled:Bool

    Accesses the enabled property (for MovieClip instances only).

    staticfilters:Array<BitmapFilter>

    Accesses the filters property.

    staticfocusRect:Null<Bool>

    Accesses the focusRect property (for InteractiveObject instances only).

    staticread onlyframesLoaded:Int

    Accesses the framesLoaded property (for MovieClip instances only).

    staticread onlygraphics:Graphics

    Accesses the graphics property (for Shape or Sprite instances only).

    staticgridFitType:GridFitType

    Accesses the gridFitType property (for TextField instances only).

    staticheight:Float

    Accesses the height property.

    statichitArea:Sprite

    Accesses the hitArea property (for Sprite instances only).

    statichtmlText:UTF8String

    Accesses the htmlText property (for TextField instances only).

    staticread onlyisPlaying:Bool

    Accesses the isPlaying property (for MovieClip instances only).

    staticread onlylength:Int

    Accesses the length property (for TextField instances only).

    staticread onlyloaderInfo:LoaderInfo

    Accesses the loaderInfo property.

    staticmask:DisplayObject

    Accesses the mask property.

    staticmaxChars:Int

    Accesses the maxChars property (for TextField instances only).

    staticread onlymaxScrollH:Int

    Accesses the maxScrollH property (for TextField instances only).

    staticread onlymaxScrollV:Int

    Accesses the maxScrollV property (for TextField instances only).

    staticmouseChildren:Bool

    Accesses the mouseChildren property (for DisplayObjectContainer instances only).

    staticmouseEnabled:Bool

    Accesses the mouseEnabled property (for InteractiveObject instances only).

    staticmouseWheelEnabled:Bool

    Accesses the mouseWheelEnabled property (for TextField instances only).

    staticread onlymouseX:Float

    Accesses the mouseX property.

    staticread onlymouseY:Float

    Accesses the mouseY property.

    staticmultiline:Bool

    Accesses the multiline property (for TextField instances only).

    staticname:String

    Accesses the name property.

    staticneedsSoftKeyboard:Bool

    Accesses the needsSoftKeyboard property (for InteractiveObject instances only).

    staticread onlynumChildren:Int

    Accesses the numChildren property (for DisplayObjectContainer instances only).

    staticread onlynumLines:Int

    Accesses the numLines property (for TextField instances only).

    staticread onlynumTiles:Int

    Accesses the numTiles property (for Tilemap instances only).

    staticopaqueBackground:Null<Int>

    Accesses the opaqueBackground property.

    staticpixelSnapping:PixelSnapping

    Accesses the pixelSnapping property (for Bitmap instances only).

    staticrestrict:UTF8String

    Accesses the restrict property (for TextField instances only).

    staticread onlyroot:DisplayObject

    Accesses the root property.

    staticrotation:Float

    Accesses the rotation property.

    staticscale9Grid:Rectangle

    Accesses the scale9Grid property.

    staticscaleX:Float

    Accesses the scaleX property.

    staticscaleY:Float

    Accesses the scaleY property.

    staticread onlyscenes:Array<Scene>

    Accesses the scenes property (for MovieClip instances only).

    staticscrollH:Int

    Accesses the scrollH property (for TextField instances only).

    staticscrollRect:Rectangle

    Accesses the scrollRect property.

    staticscrollV:Int

    Accesses the scrollV property (for TextField instances only).

    staticselectable:Bool

    Accesses the selectable property (for TextField instances only).

    staticread onlyselectionBeginIndex:Int

    Accesses the selectionBeginIndex property (for TextField instances only).

    staticread onlyselectionEndIndex:Int

    Accesses the selectionEndIndex property (for TextField instances only).

    staticshader:Shader

    Accesses the shader property.

    staticsharpness:Float

    Accesses the sharpness property (for TextField instances only).

    staticsmoothing:Bool

    Accesses the smoothing property (for Video or Bitmap instances only).

    staticsoftKeyboardInputAreaOfInterest:Rectangle

    Accesses the softKeyboardInputAreaOfInterest property (for InteractiveObject instances only).

    staticread onlystage:Stage

    Accesses the stage property.

    staticstyleSheet:StyleSheet

    Accesses the styleSheet property (for TextField instances only).

    statictabChildren:Bool

    Accesses the tabChildren property (for DisplayObjectContainer instances only).

    statictabEnabled:Bool

    Accesses the tabEnabled property (for InteractiveObject instances only).

    statictabIndex:Int

    Accesses the tabIndex property (for InteractiveObject instances only).

    statictext:UTF8String

    Accesses the text property (for StaticText or TextField instances only).

    statictextColor:Int

    Accesses the textColor property (for TextField instances only).

    staticread onlytextHeight:Float

    Accesses the textHeight property (for TextField instances only).

    staticread onlytextWidth:Float

    Accesses the textWidth property (for TextField instances only).

    statictileAlphaEnabled:Bool

    Accesses the tileAlphaEnabled property (for Tilemap instances only).

    statictileBlendModeEnabled:Bool

    Accesses the tileBlendModeEnabled property (for Tilemap instances only).

    statictileColorTransformEnabled:Bool

    Accesses the tileColorTransformEnabled property (for Tilemap instances only).

    statictileset:Tileset

    Accesses the tileset property (for Tilemap instances only).

    staticread onlytotalFrames:Int

    Accesses the totalFrames property (for MovieClip instances only).

    statictransform:Transform

    Accesses the transform property.

    statictype:TextFieldType

    Accesses the type property (for TextField instances only).

    staticuseHandCursor:Bool

    Accesses the useHandCursor property (for Sprite instances only).

    staticread onlyvideoWidth:Int

    Accesses the videoWidth property (for Video instances only).

    staticvisible:Bool

    Accesses the visible property.

    staticwidth:Float

    Accesses the width property.

    staticwordWrap:Bool

    Accesses the wordWrap property (for TextField instances only).

    staticx:Float

    Accesses the x property.

    staticy:Float

    Accesses the y property.

    Static methods

    staticaddChild(this:T, child:DisplayObject):DisplayObject

    Accesses the addChild method (for DisplayObjectContainer instances only).

    staticaddChildAt(this:T, child:DisplayObject, index:Int):DisplayObject

    Accesses the addChildAt method (for DisplayObjectContainer instances only).

    @:value({ useWeakReference : false, priority : 0, useCapture : false })staticaddEventListener<T2>(this:T, type:EventType<T2>, listener:T2 ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

    Accesses the addEventListener method.

    staticaddFrameScript(this:T, index:Int, method:() ‑> Void):Void

    Accesses the addFrameScript method (for MovieClip instances only).

    staticaddTile(this:T, tile:Tile):Tile

    Accesses the addTile method (for Tilemap instances only).

    staticaddTileAt(this:T, tile:Tile, index:Int):Tile

    Accesses the addTileAt method (for Tilemap instances only).

    staticaddTiles(this:T, tiles:Array<Tile>):Array<Tile>

    Accesses the addTiles method (for Tilemap instances only).

    staticappendText(this:T, text:String):Void

    Accesses the appendText method (for TextField instances only).

    staticareInaccessibleObjectsUnderPoint(this:T, point:Point):Bool

    Accesses the areInaccessibleObjectsUnderPoint method (for DisplayObjectContainer instances only).

    staticattachNetStream(this:T, netStream:NetStream):Void

    Accesses the attachNetStream method (for Video instances only).

    staticattachTimeline(this:T, timeline:Timeline):Void

    Accesses the attachTimeline method (for MovieClip instances only).

    staticclear(this:T):Void

    Accesses the clear method (for Video instances only).

    staticcontains(this:T, child:Dynamic):Bool

    Accesses the contains method (for Tilemap or DisplayObjectContainer instances only).

    staticdispatchEvent(this:T, event:Event):Bool

    Accesses the dispatchEvent method.

    staticgetBounds(this:T, targetCoordinateSpace:DisplayObject):Rectangle

    Accesses the getBounds method.

    staticgetCharBoundaries(this:T, charIndex:Int):Rectangle

    Accesses the getCharBoundaries method (for TextField instances only).

    staticgetCharIndexAtPoint(this:T, x:Float, y:Float):Int

    Accesses the getCharIndexAtPoint method (for TextField instances only).

    staticgetChildAt(this:T, index:Int):DisplayObject

    Accesses the getChildAt method (for DisplayObjectContainer instances only).

    staticgetChildByName(this:T, name:String):DisplayObject

    Accesses the getChildByName method (for DisplayObjectContainer instances only).

    staticgetChildIndex(this:T, child:DisplayObject):Int

    Accesses the getChildIndex method (for DisplayObjectContainer instances only).

    staticgetFirstCharInParagraph(this:T, charIndex:Int):Int

    Accesses the getFirstCharInParagraph method (for TextField instances only).

    staticgetLineIndexAtPoint(this:T, x:Float, y:Float):Int

    Accesses the getLineIndexAtPoint method (for TextField instances only).

    staticgetLineIndexOfChar(this:T, charIndex:Int):Int

    Accesses the getLineIndexOfChar method (for TextField instances only).

    staticgetLineLength(this:T, lineIndex:Int):Int

    Accesses the getLineLength method (for TextField instances only).

    staticgetLineMetrics(this:T, lineIndex:Int):TextLineMetrics

    Accesses the getLineMetrics method (for TextField instances only).

    staticgetLineOffset(this:T, lineIndex:Int):Int

    Accesses the getLineOffset method (for TextField instances only).

    staticgetLineText(this:T, lineIndex:Int):String

    Accesses the getLineText method (for TextField instances only).

    staticgetObjectsUnderPoint(this:T, point:Point):Array<DisplayObject>

    Accesses the getObjectsUnderPoint method (for DisplayObjectContainer instances only).

    staticgetParagraphLength(this:T, charIndex:Int):Int

    Accesses the getParagraphLength method (for TextField instances only).

    staticgetRect(this:T, targetCoordinateSpace:DisplayObject):Rectangle

    Accesses the getRect method.

    @:value({ endIndex : -1, beginIndex : -1 })staticgetTextFormat(this:T, beginIndex:Int = -1, endIndex:Int = -1):TextFormat

    Accesses the getTextFormat method (for TextField instances only).

    staticgetTileAt(this:T, index:Int):Tile

    Accesses the getTileAt method (for Tilemap instances only).

    staticgetTileIndex(this:T, tile:Tile):Int

    Accesses the getTileIndex method (for Tilemap instances only).

    staticgetTiles(this:T):TileContainer

    Accesses the getTiles method (for Tilemap instances only).

    staticglobalToLocal(this:T, pos:Point):Point

    Accesses the globalToLocal method.

    @:value({ scene : null })staticgotoAndPlay(this:T, frame:Any, ?scene:String):Void

    Accesses the gotoAndPlay method (for MovieClip instances only).

    @:value({ scene : null })staticgotoAndStop(this:T, frame:Any, ?scene:String):Void

    Accesses the gotoAndStop method (for MovieClip instances only).

    statichasEventListener(this:T, type:String):Bool

    Accesses the hasEventListener method.

    statichitTestObject(this:T, obj:DisplayObject):Bool

    Accesses the hitTestObject method.

    @:value({ shapeFlag : false })statichitTestPoint(this:T, x:Float, y:Float, shapeFlag:Bool = false):Bool

    Accesses the hitTestPoint method.

    staticinvalidate(this:T):Void

    Accesses the invalidate method.

    staticlocalToGlobal(this:T, point:Point):Point

    Accesses the localToGlobal method.

    staticnextFrame(this:T):Void

    Accesses the nextFrame method (for MovieClip instances only).

    staticnextScene(this:T):Void

    Accesses the nextScene method (for MovieClip instances only).

    staticplay(this:T):Void

    Accesses the play method (for MovieClip instances only).

    staticprevFrame(this:T):Void

    Accesses the prevFrame method (for MovieClip instances only).

    staticprevScene(this:T):Void

    Accesses the prevScene method (for MovieClip instances only).

    staticremoveChild(this:T, child:DisplayObject):DisplayObject

    Accesses the removeChild method (for DisplayObjectContainer instances only).

    staticremoveChildAt(this:T, index:Int):DisplayObject

    Accesses the removeChildAt method (for DisplayObjectContainer instances only).

    @:value({ endIndex : 0x7FFFFFFF, beginIndex : 0 })staticremoveChildren(this:T, beginIndex:Int = 0, endIndex:Int = 0x7FFFFFFF):Void

    Accesses the removeChildren method (for DisplayObjectContainer instances only).

    @:value({ useCapture : false })staticremoveEventListener<T2>(this:T, type:EventType<T2>, listener:T2 ‑> Void, useCapture:Bool = false):Void

    Accesses the removeEventListener method.

    staticremoveTile(this:T, tile:Tile):Tile

    Accesses the removeTile method (for Tilemap instances only).

    staticremoveTileAt(this:T, index:Int):Tile

    Accesses the removeTileAt method (for Tilemap instances only).

    @:value({ endIndex : 0x7fffffff, beginIndex : 0 })staticremoveTiles(this:T, beginIndex:Int = 0, endIndex:Int = 0x7fffffff):Void

    Accesses the removeTiles method (for Tilemap instances only).

    staticreplaceSelectedText(this:T, value:String):Void

    Accesses the replaceSelectedText method (for TextField instances only).

    staticreplaceText(this:T, beginIndex:Int, endIndex:Int, newText:String):Void

    Accesses the replaceText method (for TextField instances only).

    staticrequestSoftKeyboard(this:T):Bool

    Accesses the requestSoftKeyboard method (for InteractiveObject instances only).

    staticsetChildIndex(this:T, child:DisplayObject, index:Int):Void

    Accesses the setChildIndex method (for DisplayObjectContainer instances only).

    staticsetSelection(this:T, beginIndex:Int, endIndex:Int):Void

    Accesses the setSelection method (for TextField instances only).

    @:value({ endIndex : -1, beginIndex : -1 })staticsetTextFormat(this:T, format:TextFormat, beginIndex:Int = -1, endIndex:Int = -1):Void

    Accesses the setTextFormat method (for TextField instances only).

    staticsetTileIndex(this:T, tile:Tile, index:Int):Void

    Accesses the setTileIndex method (for Tilemap instances only).

    staticsetTiles(this:T, group:TileContainer):Void

    Accesses the setTiles method (for Tilemap instances only).

    staticsortTiles(this:T, compareFunction:(Tile, Tile) ‑> Int):Void

    Accesses the sortTiles method (for Tilemap instances only).

    @:value({ bounds : null, lockCenter : false })staticstartDrag(this:T, lockCenter:Bool = false, ?bounds:Rectangle):Void

    Accesses the startDrag method (for Sprite instances only).

    staticstop(this:T):Void

    Accesses the stop method (for MovieClip instances only).

    staticstopAllMovieClips(this:T):Void

    Accesses the stopAllMovieClips method (for DisplayObjectContainer instances only).

    staticstopDrag(this:T):Void

    Accesses the stopDrag method (for Sprite instances only).

    staticswapChildren(this:T, child1:DisplayObject, child2:DisplayObject):Void

    Accesses the swapChildren method (for DisplayObjectContainer instances only).

    staticswapChildrenAt(this:T, index1:Int, index2:Int):Void

    Accesses the swapChildrenAt method (for DisplayObjectContainer instances only).

    staticswapTiles(this:T, tile1:Tile, tile2:Tile):Void

    Accesses the swapTiles method (for Tilemap instances only).

    staticswapTilesAt(this:T, index1:Int, index2:Int):Void

    Accesses the swapTilesAt method (for Tilemap instances only).

    statictoString(this:T):String

    Accesses the toString method.

    staticwillTrigger(this:T, type:String):Bool

    Accesses the willTrigger method.

    \ No newline at end of file diff --git a/openfl/display/DOMElement.html b/openfl/display/DOMElement.html index af05954..64307ad 100644 --- a/openfl/display/DOMElement.html +++ b/openfl/display/DOMElement.html @@ -347,7 +347,7 @@ property of the scrollRect Rectangle object. You can scroll an object up and down by setting the y property of the scrollRect Rectangle object. If the display object is rotated -90� and you scroll it left and right, the display object actually scrolls +90° and you scroll it left and right, the display object actually scrolls up and down.

    @:betashader:Shader

    BETA**

    Applies a custom Shader object to use when rendering this display object (or its children) when using hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to @@ -399,16 +399,16 @@ to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

    Inherited Methods

    Defined by DisplayObject

    getBounds(targetCoordinateSpace:DisplayObject):Rectangle

    Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object. Consider the following code, which shows how the rectangle returned can @@ -495,4 +495,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/display/DOMRenderer.html b/openfl/display/DOMRenderer.html index 92cdf5e..b310eb0 100644 --- a/openfl/display/DOMRenderer.html +++ b/openfl/display/DOMRenderer.html @@ -178,4 +178,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/display/DisplayObject.html b/openfl/display/DisplayObject.html index ed8a7ac..7a1b0e8 100644 --- a/openfl/display/DisplayObject.html +++ b/openfl/display/DisplayObject.html @@ -460,7 +460,7 @@ property of the scrollRect Rectangle object. You can scroll an object up and down by setting the y property of the scrollRect Rectangle object. If the display object is rotated -90� and you scroll it left and right, the display object actually scrolls +90° and you scroll it left and right, the display object actually scrolls up and down.

    @:betashader:Shader

    BETA**

    Applies a custom Shader object to use when rendering this display object (or its children) when using hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to @@ -512,16 +512,16 @@ to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

    Methods

    getBounds(targetCoordinateSpace:DisplayObject):Rectangle

    Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object. Consider the following code, which shows how the rectangle returned can @@ -608,4 +608,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/display/DisplayObjectContainer.html b/openfl/display/DisplayObjectContainer.html index 84b14c8..233845a 100644 --- a/openfl/display/DisplayObjectContainer.html +++ b/openfl/display/DisplayObjectContainer.html @@ -621,7 +621,7 @@ property of the scrollRect Rectangle object. You can scroll an object up and down by setting the y property of the scrollRect Rectangle object. If the display object is rotated -90� and you scroll it left and right, the display object actually scrolls +90° and you scroll it left and right, the display object actually scrolls up and down.

    @:betashader:Shader

    BETA**

    Applies a custom Shader object to use when rendering this display object (or its children) when using hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to @@ -673,16 +673,16 @@ to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

    Inherited Methods

    Defined by InteractiveObject

    requestSoftKeyboard():Bool

    Raises a virtual keyboard.

    Calling this method focuses the InteractiveObject instance and raises the soft keyboard, if necessary. The needsSoftKeyboard must @@ -778,4 +778,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/display/DisplayObjectRenderer.html b/openfl/display/DisplayObjectRenderer.html index f76ab11..4db1c15 100644 --- a/openfl/display/DisplayObjectRenderer.html +++ b/openfl/display/DisplayObjectRenderer.html @@ -173,4 +173,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/display/DisplayObjectShader.html b/openfl/display/DisplayObjectShader.html index 3fe36a2..4f17b8d 100644 --- a/openfl/display/DisplayObjectShader.html +++ b/openfl/display/DisplayObjectShader.html @@ -81,4 +81,4 @@

    The precision mode selection affects the following shader operations. These operations are faster on an Intel processor with the SSE instruction set:

    program:Program3D

    The compiled Program3D if available.

    -

    This property is not available on the Flash target.

    Inherited Methods

    \ No newline at end of file +

    This property is not available on the Flash target.

    Inherited Methods

    \ No newline at end of file diff --git a/openfl/display/FPS.html b/openfl/display/FPS.html index 9b69967..0a843b6 100644 --- a/openfl/display/FPS.html +++ b/openfl/display/FPS.html @@ -668,7 +668,7 @@ property of the scrollRect Rectangle object. You can scroll an object up and down by setting the y property of the scrollRect Rectangle object. If the display object is rotated -90� and you scroll it left and right, the display object actually scrolls +90° and you scroll it left and right, the display object actually scrolls up and down.

    @:betashader:Shader

    BETA**

    Applies a custom Shader object to use when rendering this display object (or its children) when using hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to @@ -720,16 +720,16 @@ to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

    Inherited Methods

    Defined by TextField

    appendText(text:String):Void

    Appends the string specified by the newText parameter to the end of the text of the text field. This method is more efficient than an addition assignment(+=) on a text property @@ -921,4 +921,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/display/FocusDirection.html b/openfl/display/FocusDirection.html index 682a74f..df016ad 100644 --- a/openfl/display/FocusDirection.html +++ b/openfl/display/FocusDirection.html @@ -59,4 +59,4 @@ direction property of a FocusEvent object.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyBOTTOM:FocusDirection = 0

    Indicates that focus should be given to the object at the end of the reading order.

    @:value(cast 1)@:impl@:enuminlineread onlyNONE:FocusDirection = 1

    Indicates that focus object within the interactive object should not change.

    @:value(cast 2)@:impl@:enuminlineread onlyTOP:FocusDirection = 2

    Indicates that focus should be given to the object at the beginning of -the reading order.

    \ No newline at end of file +the reading order.

    \ No newline at end of file diff --git a/openfl/display/FrameLabel.html b/openfl/display/FrameLabel.html index b43c387..fb6306f 100644 --- a/openfl/display/FrameLabel.html +++ b/openfl/display/FrameLabel.html @@ -177,4 +177,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/display/FrameScript.html b/openfl/display/FrameScript.html index 38edafc..3753e87 100644 --- a/openfl/display/FrameScript.html +++ b/openfl/display/FrameScript.html @@ -52,4 +52,4 @@ .navbar .container img { margin: 5px 0 0 4px; } -

    Constructor

    new(script:MovieClip ‑> Void, frame:Int)

    Variables

    read onlyframe:Int

    read onlyscript:MovieClip ‑> Void

    \ No newline at end of file +

    Constructor

    new(script:MovieClip ‑> Void, frame:Int)

    Variables

    read onlyframe:Int

    read onlyscript:MovieClip ‑> Void

    \ No newline at end of file diff --git a/openfl/display/GradientType.html b/openfl/display/GradientType.html index ff8f9fc..d8c05e3 100644 --- a/openfl/display/GradientType.html +++ b/openfl/display/GradientType.html @@ -58,4 +58,4 @@

    The GradientType class provides values for the type parameter in the beginGradientFill() and lineGradientStyle() methods of the openfl.display.Graphics -class.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyLINEAR:GradientType = 0

    Value used to specify a linear gradient fill.

    @:value(cast 1)@:impl@:enuminlineread onlyRADIAL:GradientType = 1

    Value used to specify a radial gradient fill.

    \ No newline at end of file +class.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyLINEAR:GradientType = 0

    Value used to specify a linear gradient fill.

    @:value(cast 1)@:impl@:enuminlineread onlyRADIAL:GradientType = 1

    Value used to specify a radial gradient fill.

    \ No newline at end of file diff --git a/openfl/display/Graphics.html b/openfl/display/Graphics.html index 7c401c0..b7daa27 100644 --- a/openfl/display/Graphics.html +++ b/openfl/display/Graphics.html @@ -571,4 +571,4 @@ the current display object. A recursive query can take more time and memory to execute. The results are returned in a single flattened result set, not separated by display object.

    Returns:

    A Vector of IGraphicsData objects representing the vector graphics -content of the related display object

    \ No newline at end of file +content of the related display object

    \ No newline at end of file diff --git a/openfl/display/GraphicsBitmapFill.html b/openfl/display/GraphicsBitmapFill.html index b9b0829..00dc283 100644 --- a/openfl/display/GraphicsBitmapFill.html +++ b/openfl/display/GraphicsBitmapFill.html @@ -92,4 +92,4 @@ If false, upscaled bitmap images are rendered by using a nearest-neighbor algorithm and look pixelated. If true, upscaled bitmap images are rendered by using a bilinear algorithm. Rendering by -using the nearest neighbor algorithm is usually faster.

    \ No newline at end of file +using the nearest neighbor algorithm is usually faster.

    \ No newline at end of file diff --git a/openfl/display/GraphicsEndFill.html b/openfl/display/GraphicsEndFill.html index 4b1b048..8585596 100644 --- a/openfl/display/GraphicsEndFill.html +++ b/openfl/display/GraphicsEndFill.html @@ -57,4 +57,4 @@ Graphics.drawGraphicsData() method.

    Drawing a GraphicsEndFill object is the equivalent of calling the Graphics.endFill() method.

    Constructor

    new()

    Creates an object to use with the Graphics.drawGraphicsData() -method to end the fill, explicitly.

    \ No newline at end of file +method to end the fill, explicitly.

    \ No newline at end of file diff --git a/openfl/display/GraphicsGradientFill.html b/openfl/display/GraphicsGradientFill.html index e84587b..a1bfd9f 100644 --- a/openfl/display/GraphicsGradientFill.html +++ b/openfl/display/GraphicsGradientFill.html @@ -140,4 +140,4 @@

    If you use SpreadMethod.REPEAT for the spread method, the gradient fill looks like the following:

    linear gradient with SpreadMethod.REPEAT

    type:GradientType

    A value from the GradientType class that specifies which gradient type -to use. Values are GradientType.LINEAR or GradientType.RADIAL.

    \ No newline at end of file +to use. Values are GradientType.LINEAR or GradientType.RADIAL.

    \ No newline at end of file diff --git a/openfl/display/GraphicsPath.html b/openfl/display/GraphicsPath.html index df57da6..fe955bb 100644 --- a/openfl/display/GraphicsPath.html +++ b/openfl/display/GraphicsPath.html @@ -88,4 +88,4 @@ coordinates to the data vector.

    Parameters:

    x

    The x coordinate of the destination point for the line.

    y

    The y coordinate of the destination point for the line.

    moveTo(x:Float, y:Float):Void

    Adds a new "moveTo" command to the commands vector and new coordinates to the data vector.

    Parameters:

    x

    The x coordinate of the destination point.

    y

    The y coordinate of the destination point.

    wideLineTo(x:Float, y:Float):Void

    Adds a new "wideLineTo" command to the commands vector and new coordinates to the data vector.

    Parameters:

    x

    The x-coordinate of the destination point for the line.

    y

    The y-coordinate of the destination point for the line.

    wideMoveTo(x:Float, y:Float):Void

    Adds a new "wideMoveTo" command to the commands vector and -new coordinates to the data vector.

    Parameters:

    x

    The x-coordinate of the destination point.

    y

    The y-coordinate of the destination point.

    \ No newline at end of file +new coordinates to the data vector.

    Parameters:

    x

    The x-coordinate of the destination point.

    y

    The y-coordinate of the destination point.

    \ No newline at end of file diff --git a/openfl/display/GraphicsPathCommand.html b/openfl/display/GraphicsPathCommand.html index 713823a..df4ca37 100644 --- a/openfl/display/GraphicsPathCommand.html +++ b/openfl/display/GraphicsPathCommand.html @@ -76,4 +76,4 @@ command. This command uses two sets in the data vector: one dummy location and one (x,y) location.

    The WIDE_LINE_TO and WIDE_MOVE_TO command variants consume the same number of -parameters as does the CURVE_TO command.

    \ No newline at end of file +parameters as does the CURVE_TO command.

    \ No newline at end of file diff --git a/openfl/display/GraphicsPathWinding.html b/openfl/display/GraphicsPathWinding.html index bb0a4d1..722b1da 100644 --- a/openfl/display/GraphicsPathWinding.html +++ b/openfl/display/GraphicsPathWinding.html @@ -72,4 +72,4 @@ the same (neither both filled nor both unfilled).

    @:value(cast 1)@:impl@:enuminlineread onlyNON_ZERO:GraphicsPathWinding = 1

    Establishes the non-zero winding type. The non-zero winding type determines that when paths of opposite winding intersect, the intersection area is unfilled (as with the even-odd winding type). For paths of the same winding, the -intersection area is filled.

    \ No newline at end of file +intersection area is filled.

    \ No newline at end of file diff --git a/openfl/display/GraphicsQuadPath.html b/openfl/display/GraphicsQuadPath.html index 562fff8..1aa2f44 100644 --- a/openfl/display/GraphicsQuadPath.html +++ b/openfl/display/GraphicsQuadPath.html @@ -73,4 +73,4 @@ rects) will be treated as [ x, y, ... ] pairs. A transforms Vector that is four times the size of the draw count will be used as matrix [ a, b, c, d, ... ] values. A transforms object which is six times the draw count in size will use full matrix -[ a, b, c, d, tx, ty, ... ] values per draw.

    \ No newline at end of file +[ a, b, c, d, tx, ty, ... ] values per draw.

    \ No newline at end of file diff --git a/openfl/display/GraphicsShader.html b/openfl/display/GraphicsShader.html index 7917566..1655cbc 100644 --- a/openfl/display/GraphicsShader.html +++ b/openfl/display/GraphicsShader.html @@ -81,4 +81,4 @@

    The precision mode selection affects the following shader operations. These operations are faster on an Intel processor with the SSE instruction set:

    program:Program3D

    The compiled Program3D if available.

    -

    This property is not available on the Flash target.

    Inherited Methods

    \ No newline at end of file +

    This property is not available on the Flash target.

    Inherited Methods

    \ No newline at end of file diff --git a/openfl/display/GraphicsShaderFill.html b/openfl/display/GraphicsShaderFill.html index 1cc99e7..e09c981 100644 --- a/openfl/display/GraphicsShaderFill.html +++ b/openfl/display/GraphicsShaderFill.html @@ -81,4 +81,4 @@ internally and the drawing fill operation uses that internal copy, not a reference to the original shader. Any changes made to the shader, such as changing a parameter value, input, or bytecode, are not -applied to the copied shader that's used for the fill.

    \ No newline at end of file +applied to the copied shader that's used for the fill.

    \ No newline at end of file diff --git a/openfl/display/GraphicsSolidFill.html b/openfl/display/GraphicsSolidFill.html index f46b629..8ab5a3a 100644 --- a/openfl/display/GraphicsSolidFill.html +++ b/openfl/display/GraphicsSolidFill.html @@ -61,4 +61,4 @@ transparent) to 1(fully opaque).

    Variables

    alpha:Float

    Indicates the alpha transparency value of the fill. Valid values are 0 (fully transparent) to 1(fully opaque). The default value is 1. Display objects with alpha set to 0 are active, even though they are invisible.

    color:UInt

    The color of the fill. Valid values are in the hexadecimal format -0xRRGGBB. The default value is 0xFF0000(or the uint 0).

    \ No newline at end of file +0xRRGGBB. The default value is 0xFF0000(or the uint 0).

    \ No newline at end of file diff --git a/openfl/display/GraphicsStroke.html b/openfl/display/GraphicsStroke.html index d2d3639..aafd68f 100644 --- a/openfl/display/GraphicsStroke.html +++ b/openfl/display/GraphicsStroke.html @@ -194,4 +194,4 @@ a number is not specified, or if the parameter is undefined, a line is not drawn. If a value of less than 0 is passed, the default is 0. The value 0 indicates hairline thickness; the maximum thickness is 255. If a value -greater than 255 is passed, the default is 255.

    \ No newline at end of file +greater than 255 is passed, the default is 255.

    \ No newline at end of file diff --git a/openfl/display/GraphicsTrianglePath.html b/openfl/display/GraphicsTrianglePath.html index 7692e5c..2b5007f 100644 --- a/openfl/display/GraphicsTrianglePath.html +++ b/openfl/display/GraphicsTrianglePath.html @@ -90,4 +90,4 @@ distance from the eye to the texture in eye space. This helps the rendering engine correctly apply perspective when mapping textures in 3D.

    vertices:Vector<Float>

    A Vector of Numbers where each pair of numbers is treated as a point -(an x, y pair).

    \ No newline at end of file +(an x, y pair).

    \ No newline at end of file diff --git a/openfl/display/IBitmapDrawable.html b/openfl/display/IBitmapDrawable.html index 961f727..81a2c8c 100644 --- a/openfl/display/IBitmapDrawable.html +++ b/openfl/display/IBitmapDrawable.html @@ -52,4 +52,4 @@ .navbar .container img { margin: 5px 0 0 4px; } -

    \ No newline at end of file +

    \ No newline at end of file diff --git a/openfl/display/IGraphicsData.html b/openfl/display/IGraphicsData.html index aba2424..1005413 100644 --- a/openfl/display/IGraphicsData.html +++ b/openfl/display/IGraphicsData.html @@ -52,4 +52,4 @@ .navbar .container img { margin: 5px 0 0 4px; } -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/openfl/display/IGraphicsFill.html b/openfl/display/IGraphicsFill.html index e7895ec..a4f9295 100644 --- a/openfl/display/IGraphicsFill.html +++ b/openfl/display/IGraphicsFill.html @@ -52,4 +52,4 @@ .navbar .container img { margin: 5px 0 0 4px; } -

    \ No newline at end of file +

    \ No newline at end of file diff --git a/openfl/display/IGraphicsPath.html b/openfl/display/IGraphicsPath.html index 6050a76..3f6da33 100644 --- a/openfl/display/IGraphicsPath.html +++ b/openfl/display/IGraphicsPath.html @@ -52,4 +52,4 @@ .navbar .container img { margin: 5px 0 0 4px; } -

    \ No newline at end of file +

    \ No newline at end of file diff --git a/openfl/display/IGraphicsStroke.html b/openfl/display/IGraphicsStroke.html index aa4b371..9cb0549 100644 --- a/openfl/display/IGraphicsStroke.html +++ b/openfl/display/IGraphicsStroke.html @@ -52,4 +52,4 @@ .navbar .container img { margin: 5px 0 0 4px; } -

    \ No newline at end of file +

    \ No newline at end of file diff --git a/openfl/display/ITileContainer.html b/openfl/display/ITileContainer.html index a96619b..f7e7419 100644 --- a/openfl/display/ITileContainer.html +++ b/openfl/display/ITileContainer.html @@ -102,4 +102,4 @@ objects. All other tile objects in the tile container remain in the same index positions.

    Parameters:

    child1

    The first tile object.

    child2

    The second tile object.

    swapTilesAt(index1:Int, index2:Int):Void

    Swaps the z-order (front-to-back order) of the tile objects at the two specified index positions in the tile list. All other tile objects in -the tile container remain in the same index positions.

    Parameters:

    index1

    The index position of the first tile object.

    index2

    The index position of the second tile object.

    \ No newline at end of file +the tile container remain in the same index positions.

    Parameters:

    index1

    The index position of the first tile object.

    index2

    The index position of the second tile object.

    \ No newline at end of file diff --git a/openfl/display/InteractiveObject.html b/openfl/display/InteractiveObject.html index 2f7d9a5..80d4e5d 100644 --- a/openfl/display/InteractiveObject.html +++ b/openfl/display/InteractiveObject.html @@ -85,7 +85,7 @@ mouseUp events; the click event still occurs.

    contextMenu

    Dispatched when a user gesture triggers the context menu associated with this interactive -object in an AIR application.

    copy

    Dispatched when the user activates the +object in an OpenFL application.

    copy

    Dispatched when the user activates the platform-specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu. This event is @@ -1370,7 +1370,7 @@ property of the scrollRect Rectangle object. You can scroll an object up and down by setting the y property of the scrollRect Rectangle object. If the display object is rotated -90� and you scroll it left and right, the display object actually scrolls +90° and you scroll it left and right, the display object actually scrolls up and down.

    @:betashader:Shader

    BETA**

    Applies a custom Shader object to use when rendering this display object (or its children) when using hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to @@ -1422,16 +1422,16 @@ to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

    Inherited Methods

    Defined by DisplayObject

    getBounds(targetCoordinateSpace:DisplayObject):Rectangle

    Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object. Consider the following code, which shows how the rectangle returned can @@ -1518,4 +1518,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/display/InterpolationMethod.html b/openfl/display/InterpolationMethod.html index 7d99632..75a887b 100644 --- a/openfl/display/InterpolationMethod.html +++ b/openfl/display/InterpolationMethod.html @@ -76,4 +76,4 @@

    For example, consider a simple linear gradient between two colors(with the spreadMethod parameter set to SpreadMethod.REFLECT). The different interpolation methods -affect the appearance as follows:

    \ No newline at end of file +affect the appearance as follows:

    \ No newline at end of file diff --git a/openfl/display/JPEGEncoderOptions.html b/openfl/display/JPEGEncoderOptions.html index c3d3b67..04fc36b 100644 --- a/openfl/display/JPEGEncoderOptions.html +++ b/openfl/display/JPEGEncoderOptions.html @@ -56,4 +56,4 @@

    The JPEGEncoderOptions class defines a compression algorithm for the openfl.display.BitmapData.encode() method.

    Constructor

    @:value({ quality : 80 })new(quality:Int = 80)

    Creates a JPEGEncoderOptions object with the specified setting.

    Parameters:

    quality

    The initial quality value.

    Variables

    quality:Int

    A value between 1 and 100, where 1 means the lowest quality and 100 means the highest quality. The higher the value, the larger the size of the output of the -compression, and the smaller the compression ratio.

    \ No newline at end of file +compression, and the smaller the compression ratio.

    \ No newline at end of file diff --git a/openfl/display/JointStyle.html b/openfl/display/JointStyle.html index cdb16ed..5ecf9f8 100644 --- a/openfl/display/JointStyle.html +++ b/openfl/display/JointStyle.html @@ -65,4 +65,4 @@ shows:

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyBEVEL:JointStyle = 0

    Specifies beveled joints in the joints parameter of the openfl.display.Graphics.lineStyle() method.

    @:value(cast 1)@:impl@:enuminlineread onlyMITER:JointStyle = 1

    Specifies mitered joints in the joints parameter of the openfl.display.Graphics.lineStyle() method.

    @:value(cast 2)@:impl@:enuminlineread onlyROUND:JointStyle = 2

    Specifies round joints in the joints parameter of the -openfl.display.Graphics.lineStyle() method.

    \ No newline at end of file +openfl.display.Graphics.lineStyle() method.

    \ No newline at end of file diff --git a/openfl/display/LineScaleMode.html b/openfl/display/LineScaleMode.html index 7b377b8..075b746 100644 --- a/openfl/display/LineScaleMode.html +++ b/openfl/display/LineScaleMode.html @@ -69,4 +69,4 @@ drawn with a one-pixel line, and each with the scaleMode parameter set to LineScaleMode.HORIZONTAL. The circle on the left is scaled only horizontally, and the circle on the right is scaled -both vertically and horizontally.

    \ No newline at end of file +both vertically and horizontally.

    \ No newline at end of file diff --git a/openfl/display/Loader.html b/openfl/display/Loader.html index 91cfe35..f23437d 100644 --- a/openfl/display/Loader.html +++ b/openfl/display/Loader.html @@ -782,7 +782,7 @@ property of the scrollRect Rectangle object. You can scroll an object up and down by setting the y property of the scrollRect Rectangle object. If the display object is rotated -90� and you scroll it left and right, the display object actually scrolls +90° and you scroll it left and right, the display object actually scrolls up and down.

    @:betashader:Shader

    BETA**

    Applies a custom Shader object to use when rendering this display object (or its children) when using hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to @@ -834,16 +834,16 @@ to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

    Inherited Methods

    Defined by DisplayObjectContainer

    areInaccessibleObjectsUnderPoint(point:Point):Bool

    Indicates whether the security restrictions would cause any display objects to be omitted from the list returned by calling the DisplayObjectContainer.getObjectsUnderPoint() method with the @@ -1000,4 +1000,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/display/LoaderInfo.html b/openfl/display/LoaderInfo.html index 27a14be..bb7d6f4 100644 --- a/openfl/display/LoaderInfo.html +++ b/openfl/display/LoaderInfo.html @@ -369,4 +369,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/display/MovieClip.html b/openfl/display/MovieClip.html index 998a6f4..6b6f7f1 100644 --- a/openfl/display/MovieClip.html +++ b/openfl/display/MovieClip.html @@ -597,7 +597,7 @@ property of the scrollRect Rectangle object. You can scroll an object up and down by setting the y property of the scrollRect Rectangle object. If the display object is rotated -90� and you scroll it left and right, the display object actually scrolls +90° and you scroll it left and right, the display object actually scrolls up and down.

    @:betashader:Shader

    BETA**

    Applies a custom Shader object to use when rendering this display object (or its children) when using hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to @@ -649,16 +649,16 @@ to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

    Inherited Methods

    Defined by Sprite

    @:value({ bounds : null, lockCenter : false })startDrag(lockCenter:Bool = false, ?bounds:Rectangle):Void

    Lets the user drag the specified sprite. The sprite remains draggable until explicitly stopped through a call to the Sprite.stopDrag() method, or until another sprite is made @@ -914,4 +914,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/display/NativeWindow.html b/openfl/display/NativeWindow.html index 20cffcd..560fc51 100644 --- a/openfl/display/NativeWindow.html +++ b/openfl/display/NativeWindow.html @@ -58,7 +58,7 @@

    You can test for support at run time on desktop devices using the NativeWindow.isSupported property.

    OpenFL target support: This feature is supported on all desktop operating -systems, but is not support on mobile operating systems, including iOS and +systems, but is not supported on mobile operating systems, including iOS and Android.

    Adobe AIR profile support: This feature is supported on all desktop operating systems, but is not supported on mobile devices or AIR for TV @@ -487,4 +487,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/display/NativeWindowDisplayState.html b/openfl/display/NativeWindowDisplayState.html index d93dab8..6e49b58 100644 --- a/openfl/display/NativeWindowDisplayState.html +++ b/openfl/display/NativeWindowDisplayState.html @@ -56,4 +56,4 @@

    The NativeWindowDisplayState class defines constants for the names of the window display states.

    Note: The fullscreen modes are set using the Stage object displayState -property, not the window displayState.

    See also:

    Variables

    @:value(cast 1)@:impl@:enuminlineread onlyMAXIMIZED:NativeWindowDisplayState = 1

    The maximized display state.

    @:value(cast 2)@:impl@:enuminlineread onlyMINIMIZED:NativeWindowDisplayState = 2

    The minimized display state.

    @:value(cast 0)@:impl@:enuminlineread onlyNORMAL:NativeWindowDisplayState = 0

    The normal display state.

    \ No newline at end of file +property, not the window displayState.

    See also:

    Variables

    @:value(cast 1)@:impl@:enuminlineread onlyMAXIMIZED:NativeWindowDisplayState = 1

    The maximized display state.

    @:value(cast 2)@:impl@:enuminlineread onlyMINIMIZED:NativeWindowDisplayState = 2

    The minimized display state.

    @:value(cast 0)@:impl@:enuminlineread onlyNORMAL:NativeWindowDisplayState = 0

    The normal display state.

    \ No newline at end of file diff --git a/openfl/display/NativeWindowInitOptions.html b/openfl/display/NativeWindowInitOptions.html index fb7000c..eba0519 100644 --- a/openfl/display/NativeWindowInitOptions.html +++ b/openfl/display/NativeWindowInitOptions.html @@ -125,4 +125,4 @@ Lightweight windows are suitable for notification bubbles and controls such as combo-boxes that open a short-lived display area. When the lightweight type is used, systemChrome must be set to -NativeWindowSystemChrome.NONE. \ No newline at end of file +NativeWindowSystemChrome.NONE. \ No newline at end of file diff --git a/openfl/display/NativeWindowSystemChrome.html b/openfl/display/NativeWindowSystemChrome.html index 8c5dffc..0a63fab 100644 --- a/openfl/display/NativeWindowSystemChrome.html +++ b/openfl/display/NativeWindowSystemChrome.html @@ -60,4 +60,4 @@

    Note: The type of system chrome used is specified when a window is created and cannot be changed.

    See also:

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyALTERNATE:NativeWindowSystemChrome = 0

    Reserved for future use.

    Do not use.

    @:value(cast 1)@:impl@:enuminlineread onlyNONE:NativeWindowSystemChrome = 1

    No system chrome.

    @:value(cast 2)@:impl@:enuminlineread onlySTANDARD:NativeWindowSystemChrome = 2

    The standard chrome for the host operating system.

    -

    Use this setting to emulate the look and feel of the native operating system.

    \ No newline at end of file +

    Use this setting to emulate the look and feel of the native operating system.

    \ No newline at end of file diff --git a/openfl/display/NativeWindowType.html b/openfl/display/NativeWindowType.html index 07b4fe7..2488dff 100644 --- a/openfl/display/NativeWindowType.html +++ b/openfl/display/NativeWindowType.html @@ -64,4 +64,4 @@ type is used, systemChrome must be set to NativeWindowSystemChrome.NONE.

    @:value(cast 1)@:impl@:enuminlineread onlyNORMAL:NativeWindowType = 1

    A typical window. Normal windows use full-size chrome and appear on the Windows or Linux task bar.

    @:value(cast 2)@:impl@:enuminlineread onlyUTILITY:NativeWindowType = 2

    A utility window. Utility windows use a slimmer version of the system -chrome and do not appear on the Windows task bar.

    \ No newline at end of file +chrome and do not appear on the Windows task bar.

    \ No newline at end of file diff --git a/openfl/display/OpenGLRenderer.html b/openfl/display/OpenGLRenderer.html index 3d10165..7e59fac 100644 --- a/openfl/display/OpenGLRenderer.html +++ b/openfl/display/OpenGLRenderer.html @@ -185,4 +185,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/display/PNGEncoderOptions.html b/openfl/display/PNGEncoderOptions.html index dd77e0e..3dfb440 100644 --- a/openfl/display/PNGEncoderOptions.html +++ b/openfl/display/PNGEncoderOptions.html @@ -55,4 +55,4 @@ }

    The PNGEncoderOptions class defines a compression algorithm for the openfl.display.BitmapData.encode() method.

    Constructor

    @:value({ fastCompression : false })new(fastCompression:Bool = false)

    Creates a PNGEncoderOptions object, optionally specifying compression settings.

    Parameters:

    fastCompression

    The initial compression mode.

    Variables

    fastCompression:Bool

    Chooses compression speed over file size. Setting this property to true improves -compression speed but creates larger files.

    \ No newline at end of file +compression speed but creates larger files.

    \ No newline at end of file diff --git a/openfl/display/PixelSnapping.html b/openfl/display/PixelSnapping.html index 3730a7f..e7c9c19 100644 --- a/openfl/display/PixelSnapping.html +++ b/openfl/display/PixelSnapping.html @@ -65,4 +65,4 @@ drawn at 100% scale, snapped to the nearest pixel. Internally, this setting allows the image to be drawn as fast as possible by using the vector renderer.

    @:value(cast 2)@:impl@:enuminlineread onlyNEVER:PixelSnapping = 2

    A constant value used in the pixelSnapping property of a -Bitmap object to specify that no pixel snapping occurs.

    \ No newline at end of file +Bitmap object to specify that no pixel snapping occurs.

    \ No newline at end of file diff --git a/openfl/display/Preloader.html b/openfl/display/Preloader.html index 36c03f2..40615d2 100644 --- a/openfl/display/Preloader.html +++ b/openfl/display/Preloader.html @@ -54,4 +54,4 @@ margin: 5px 0 0 4px; }

    The Preloader class is a Lime Preloader instance that uses an OpenFL -display object to display loading progress.

    Constructor

    @:value({ display : null })new(?display:Sprite)

    Variables

    @:value(new lime.app.Event<Void>())@SuppressWarnings("checkstyle:Dynamic")onComplete:_Event_Void_Void<() ‑> Void> = new lime.app.Event<Void>()

    \ No newline at end of file +display object to display loading progress.

    Constructor

    @:value({ display : null })new(?display:Sprite)

    Variables

    @:value(new lime.app.Event<Void>())@SuppressWarnings("checkstyle:Dynamic")onComplete:_Event_Void_Void<() ‑> Void> = new lime.app.Event<Void>()

    \ No newline at end of file diff --git a/openfl/display/Scene.html b/openfl/display/Scene.html index bc440a6..660ee89 100644 --- a/openfl/display/Scene.html +++ b/openfl/display/Scene.html @@ -52,4 +52,4 @@ .navbar .container img { margin: 5px 0 0 4px; } -

    Constructor

    new(name:String, labels:Array<FrameLabel>, numFrames:Int)

    Variables

    read onlylabels:Array<FrameLabel>

    read onlyname:String

    read onlynumFrames:Int

    \ No newline at end of file +

    Constructor

    new(name:String, labels:Array<FrameLabel>, numFrames:Int)

    Variables

    read onlylabels:Array<FrameLabel>

    read onlyname:String

    read onlynumFrames:Int

    \ No newline at end of file diff --git a/openfl/display/Screen.html b/openfl/display/Screen.html index 83b271c..0d5c2cd 100644 --- a/openfl/display/Screen.html +++ b/openfl/display/Screen.html @@ -194,4 +194,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/display/Shader.html b/openfl/display/Shader.html index af965ba..816bc4c 100644 --- a/openfl/display/Shader.html +++ b/openfl/display/Shader.html @@ -175,4 +175,4 @@

    The precision mode selection affects the following shader operations. These operations are faster on an Intel processor with the SSE instruction set:

    program:Program3D

    The compiled Program3D if available.

    -

    This property is not available on the Flash target.

    \ No newline at end of file +

    This property is not available on the Flash target.

    \ No newline at end of file diff --git a/openfl/display/ShaderData.html b/openfl/display/ShaderData.html index ffb9594..d8c8768 100644 --- a/openfl/display/ShaderData.html +++ b/openfl/display/ShaderData.html @@ -125,4 +125,4 @@ property of the ShaderData instance.

    Generally, developer code does not create a ShaderData instance. A ShaderData instance containing data, parameters, and inputs for a shader -is available as the Shader instance's data property.

    \ No newline at end of file +is available as the Shader instance's data property.

    \ No newline at end of file diff --git a/openfl/display/ShaderInput.html b/openfl/display/ShaderInput.html index 57445f4..e24eddb 100644 --- a/openfl/display/ShaderInput.html +++ b/openfl/display/ShaderInput.html @@ -116,4 +116,4 @@

    This property is not available when targeting Flash.

    width:Int

    The width of the shader input. This property is only used when the input data is a ByteArray or Vector. instance. When the input is a BitmapData instance the width is automatically determined.

    wrap:Context3DWrapMode

    The wrap mode to use when binding this shader input.

    -

    This property is not available when targeting Flash.

    \ No newline at end of file +

    This property is not available when targeting Flash.

    \ No newline at end of file diff --git a/openfl/display/ShaderJob.html b/openfl/display/ShaderJob.html index 1e020c7..359fd99 100644 --- a/openfl/display/ShaderJob.html +++ b/openfl/display/ShaderJob.html @@ -289,4 +289,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/display/ShaderParameter.html b/openfl/display/ShaderParameter.html index 9107524..7526c11 100644 --- a/openfl/display/ShaderParameter.html +++ b/openfl/display/ShaderParameter.html @@ -114,4 +114,4 @@ of ActionScript is used to fill a float2x2 parameter named myMatrix:

    myShader.data.myMatrix.value = [.1, .2, .3, .4];
    -

    Within the shader, the matrix elements have the following values:

    \ No newline at end of file +

    Within the shader, the matrix elements have the following values:

    \ No newline at end of file diff --git a/openfl/display/ShaderParameterType.html b/openfl/display/ShaderParameterType.html index aa2a351..56e7e5e 100644 --- a/openfl/display/ShaderParameterType.html +++ b/openfl/display/ShaderParameterType.html @@ -109,4 +109,4 @@ equivalent to a 4-by-3 matrix. This matrix is represented as an Array of twelve Float instances in Haxe.

    @:value(cast 20)@:impl@:enuminlineread onlyMATRIX4X4:ShaderParameterType = 20

    Indicates that the shader parameter is defined as a float4x4 value, equivalent to a 4-by-4 matrix. This matrix is represented as an Array -of 16 Number instances in ActionScript.

    \ No newline at end of file +of 16 Number instances in ActionScript.

    \ No newline at end of file diff --git a/openfl/display/ShaderPrecision.html b/openfl/display/ShaderPrecision.html index e9fa296..e586c73 100644 --- a/openfl/display/ShaderPrecision.html +++ b/openfl/display/ShaderPrecision.html @@ -73,4 +73,4 @@ full width of the IEEE 32-bit floating standard. This mode provides consistent behavior on all platforms. In this mode, some math operations such as trigonometric and exponential functions can be -slow.

    \ No newline at end of file +slow.

    \ No newline at end of file diff --git a/openfl/display/Shape.html b/openfl/display/Shape.html index c0e7518..bfe2cee 100644 --- a/openfl/display/Shape.html +++ b/openfl/display/Shape.html @@ -361,7 +361,7 @@ property of the scrollRect Rectangle object. You can scroll an object up and down by setting the y property of the scrollRect Rectangle object. If the display object is rotated -90� and you scroll it left and right, the display object actually scrolls +90° and you scroll it left and right, the display object actually scrolls up and down.

    @:betashader:Shader

    BETA**

    Applies a custom Shader object to use when rendering this display object (or its children) when using hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to @@ -413,16 +413,16 @@ to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

    Inherited Methods

    Defined by DisplayObject

    getBounds(targetCoordinateSpace:DisplayObject):Rectangle

    Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object. Consider the following code, which shows how the rectangle returned can @@ -509,4 +509,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/display/SimpleButton.html b/openfl/display/SimpleButton.html index 1f00cc2..64e0d0e 100644 --- a/openfl/display/SimpleButton.html +++ b/openfl/display/SimpleButton.html @@ -479,7 +479,7 @@ property of the scrollRect Rectangle object. You can scroll an object up and down by setting the y property of the scrollRect Rectangle object. If the display object is rotated -90� and you scroll it left and right, the display object actually scrolls +90° and you scroll it left and right, the display object actually scrolls up and down.

    @:betashader:Shader

    BETA**

    Applies a custom Shader object to use when rendering this display object (or its children) when using hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to @@ -531,16 +531,16 @@ to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

    Inherited Methods

    Defined by InteractiveObject

    requestSoftKeyboard():Bool

    Raises a virtual keyboard.

    Calling this method focuses the InteractiveObject instance and raises the soft keyboard, if necessary. The needsSoftKeyboard must @@ -636,4 +636,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/display/SpreadMethod.html b/openfl/display/SpreadMethod.html index 74b2242..173f33d 100644 --- a/openfl/display/SpreadMethod.html +++ b/openfl/display/SpreadMethod.html @@ -58,4 +58,4 @@ parameter in the beginGradientFill() and lineGradientStyle() methods of the Graphics class.

    The following example shows the same gradient fill using various spread -methods:

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyPAD:SpreadMethod = 0

    Specifies that the gradient use the pad spread method.

    @:value(cast 1)@:impl@:enuminlineread onlyREFLECT:SpreadMethod = 1

    Specifies that the gradient use the reflect spread method.

    @:value(cast 2)@:impl@:enuminlineread onlyREPEAT:SpreadMethod = 2

    Specifies that the gradient use the repeat spread method.

    \ No newline at end of file +methods:

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyPAD:SpreadMethod = 0

    Specifies that the gradient use the pad spread method.

    @:value(cast 1)@:impl@:enuminlineread onlyREFLECT:SpreadMethod = 1

    Specifies that the gradient use the reflect spread method.

    @:value(cast 2)@:impl@:enuminlineread onlyREPEAT:SpreadMethod = 2

    Specifies that the gradient use the repeat spread method.

    \ No newline at end of file diff --git a/openfl/display/Sprite.html b/openfl/display/Sprite.html index b0a23a9..1f7c1f8 100644 --- a/openfl/display/Sprite.html +++ b/openfl/display/Sprite.html @@ -535,7 +535,7 @@ property of the scrollRect Rectangle object. You can scroll an object up and down by setting the y property of the scrollRect Rectangle object. If the display object is rotated -90� and you scroll it left and right, the display object actually scrolls +90° and you scroll it left and right, the display object actually scrolls up and down.

    @:betashader:Shader

    BETA**

    Applies a custom Shader object to use when rendering this display object (or its children) when using hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to @@ -587,16 +587,16 @@ to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

    Inherited Methods

    Defined by DisplayObjectContainer

    addChild(child:DisplayObject):DisplayObject

    Adds a child DisplayObject instance to this DisplayObjectContainer instance. The child is added to the front(top) of all other children in this DisplayObjectContainer instance.(To add a child to a specific index @@ -836,4 +836,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/display/Stage.html b/openfl/display/Stage.html index 0a4cbb1..da60ff8 100644 --- a/openfl/display/Stage.html +++ b/openfl/display/Stage.html @@ -139,12 +139,11 @@ continue to be reported in classic pixel units.

    read onlycontext3D:Context3D

    BETA**

    The current Context3D the default display renderer.

    This property is supported only when using hardware rendering.

    displayState:StageDisplayState

    A value from the StageDisplayState class that specifies which display -state to use. The following are valid values:

    @:betashader:Shader

    BETA**

    Applies a custom Shader object to use when rendering this display object (or its children) when using hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to @@ -910,16 +909,16 @@ to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

    Inherited Methods

    Defined by DisplayObjectContainer

    addChild(child:DisplayObject):DisplayObject

    Adds a child DisplayObject instance to this DisplayObjectContainer instance. The child is added to the front(top) of all other children in this DisplayObjectContainer instance.(To add a child to a specific index @@ -1144,4 +1143,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/display/Stage3D.html b/openfl/display/Stage3D.html index 46efa37..12070f8 100644 --- a/openfl/display/Stage3D.html +++ b/openfl/display/Stage3D.html @@ -334,4 +334,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/display/StageAlign.html b/openfl/display/StageAlign.html index cbbc018..c8a95e0 100644 --- a/openfl/display/StageAlign.html +++ b/openfl/display/StageAlign.html @@ -54,4 +54,4 @@ margin: 5px 0 0 4px; }

    The StageAlign class provides constant values to use for the -Stage.align property.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyBOTTOM:StageAlign = 0

    Specifies that the Stage is aligned at the bottom.

    @:value(cast 1)@:impl@:enuminlineread onlyBOTTOM_LEFT:StageAlign = 1

    Specifies that the Stage is aligned on the left.

    @:value(cast 2)@:impl@:enuminlineread onlyBOTTOM_RIGHT:StageAlign = 2

    Specifies that the Stage is aligned to the right.

    @:value(cast 3)@:impl@:enuminlineread onlyLEFT:StageAlign = 3

    Specifies that the Stage is aligned on the left.

    @:value(cast 4)@:impl@:enuminlineread onlyRIGHT:StageAlign = 4

    Specifies that the Stage is aligned to the right.

    @:value(cast 5)@:impl@:enuminlineread onlyTOP:StageAlign = 5

    Specifies that the Stage is aligned at the top.

    @:value(cast 6)@:impl@:enuminlineread onlyTOP_LEFT:StageAlign = 6

    Specifies that the Stage is aligned on the left.

    @:value(cast 7)@:impl@:enuminlineread onlyTOP_RIGHT:StageAlign = 7

    Specifies that the Stage is aligned to the right.

    \ No newline at end of file +Stage.align property.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyBOTTOM:StageAlign = 0

    Specifies that the Stage is aligned at the bottom.

    @:value(cast 1)@:impl@:enuminlineread onlyBOTTOM_LEFT:StageAlign = 1

    Specifies that the Stage is aligned on the left.

    @:value(cast 2)@:impl@:enuminlineread onlyBOTTOM_RIGHT:StageAlign = 2

    Specifies that the Stage is aligned to the right.

    @:value(cast 3)@:impl@:enuminlineread onlyLEFT:StageAlign = 3

    Specifies that the Stage is aligned on the left.

    @:value(cast 4)@:impl@:enuminlineread onlyRIGHT:StageAlign = 4

    Specifies that the Stage is aligned to the right.

    @:value(cast 5)@:impl@:enuminlineread onlyTOP:StageAlign = 5

    Specifies that the Stage is aligned at the top.

    @:value(cast 6)@:impl@:enuminlineread onlyTOP_LEFT:StageAlign = 6

    Specifies that the Stage is aligned on the left.

    @:value(cast 7)@:impl@:enuminlineread onlyTOP_RIGHT:StageAlign = 7

    Specifies that the Stage is aligned to the right.

    \ No newline at end of file diff --git a/openfl/display/StageDisplayState.html b/openfl/display/StageDisplayState.html index 680733c..10a2ee3 100644 --- a/openfl/display/StageDisplayState.html +++ b/openfl/display/StageDisplayState.html @@ -54,4 +54,4 @@ margin: 5px 0 0 4px; }

    The StageDisplayState class provides values for the -Stage.displayState property.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyFULL_SCREEN:StageDisplayState = 0

    Specifies that the Stage is in full-screen mode.

    @:value(cast 1)@:impl@:enuminlineread onlyFULL_SCREEN_INTERACTIVE:StageDisplayState = 1

    Specifies that the Stage is in full-screen mode with keyboard interactivity enabled.

    @:value(cast 2)@:impl@:enuminlineread onlyNORMAL:StageDisplayState = 2

    Specifies that the Stage is in normal mode.

    \ No newline at end of file +Stage.displayState property.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyFULL_SCREEN:StageDisplayState = 0

    Specifies that the Stage is in full-screen mode.

    @:value(cast 1)@:impl@:enuminlineread onlyFULL_SCREEN_INTERACTIVE:StageDisplayState = 1

    Specifies that the Stage is in full-screen mode with keyboard interactivity enabled.

    @:value(cast 2)@:impl@:enuminlineread onlyNORMAL:StageDisplayState = 2

    Specifies that the Stage is in normal mode.

    \ No newline at end of file diff --git a/openfl/display/StageQuality.html b/openfl/display/StageQuality.html index aab4784..d0f2518 100644 --- a/openfl/display/StageQuality.html +++ b/openfl/display/StageQuality.html @@ -59,4 +59,4 @@ pixel grid, and bitmaps are smoothed if the movie is static.

    @:value(cast 2)@:impl@:enuminlineread onlyLOW:StageQuality = 2

    Specifies low rendering quality: graphics are not anti-aliased, and bitmaps are not smoothed.

    @:value(cast 3)@:impl@:enuminlineread onlyMEDIUM:StageQuality = 3

    Specifies medium rendering quality: graphics are anti-aliased using a 2 x 2 pixel grid, but bitmaps are not smoothed. This setting is suitable for -movies that do not contain text.

    \ No newline at end of file +movies that do not contain text.

    \ No newline at end of file diff --git a/openfl/display/StageScaleMode.html b/openfl/display/StageScaleMode.html index c3258b9..310e9fa 100644 --- a/openfl/display/StageScaleMode.html +++ b/openfl/display/StageScaleMode.html @@ -61,4 +61,4 @@ unchanged even as the size of the player window changes. Cropping might occur if the player window is smaller than the content.

    @:value(cast 3)@:impl@:enuminlineread onlySHOW_ALL:StageScaleMode = 3

    Specifies that the entire application be visible in the specified area without distortion while maintaining the original aspect ratio of the application. -Borders can appear on two sides of the application.

    \ No newline at end of file +Borders can appear on two sides of the application.

    \ No newline at end of file diff --git a/openfl/display/Tile.html b/openfl/display/Tile.html index 593da10..9a9073c 100644 --- a/openfl/display/Tile.html +++ b/openfl/display/Tile.html @@ -126,4 +126,4 @@ redrawn the next time the tile object is eligible to be rendered.

    Invalidation is handled automatically, but in some cases it is necessary to trigger it manually, such as changing the parameters -of a Shader instance attached to this tile.

    \ No newline at end of file +of a Shader instance attached to this tile.

    \ No newline at end of file diff --git a/openfl/display/TileContainer.html b/openfl/display/TileContainer.html index c2906b5..d9f7289 100644 --- a/openfl/display/TileContainer.html +++ b/openfl/display/TileContainer.html @@ -162,4 +162,4 @@ redrawn the next time the tile object is eligible to be rendered.

    Invalidation is handled automatically, but in some cases it is necessary to trigger it manually, such as changing the parameters -of a Shader instance attached to this tile.

    \ No newline at end of file +of a Shader instance attached to this tile.

    \ No newline at end of file diff --git a/openfl/display/Tilemap.html b/openfl/display/Tilemap.html index a958004..49ec53a 100644 --- a/openfl/display/Tilemap.html +++ b/openfl/display/Tilemap.html @@ -425,7 +425,7 @@ property of the scrollRect Rectangle object. You can scroll an object up and down by setting the y property of the scrollRect Rectangle object. If the display object is rotated -90� and you scroll it left and right, the display object actually scrolls +90° and you scroll it left and right, the display object actually scrolls up and down.

    @:betashader:Shader

    BETA**

    Applies a custom Shader object to use when rendering this display object (or its children) when using hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to @@ -477,16 +477,16 @@ to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

    Inherited Methods

    Defined by DisplayObject

    getBounds(targetCoordinateSpace:DisplayObject):Rectangle

    Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object. Consider the following code, which shows how the rectangle returned can @@ -573,4 +573,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/display/Tileset.html b/openfl/display/Tileset.html index f690086..3fe609e 100644 --- a/openfl/display/Tileset.html +++ b/openfl/display/Tileset.html @@ -67,4 +67,4 @@ null if the rectangle value is not defined in the Tileset.

    Parameters:

    rect

    A Rectangle object to compare against

    Returns:

    The defined tile ID, or null if the rectangle value is not present in this Tileset

    hasRect(rect:Rectangle):Bool

    Returns whether the current Tileset already has a rectangle defined that matches the dimensions of a specific rectangle -object.

    Parameters:

    rect

    A Rectangle object to compare against

    Returns:

    Whether the Tileset already contains the value of this rectangle

    \ No newline at end of file +object.

    Parameters:

    rect

    A Rectangle object to compare against

    Returns:

    Whether the Tileset already contains the value of this rectangle

    \ No newline at end of file diff --git a/openfl/display/Timeline.html b/openfl/display/Timeline.html index c7a20f8..2b2a568 100644 --- a/openfl/display/Timeline.html +++ b/openfl/display/Timeline.html @@ -70,4 +70,4 @@

    Scenes are assumed to occur in order, so if the first Scene contains 10 frames, then the beginning of the second Scene will be treated as frame 11 when setting FrameScripts or implementing -enterFrame().

    scripts:Array<FrameScript>

    An optional array of frame scripts to be executed.

    \ No newline at end of file +enterFrame().

    scripts:Array<FrameScript>

    An optional array of frame scripts to be executed.

    \ No newline at end of file diff --git a/openfl/display/TriangleCulling.html b/openfl/display/TriangleCulling.html index 5054703..51f1312 100644 --- a/openfl/display/TriangleCulling.html +++ b/openfl/display/TriangleCulling.html @@ -69,4 +69,4 @@ direction, toward the current view point. When the TriangleCulling.NEGATIVE algorithm is used, triangles with negative normals will not be rendered.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyNEGATIVE:TriangleCulling = 0

    Specifies culling of all triangles facing toward the current view point.

    @:value(cast 1)@:impl@:enuminlineread onlyNONE:TriangleCulling = 1

    Specifies no culling. All triangles in the path are rendered.

    @:value(cast 2)@:impl@:enuminlineread onlyPOSITIVE:TriangleCulling = 2

    Specifies culling of all triangles facing away from the current view -point. This is also known as backface culling.

    \ No newline at end of file +point. This is also known as backface culling.

    \ No newline at end of file diff --git a/openfl/display/Window.html b/openfl/display/Window.html index b494e1b..01b4d6a 100644 --- a/openfl/display/Window.html +++ b/openfl/display/Window.html @@ -54,4 +54,4 @@ margin: 5px 0 0 4px; }

    The Window class is a Lime Window instance that automatically -initializes an OpenFL stage for the current window.

    Methods

    \ No newline at end of file +initializes an OpenFL stage for the current window.

    Methods

    \ No newline at end of file diff --git a/openfl/display/index.html b/openfl/display/index.html index 965d653..8c8c55d 100644 --- a/openfl/display/index.html +++ b/openfl/display/index.html @@ -275,4 +275,4 @@

    package ::full::

    BitmapData object, to be rendered using a Tilemap instance.

    Timeline

    Provides support for MovieClip animations (or a single frame Sprite) when this class is overridden.

    TriangleCulling

    Defines codes for culling algorithms that determine which triangles not to render when drawing triangle paths.

    Window

    The Window class is a Lime Window instance that automatically -initializes an OpenFL stage for the current window.

    \ No newline at end of file +initializes an OpenFL stage for the current window.

    \ No newline at end of file diff --git a/openfl/display3D/Context3D.html b/openfl/display3D/Context3D.html index 091b962..795a647 100644 --- a/openfl/display3D/Context3D.html +++ b/openfl/display3D/Context3D.html @@ -789,4 +789,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/display3D/Context3DBlendFactor.html b/openfl/display3D/Context3DBlendFactor.html index 20e0f2d..dba8990 100644 --- a/openfl/display3D/Context3DBlendFactor.html +++ b/openfl/display3D/Context3DBlendFactor.html @@ -83,4 +83,4 @@ where Sa is the alpha component of the fragment color computed by the pixel program.

    @:value(cast 8)@:impl@:enuminlineread onlySOURCE_COLOR:Context3DBlendFactor = 8

    The blend factor is (Sr,Sg,Sb,Sa), where Sr/g/b/a is the corresponding component of the fragment color -computed by the pixel program.

    @:value(cast 9)@:impl@:enuminlineread onlyZERO:Context3DBlendFactor = 9

    The blend factor is (0,0,0,0).

    \ No newline at end of file +computed by the pixel program.

    @:value(cast 9)@:impl@:enuminlineread onlyZERO:Context3DBlendFactor = 9

    The blend factor is (0,0,0,0).

    \ No newline at end of file diff --git a/openfl/display3D/Context3DBufferUsage.html b/openfl/display3D/Context3DBufferUsage.html index 034bd98..202577e 100644 --- a/openfl/display3D/Context3DBufferUsage.html +++ b/openfl/display3D/Context3DBufferUsage.html @@ -53,4 +53,4 @@ margin: 5px 0 0 4px; }

    Defines the values to use for specifying the buffer usage type.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyDYNAMIC_DRAW:Context3DBufferUsage = 0

    Indicates the buffer will be used for drawing and be updated frequently

    @:value(cast 1)@:impl@:enuminlineread onlySTATIC_DRAW:Context3DBufferUsage = 1

    Indicates the buffer will be used for drawing and be updated once

    -

    This type is the default value for buffers in Stage3D.

    \ No newline at end of file +

    This type is the default value for buffers in Stage3D.

    \ No newline at end of file diff --git a/openfl/display3D/Context3DClearMask.html b/openfl/display3D/Context3DClearMask.html index cfea04b..f21c28e 100644 --- a/openfl/display3D/Context3DClearMask.html +++ b/openfl/display3D/Context3DClearMask.html @@ -52,4 +52,4 @@ .navbar .container img { margin: 5px 0 0 4px; } -

    Defines the values to use for specifying Context3D clear masks.

    Variables

    @:value(cast 0x07)@:impl@:enuminlineread onlyALL:Context3DClearMask = 0x07

    Clear all buffers.

    @:value(cast 0x01)@:impl@:enuminlineread onlyCOLOR:Context3DClearMask = 0x01

    Clear only the color buffer.

    @:value(cast 0x02)@:impl@:enuminlineread onlyDEPTH:Context3DClearMask = 0x02

    Clear only the depth buffer.

    @:value(cast 0x04)@:impl@:enuminlineread onlySTENCIL:Context3DClearMask = 0x04

    Clear only the stencil buffer.

    \ No newline at end of file +

    Defines the values to use for specifying Context3D clear masks.

    Variables

    @:value(cast 0x07)@:impl@:enuminlineread onlyALL:Context3DClearMask = 0x07

    Clear all buffers.

    @:value(cast 0x01)@:impl@:enuminlineread onlyCOLOR:Context3DClearMask = 0x01

    Clear only the color buffer.

    @:value(cast 0x02)@:impl@:enuminlineread onlyDEPTH:Context3DClearMask = 0x02

    Clear only the depth buffer.

    @:value(cast 0x04)@:impl@:enuminlineread onlySTENCIL:Context3DClearMask = 0x04

    Clear only the stencil buffer.

    \ No newline at end of file diff --git a/openfl/display3D/Context3DCompareMode.html b/openfl/display3D/Context3DCompareMode.html index df7ca8a..0e9712e 100644 --- a/openfl/display3D/Context3DCompareMode.html +++ b/openfl/display3D/Context3DCompareMode.html @@ -54,4 +54,4 @@ margin: 5px 0 0 4px; }

    Defines the values to use for specifying 3D buffer comparisons in the -setDepthTest() and setStencilAction() methods of a Context3D instance.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyALWAYS:Context3DCompareMode = 0

    The comparison always evaluates as true.

    @:value(cast 1)@:impl@:enuminlineread onlyEQUAL:Context3DCompareMode = 1

    Equal (==).

    @:value(cast 2)@:impl@:enuminlineread onlyGREATER:Context3DCompareMode = 2

    Greater than (>).

    @:value(cast 3)@:impl@:enuminlineread onlyGREATER_EQUAL:Context3DCompareMode = 3

    Greater than or equal (>=).

    @:value(cast 4)@:impl@:enuminlineread onlyLESS:Context3DCompareMode = 4

    Less than (<).

    @:value(cast 5)@:impl@:enuminlineread onlyLESS_EQUAL:Context3DCompareMode = 5

    Less than or equal (<=).

    @:value(cast 6)@:impl@:enuminlineread onlyNEVER:Context3DCompareMode = 6

    The comparison never evaluates as true.

    @:value(cast 7)@:impl@:enuminlineread onlyNOT_EQUAL:Context3DCompareMode = 7

    Not equal (!=).

    \ No newline at end of file +setDepthTest() and setStencilAction() methods of a Context3D instance.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyALWAYS:Context3DCompareMode = 0

    The comparison always evaluates as true.

    @:value(cast 1)@:impl@:enuminlineread onlyEQUAL:Context3DCompareMode = 1

    Equal (==).

    @:value(cast 2)@:impl@:enuminlineread onlyGREATER:Context3DCompareMode = 2

    Greater than (>).

    @:value(cast 3)@:impl@:enuminlineread onlyGREATER_EQUAL:Context3DCompareMode = 3

    Greater than or equal (>=).

    @:value(cast 4)@:impl@:enuminlineread onlyLESS:Context3DCompareMode = 4

    Less than (<).

    @:value(cast 5)@:impl@:enuminlineread onlyLESS_EQUAL:Context3DCompareMode = 5

    Less than or equal (<=).

    @:value(cast 6)@:impl@:enuminlineread onlyNEVER:Context3DCompareMode = 6

    The comparison never evaluates as true.

    @:value(cast 7)@:impl@:enuminlineread onlyNOT_EQUAL:Context3DCompareMode = 7

    Not equal (!=).

    \ No newline at end of file diff --git a/openfl/display3D/Context3DMipFilter.html b/openfl/display3D/Context3DMipFilter.html index 990bbe0..5f1373e 100644 --- a/openfl/display3D/Context3DMipFilter.html +++ b/openfl/display3D/Context3DMipFilter.html @@ -53,4 +53,4 @@ margin: 5px 0 0 4px; }

    Defines the values to use for sampler mipmap filter mode

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyMIPLINEAR:Context3DMipFilter = 0

    Select the two closest MIP levels and linearly blend between them (the highest -quality mode, but has some performance cost).

    @:value(cast 1)@:impl@:enuminlineread onlyMIPNEAREST:Context3DMipFilter = 1

    Use the nearest neighbor metric to select MIP levels (the fastest rendering method).

    @:value(cast 2)@:impl@:enuminlineread onlyMIPNONE:Context3DMipFilter = 2

    Always use the top level texture (has a performance penalty when downscaling).

    \ No newline at end of file +quality mode, but has some performance cost).

    @:value(cast 1)@:impl@:enuminlineread onlyMIPNEAREST:Context3DMipFilter = 1

    Use the nearest neighbor metric to select MIP levels (the fastest rendering method).

    @:value(cast 2)@:impl@:enuminlineread onlyMIPNONE:Context3DMipFilter = 2

    Always use the top level texture (has a performance penalty when downscaling).

    \ No newline at end of file diff --git a/openfl/display3D/Context3DProfile.html b/openfl/display3D/Context3DProfile.html index a59cc46..59f7339 100644 --- a/openfl/display3D/Context3DProfile.html +++ b/openfl/display3D/Context3DProfile.html @@ -72,4 +72,4 @@ drawing feature.

    This profile extends the standard profile.

    This profile is enabled on mobile platforms from AIR 17.0 and on Windows and Mac -from AIR 18.0.

    \ No newline at end of file +from AIR 18.0.

    \ No newline at end of file diff --git a/openfl/display3D/Context3DProgramFormat.html b/openfl/display3D/Context3DProgramFormat.html index d291cc6..9566fbd 100644 --- a/openfl/display3D/Context3DProgramFormat.html +++ b/openfl/display3D/Context3DProgramFormat.html @@ -52,4 +52,4 @@ .navbar .container img { margin: 5px 0 0 4px; } -

    Defines the values to use for specifying a Program3D source format.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyAGAL:Context3DProgramFormat = 0

    The program will use the AGAL (Adobe Graphics Assembly Language) format

    @:value(cast 1)@:impl@:enuminlineread onlyGLSL:Context3DProgramFormat = 1

    The program will use the GLSL (GL Shader Language) format

    \ No newline at end of file +

    Defines the values to use for specifying a Program3D source format.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyAGAL:Context3DProgramFormat = 0

    The program will use the AGAL (Adobe Graphics Assembly Language) format

    @:value(cast 1)@:impl@:enuminlineread onlyGLSL:Context3DProgramFormat = 1

    The program will use the GLSL (GL Shader Language) format

    \ No newline at end of file diff --git a/openfl/display3D/Context3DProgramType.html b/openfl/display3D/Context3DProgramType.html index d0b84b9..a01fa5e 100644 --- a/openfl/display3D/Context3DProgramType.html +++ b/openfl/display3D/Context3DProgramType.html @@ -54,4 +54,4 @@ margin: 5px 0 0 4px; }

    Defines the values to use for specifying whether a shader program is a fragment -or a vertex program.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyFRAGMENT:Context3DProgramType = 0

    A fragment (or pixel) program.

    @:value(cast 1)@:impl@:enuminlineread onlyVERTEX:Context3DProgramType = 1

    A vertex program.

    \ No newline at end of file +or a vertex program.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyFRAGMENT:Context3DProgramType = 0

    A fragment (or pixel) program.

    @:value(cast 1)@:impl@:enuminlineread onlyVERTEX:Context3DProgramType = 1

    A vertex program.

    \ No newline at end of file diff --git a/openfl/display3D/Context3DRenderMode.html b/openfl/display3D/Context3DRenderMode.html index 3de6e33..735f11e 100644 --- a/openfl/display3D/Context3DRenderMode.html +++ b/openfl/display3D/Context3DRenderMode.html @@ -57,4 +57,4 @@ device. Availability of hardware acceleration is influenced by the device capabilites, the wmode when running under Flash Player, and the render mode when running under AIR.

    @:value(cast 1)@:impl@:enuminlineread onlySOFTWARE:Context3DRenderMode = 1

    Use software 3D rendering.

    -

    Software rendering is not available on mobile devices.

    \ No newline at end of file +

    Software rendering is not available on mobile devices.

    \ No newline at end of file diff --git a/openfl/display3D/Context3DStencilAction.html b/openfl/display3D/Context3DStencilAction.html index 19e6038..407c41a 100644 --- a/openfl/display3D/Context3DStencilAction.html +++ b/openfl/display3D/Context3DStencilAction.html @@ -57,4 +57,4 @@ value, then the buffer value is "wrapped around" to 255.

    @:value(cast 2)@:impl@:enuminlineread onlyINCREMENT_SATURATE:Context3DStencilAction = 2

    Increment the stencil buffer value, clamping at 255, the maximum value.

    @:value(cast 3)@:impl@:enuminlineread onlyINCREMENT_WRAP:Context3DStencilAction = 3

    Increment the stencil buffer value. If the result exceeds 255, the maximum value, then the buffer value is "wrapped around" to 0.

    @:value(cast 4)@:impl@:enuminlineread onlyINVERT:Context3DStencilAction = 4

    Invert the stencil buffer value, bitwise.

    For example, if the 8-bit binary number in the stencil buffer is: 11110000, then -the value is changed to: 00001111.

    @:value(cast 5)@:impl@:enuminlineread onlyKEEP:Context3DStencilAction = 5

    Keep the current stencil buffer value.

    @:value(cast 6)@:impl@:enuminlineread onlySET:Context3DStencilAction = 6

    Replace the stencil buffer value with the reference value.

    @:value(cast 7)@:impl@:enuminlineread onlyZERO:Context3DStencilAction = 7

    Set the stencil buffer value to 0.

    \ No newline at end of file +the value is changed to: 00001111.

    @:value(cast 5)@:impl@:enuminlineread onlyKEEP:Context3DStencilAction = 5

    Keep the current stencil buffer value.

    @:value(cast 6)@:impl@:enuminlineread onlySET:Context3DStencilAction = 6

    Replace the stencil buffer value with the reference value.

    @:value(cast 7)@:impl@:enuminlineread onlyZERO:Context3DStencilAction = 7

    Set the stencil buffer value to 0.

    \ No newline at end of file diff --git a/openfl/display3D/Context3DTextureFilter.html b/openfl/display3D/Context3DTextureFilter.html index ff1c996..8c8d8fd 100644 --- a/openfl/display3D/Context3DTextureFilter.html +++ b/openfl/display3D/Context3DTextureFilter.html @@ -53,4 +53,4 @@ margin: 5px 0 0 4px; }

    Defines the values to use for sampler filter mode.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyANISOTROPIC16X:Context3DTextureFilter = 0

    Use anisotropic filter with radio 16 when upsampling textures

    @:value(cast 1)@:impl@:enuminlineread onlyANISOTROPIC2X:Context3DTextureFilter = 1

    Use anisotropic filter with radio 2 when upsampling textures

    @:value(cast 2)@:impl@:enuminlineread onlyANISOTROPIC4X:Context3DTextureFilter = 2

    Use anisotropic filter with radio 4 when upsampling textures

    @:value(cast 3)@:impl@:enuminlineread onlyANISOTROPIC8X:Context3DTextureFilter = 3

    Use anisotropic filter with radio 8 when upsampling textures

    @:value(cast 4)@:impl@:enuminlineread onlyLINEAR:Context3DTextureFilter = 4

    Use linear interpolation when upsampling textures (gives a smooth, blurry look).

    @:value(cast 5)@:impl@:enuminlineread onlyNEAREST:Context3DTextureFilter = 5

    Use nearest neighbor sampling when upsampling textures (gives a pixelated, -sharp mosaic look).

    \ No newline at end of file +sharp mosaic look).

    \ No newline at end of file diff --git a/openfl/display3D/Context3DTextureFormat.html b/openfl/display3D/Context3DTextureFormat.html index 4f74799..9ec9e49 100644 --- a/openfl/display3D/Context3DTextureFormat.html +++ b/openfl/display3D/Context3DTextureFormat.html @@ -52,4 +52,4 @@ .navbar .container img { margin: 5px 0 0 4px; } -

    Defines the values to use for specifying a texture format.

    Variables

    @:value(cast 1)@:impl@:enuminlineread onlyBGRA:Context3DTextureFormat = 1

    32 bit

    @:value(cast 2)@:impl@:enuminlineread onlyBGRA_PACKED:Context3DTextureFormat = 2

    16 bit, bgra packed as 4:4:4:4

    @:value(cast 0)@:impl@:enuminlineread onlyBGR_PACKED:Context3DTextureFormat = 0

    16 bit, bgr packed as 5:6:5

    @:value(cast 3)@:impl@:enuminlineread onlyCOMPRESSED:Context3DTextureFormat = 3

    ATF (Adobe Texture Format)

    @:value(cast 4)@:impl@:enuminlineread onlyCOMPRESSED_ALPHA:Context3DTextureFormat = 4

    ATF (Adobe Texture Format), with alpha

    @:value(cast 5)@:impl@:enuminlineread onlyRGBA_HALF_FLOAT:Context3DTextureFormat = 5

    64 bit, rgba as 16:16:16:16

    \ No newline at end of file +

    Defines the values to use for specifying a texture format.

    Variables

    @:value(cast 1)@:impl@:enuminlineread onlyBGRA:Context3DTextureFormat = 1

    32 bit

    @:value(cast 2)@:impl@:enuminlineread onlyBGRA_PACKED:Context3DTextureFormat = 2

    16 bit, bgra packed as 4:4:4:4

    @:value(cast 0)@:impl@:enuminlineread onlyBGR_PACKED:Context3DTextureFormat = 0

    16 bit, bgr packed as 5:6:5

    @:value(cast 3)@:impl@:enuminlineread onlyCOMPRESSED:Context3DTextureFormat = 3

    ATF (Adobe Texture Format)

    @:value(cast 4)@:impl@:enuminlineread onlyCOMPRESSED_ALPHA:Context3DTextureFormat = 4

    ATF (Adobe Texture Format), with alpha

    @:value(cast 5)@:impl@:enuminlineread onlyRGBA_HALF_FLOAT:Context3DTextureFormat = 5

    64 bit, rgba as 16:16:16:16

    \ No newline at end of file diff --git a/openfl/display3D/Context3DTriangleFace.html b/openfl/display3D/Context3DTriangleFace.html index d056314..c729c20 100644 --- a/openfl/display3D/Context3DTriangleFace.html +++ b/openfl/display3D/Context3DTriangleFace.html @@ -52,4 +52,4 @@ .navbar .container img { margin: 5px 0 0 4px; } -

    Constants to specify the orientation of a triangle relative to the view point.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyBACK:Context3DTriangleFace = 0

    @:value(cast 1)@:impl@:enuminlineread onlyFRONT:Context3DTriangleFace = 1

    @:value(cast 2)@:impl@:enuminlineread onlyFRONT_AND_BACK:Context3DTriangleFace = 2

    @:value(cast 3)@:impl@:enuminlineread onlyNONE:Context3DTriangleFace = 3

    \ No newline at end of file +

    Constants to specify the orientation of a triangle relative to the view point.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyBACK:Context3DTriangleFace = 0

    @:value(cast 1)@:impl@:enuminlineread onlyFRONT:Context3DTriangleFace = 1

    @:value(cast 2)@:impl@:enuminlineread onlyFRONT_AND_BACK:Context3DTriangleFace = 2

    @:value(cast 3)@:impl@:enuminlineread onlyNONE:Context3DTriangleFace = 3

    \ No newline at end of file diff --git a/openfl/display3D/Context3DVertexBufferFormat.html b/openfl/display3D/Context3DVertexBufferFormat.html index 59cd1e0..f64ad04 100644 --- a/openfl/display3D/Context3DVertexBufferFormat.html +++ b/openfl/display3D/Context3DVertexBufferFormat.html @@ -52,4 +52,4 @@ .navbar .container img { margin: 5px 0 0 4px; } -

    Defines the values to use for specifying vertex buffers.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyBYTES_4:Context3DVertexBufferFormat = 0

    @:value(cast 1)@:impl@:enuminlineread onlyFLOAT_1:Context3DVertexBufferFormat = 1

    @:value(cast 2)@:impl@:enuminlineread onlyFLOAT_2:Context3DVertexBufferFormat = 2

    @:value(cast 3)@:impl@:enuminlineread onlyFLOAT_3:Context3DVertexBufferFormat = 3

    @:value(cast 4)@:impl@:enuminlineread onlyFLOAT_4:Context3DVertexBufferFormat = 4

    \ No newline at end of file +

    Defines the values to use for specifying vertex buffers.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyBYTES_4:Context3DVertexBufferFormat = 0

    @:value(cast 1)@:impl@:enuminlineread onlyFLOAT_1:Context3DVertexBufferFormat = 1

    @:value(cast 2)@:impl@:enuminlineread onlyFLOAT_2:Context3DVertexBufferFormat = 2

    @:value(cast 3)@:impl@:enuminlineread onlyFLOAT_3:Context3DVertexBufferFormat = 3

    @:value(cast 4)@:impl@:enuminlineread onlyFLOAT_4:Context3DVertexBufferFormat = 4

    \ No newline at end of file diff --git a/openfl/display3D/Context3DWrapMode.html b/openfl/display3D/Context3DWrapMode.html index f38c397..feff8e0 100644 --- a/openfl/display3D/Context3DWrapMode.html +++ b/openfl/display3D/Context3DWrapMode.html @@ -54,4 +54,4 @@ }

    Defines the values to use for sampler wrap mode

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyCLAMP:Context3DWrapMode = 0

    Clamp texture coordinates outside the 0..1 range.

    The function is x = max(min(x,0),1)

    @:value(cast 1)@:impl@:enuminlineread onlyCLAMP_U_REPEAT_V:Context3DWrapMode = 1

    Clamp in U axis but Repeat in V axis.

    @:value(cast 2)@:impl@:enuminlineread onlyREPEAT:Context3DWrapMode = 2

    Repeat (tile) texture coordinates outside the 0..1 range.

    -

    The function is x = x<0?1.0-frac(abs(x)):frac(x)

    @:value(cast 3)@:impl@:enuminlineread onlyREPEAT_U_CLAMP_V:Context3DWrapMode = 3

    Repeat in U axis but Clamp in V axis.

    \ No newline at end of file +

    The function is x = x<0?1.0-frac(abs(x)):frac(x)

    @:value(cast 3)@:impl@:enuminlineread onlyREPEAT_U_CLAMP_V:Context3DWrapMode = 3

    Repeat in U axis but Clamp in V axis.

    \ No newline at end of file diff --git a/openfl/display3D/IndexBuffer3D.html b/openfl/display3D/IndexBuffer3D.html index 56aca5c..e7ead80 100644 --- a/openfl/display3D/IndexBuffer3D.html +++ b/openfl/display3D/IndexBuffer3D.html @@ -77,4 +77,4 @@ be loaded. A value for startOffset not equal to zero may be used to load a sub-region of the index data.

    count

    The number of indices in data.

    Throws:

    TypeError

    kNullPointerError when data is null.

    RangeError

    kBadInputSize when count is less than 0 or greater than the length of data, or when startOffset + count is greater than numIndices -given in context3D.createIndexBuffer()`.

    Error

    3768: The Stage3D API may not be used during background execution.

    \ No newline at end of file +given in context3D.createIndexBuffer()`.

    Error

    3768: The Stage3D API may not be used during background execution.

    \ No newline at end of file diff --git a/openfl/display3D/Program3D.html b/openfl/display3D/Program3D.html index e425eaa..32b22d4 100644 --- a/openfl/display3D/Program3D.html +++ b/openfl/display3D/Program3D.html @@ -188,4 +188,4 @@ have a sampler as the second source operand.

    Error

    Indirect Not Allowed: indirect addressing used where not allowed.

    Error

    Swizzle Must Be Scalar: swizzling error.

    Error

    Cant Swizzle 2nd Source: swizzling error.

    Error

    Second Use Of Sampler Must Have Same Params: all samplers that access the same texture must use the same dimension, wrap, filter, special, and mipmap settings.

    Error

    3768: The Stage3D API may not be used during background execution.

    uploadSources(vertexSource:String, fragmentSource:String):Void

    BETA**

    -

    Uploads a pair of rendering programs expressed in GLSL (GL Shader Language).

    \ No newline at end of file +

    Uploads a pair of rendering programs expressed in GLSL (GL Shader Language).

    \ No newline at end of file diff --git a/openfl/display3D/VertexBuffer3D.html b/openfl/display3D/VertexBuffer3D.html index 2dd4e20..acc7884 100644 --- a/openfl/display3D/VertexBuffer3D.html +++ b/openfl/display3D/VertexBuffer3D.html @@ -100,4 +100,4 @@ startVertex not equal to zero may be used to load a sub-region of the vertex data.

    numVertices

    The number of vertices represented by data.

    Throws:

    TypeError

    Null Pointer Error: when data is null.

    RangeError

    Bad Input Size: when number of elements in data is less than numVertices * data32PerVertex given in Context3D createVertexBuffer(), or when startVertex + numVertices is greater than numVertices given in Context3D -createVertexBuffer().

    \ No newline at end of file +createVertexBuffer().

    \ No newline at end of file diff --git a/openfl/display3D/index.html b/openfl/display3D/index.html index 8a553b4..c8dcd88 100644 --- a/openfl/display3D/index.html +++ b/openfl/display3D/index.html @@ -94,4 +94,4 @@

    package ::full::

    setDepthTest() and setStencilAction() methods of a Context3D instance.

    Context3DMipFilter

    Defines the values to use for sampler mipmap filter mode

    Context3DProfile

    Defines the values to use for specifying the Context3D profile.

    Context3DProgramFormat

    Defines the values to use for specifying a Program3D source format.

    Context3DProgramType

    Defines the values to use for specifying whether a shader program is a fragment or a vertex program.

    Context3DRenderMode

    Defines the values to use for specifying the Context3D render mode.

    Context3DStencilAction

    Defines the values to use for specifying stencil actions.

    Context3DTextureFilter

    Defines the values to use for sampler filter mode.

    Context3DTextureFormat

    Defines the values to use for specifying a texture format.

    Context3DTriangleFace

    Constants to specify the orientation of a triangle relative to the view point.

    Context3DVertexBufferFormat

    Defines the values to use for specifying vertex buffers.

    Context3DWrapMode

    Defines the values to use for sampler wrap mode

    IndexBuffer3D

    IndexBuffer3D is used to represent lists of vertex indices comprising graphic elements retained by the graphics subsystem.

    Program3D

    The Program3D class represents a pair of rendering programs (also called "shaders") -uploaded to the rendering context.

    VertexBuffer3D

    The VertexBuffer3D class represents a set of vertex data uploaded to a rendering context.

    \ No newline at end of file +uploaded to the rendering context.

    VertexBuffer3D

    The VertexBuffer3D class represents a set of vertex data uploaded to a rendering context.

    \ No newline at end of file diff --git a/openfl/display3D/textures/CubeTexture.html b/openfl/display3D/textures/CubeTexture.html index a21edca..46e9cf5 100644 --- a/openfl/display3D/textures/CubeTexture.html +++ b/openfl/display3D/textures/CubeTexture.html @@ -231,4 +231,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/display3D/textures/RectangleTexture.html b/openfl/display3D/textures/RectangleTexture.html index 876c031..0b8976d 100644 --- a/openfl/display3D/textures/RectangleTexture.html +++ b/openfl/display3D/textures/RectangleTexture.html @@ -190,4 +190,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/display3D/textures/Texture.html b/openfl/display3D/textures/Texture.html index e665fb3..3e4b2e3 100644 --- a/openfl/display3D/textures/Texture.html +++ b/openfl/display3D/textures/Texture.html @@ -217,4 +217,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/display3D/textures/TextureBase.html b/openfl/display3D/textures/TextureBase.html index 2957178..d87eec3 100644 --- a/openfl/display3D/textures/TextureBase.html +++ b/openfl/display3D/textures/TextureBase.html @@ -176,4 +176,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/display3D/textures/VideoTexture.html b/openfl/display3D/textures/VideoTexture.html index f2b9864..a992a7f 100644 --- a/openfl/display3D/textures/VideoTexture.html +++ b/openfl/display3D/textures/VideoTexture.html @@ -203,4 +203,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/display3D/textures/index.html b/openfl/display3D/textures/index.html index 24df1d2..8abf284 100644 --- a/openfl/display3D/textures/index.html +++ b/openfl/display3D/textures/index.html @@ -90,4 +90,4 @@

    package ::full::

    object (which is not hardware accelerated), copying of video frame to a BitmapData object, and loading of the data onto the GPU which is CPU intensive. Thus, Video texture object was introduced. It allows hardware decoded video to be used in Stage 3D -content.

    \ No newline at end of file +content.

    \ No newline at end of file diff --git a/openfl/errors/ArgumentError.html b/openfl/errors/ArgumentError.html index 18bca02..e738a9d 100644 --- a/openfl/errors/ArgumentError.html +++ b/openfl/errors/ArgumentError.html @@ -76,4 +76,4 @@ available when code is running in the debugger version of Flash Player or the AIR Debug Launcher (ADL). In non-debugger versions of those runtimes, calling this method returns null.

    Returns:

    A string representation of the call stack.

    toString():String

    Returns the string "Error" by default or the value contained in the Error.message -property, if defined.

    Returns:

    The error message.

    \ No newline at end of file +property, if defined.

    Returns:

    The error message.

    \ No newline at end of file diff --git a/openfl/errors/EOFError.html b/openfl/errors/EOFError.html index 15e02f2..10836d6 100644 --- a/openfl/errors/EOFError.html +++ b/openfl/errors/EOFError.html @@ -82,4 +82,4 @@ available when code is running in the debugger version of Flash Player or the AIR Debug Launcher (ADL). In non-debugger versions of those runtimes, calling this method returns null.

    Returns:

    A string representation of the call stack.

    toString():String

    Returns the string "Error" by default or the value contained in the Error.message -property, if defined.

    Returns:

    The error message.

    \ No newline at end of file +property, if defined.

    Returns:

    The error message.

    \ No newline at end of file diff --git a/openfl/errors/Error.html b/openfl/errors/Error.html index 63538b6..2a60776 100644 --- a/openfl/errors/Error.html +++ b/openfl/errors/Error.html @@ -88,4 +88,4 @@ available when code is running in the debugger version of Flash Player or the AIR Debug Launcher (ADL). In non-debugger versions of those runtimes, calling this method returns null.

    Returns:

    A string representation of the call stack.

    toString():String

    Returns the string "Error" by default or the value contained in the Error.message -property, if defined.

    Returns:

    The error message.

    \ No newline at end of file +property, if defined.

    Returns:

    The error message.

    \ No newline at end of file diff --git a/openfl/errors/IOError.html b/openfl/errors/IOError.html index eeb999e..a665a6d 100644 --- a/openfl/errors/IOError.html +++ b/openfl/errors/IOError.html @@ -82,4 +82,4 @@ available when code is running in the debugger version of Flash Player or the AIR Debug Launcher (ADL). In non-debugger versions of those runtimes, calling this method returns null.

    Returns:

    A string representation of the call stack.

    toString():String

    Returns the string "Error" by default or the value contained in the Error.message -property, if defined.

    Returns:

    The error message.

    \ No newline at end of file +property, if defined.

    Returns:

    The error message.

    \ No newline at end of file diff --git a/openfl/errors/IllegalOperationError.html b/openfl/errors/IllegalOperationError.html index 89f80be..8b58175 100644 --- a/openfl/errors/IllegalOperationError.html +++ b/openfl/errors/IllegalOperationError.html @@ -85,4 +85,4 @@ available when code is running in the debugger version of Flash Player or the AIR Debug Launcher (ADL). In non-debugger versions of those runtimes, calling this method returns null.

    Returns:

    A string representation of the call stack.

    toString():String

    Returns the string "Error" by default or the value contained in the Error.message -property, if defined.

    Returns:

    The error message.

    \ No newline at end of file +property, if defined.

    Returns:

    The error message.

    \ No newline at end of file diff --git a/openfl/errors/PermissionError.html b/openfl/errors/PermissionError.html index 8a634b8..55d1aad 100644 --- a/openfl/errors/PermissionError.html +++ b/openfl/errors/PermissionError.html @@ -78,4 +78,4 @@ available when code is running in the debugger version of Flash Player or the AIR Debug Launcher (ADL). In non-debugger versions of those runtimes, calling this method returns null.

    Returns:

    A string representation of the call stack.

    toString():String

    Returns the string "Error" by default or the value contained in the Error.message -property, if defined.

    Returns:

    The error message.

    \ No newline at end of file +property, if defined.

    Returns:

    The error message.

    \ No newline at end of file diff --git a/openfl/errors/RangeError.html b/openfl/errors/RangeError.html index caf5a5e..6ca9c6c 100644 --- a/openfl/errors/RangeError.html +++ b/openfl/errors/RangeError.html @@ -76,4 +76,4 @@ available when code is running in the debugger version of Flash Player or the AIR Debug Launcher (ADL). In non-debugger versions of those runtimes, calling this method returns null.

    Returns:

    A string representation of the call stack.

    toString():String

    Returns the string "Error" by default or the value contained in the Error.message -property, if defined.

    Returns:

    The error message.

    \ No newline at end of file +property, if defined.

    Returns:

    The error message.

    \ No newline at end of file diff --git a/openfl/errors/SecurityError.html b/openfl/errors/SecurityError.html index a33d390..6eec731 100644 --- a/openfl/errors/SecurityError.html +++ b/openfl/errors/SecurityError.html @@ -76,4 +76,4 @@ available when code is running in the debugger version of Flash Player or the AIR Debug Launcher (ADL). In non-debugger versions of those runtimes, calling this method returns null.

    Returns:

    A string representation of the call stack.

    toString():String

    Returns the string "Error" by default or the value contained in the Error.message -property, if defined.

    Returns:

    The error message.

    \ No newline at end of file +property, if defined.

    Returns:

    The error message.

    \ No newline at end of file diff --git a/openfl/errors/TypeError.html b/openfl/errors/TypeError.html index 007c799..48b2d6a 100644 --- a/openfl/errors/TypeError.html +++ b/openfl/errors/TypeError.html @@ -76,4 +76,4 @@ available when code is running in the debugger version of Flash Player or the AIR Debug Launcher (ADL). In non-debugger versions of those runtimes, calling this method returns null.

    Returns:

    A string representation of the call stack.

    toString():String

    Returns the string "Error" by default or the value contained in the Error.message -property, if defined.

    Returns:

    The error message.

    \ No newline at end of file +property, if defined.

    Returns:

    The error message.

    \ No newline at end of file diff --git a/openfl/errors/index.html b/openfl/errors/index.html index 2d371df..e2b343d 100644 --- a/openfl/errors/index.html +++ b/openfl/errors/index.html @@ -98,4 +98,4 @@

    package ::full::

    operation is attempted on a socket that has not connected or that has become disconnected.

    IllegalOperationError

    The IllegalOperationError exception is thrown when a method is not implemented or the implementation doesn't cover the current usage.

    PermissionError

    Permission error is dispatched when the application tries to access a -resource without requesting appropriate permissions.

    RangeError

    SecurityError

    TypeError

    \ No newline at end of file +resource without requesting appropriate permissions.

    RangeError

    SecurityError

    TypeError

    \ No newline at end of file diff --git a/openfl/events/AccelerometerEvent.html b/openfl/events/AccelerometerEvent.html index 058568b..c83f33a 100644 --- a/openfl/events/AccelerometerEvent.html +++ b/openfl/events/AccelerometerEvent.html @@ -135,4 +135,4 @@ calls to this method have no effect. This method can be called in any phase of the event flow.

    Note: This method does not cancel the behavior associated with -this event; see preventDefault() for that functionality.

    \ No newline at end of file +this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/ActivityEvent.html b/openfl/events/ActivityEvent.html index b614575..b9065fe 100644 --- a/openfl/events/ActivityEvent.html +++ b/openfl/events/ActivityEvent.html @@ -124,4 +124,4 @@ calls to this method have no effect. This method can be called in any phase of the event flow.

    Note: This method does not cancel the behavior associated with -this event; see preventDefault() for that functionality.

    \ No newline at end of file +this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/AsyncErrorEvent.html b/openfl/events/AsyncErrorEvent.html index 332042b..c6c1500 100644 --- a/openfl/events/AsyncErrorEvent.html +++ b/openfl/events/AsyncErrorEvent.html @@ -131,4 +131,4 @@ calls to this method have no effect. This method can be called in any phase of the event flow.

    Note: This method does not cancel the behavior associated with -this event; see preventDefault() for that functionality.

    \ No newline at end of file +this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/ContextMenuEvent.html b/openfl/events/ContextMenuEvent.html index 0acf200..76ade46 100644 --- a/openfl/events/ContextMenuEvent.html +++ b/openfl/events/ContextMenuEvent.html @@ -143,4 +143,4 @@ calls to this method have no effect. This method can be called in any phase of the event flow.

    Note: This method does not cancel the behavior associated with -this event; see preventDefault() for that functionality.

    \ No newline at end of file +this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/DNSResolverEvent.html b/openfl/events/DNSResolverEvent.html index 8b50a38..c5c4c39 100644 --- a/openfl/events/DNSResolverEvent.html +++ b/openfl/events/DNSResolverEvent.html @@ -116,4 +116,4 @@ this event; see preventDefault() for that functionality.

    toString():String

    Returns a string containing all the properties of the Event object. The string is in the following format:

    [Event type=_value_ bubbles=_value_ -cancelable=_value_]

    Returns:

    A string containing all the properties of the Event object.

    \ No newline at end of file +cancelable=_value_]

    Returns:

    A string containing all the properties of the Event object.

    \ No newline at end of file diff --git a/openfl/events/DataEvent.html b/openfl/events/DataEvent.html index 37a8750..9ef199f 100644 --- a/openfl/events/DataEvent.html +++ b/openfl/events/DataEvent.html @@ -130,4 +130,4 @@ calls to this method have no effect. This method can be called in any phase of the event flow.

    Note: This method does not cancel the behavior associated with -this event; see preventDefault() for that functionality.

    \ No newline at end of file +this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/DatagramSocketDataEvent.html b/openfl/events/DatagramSocketDataEvent.html index 44719c4..586b06b 100644 --- a/openfl/events/DatagramSocketDataEvent.html +++ b/openfl/events/DatagramSocketDataEvent.html @@ -110,4 +110,4 @@ calls to this method have no effect. This method can be called in any phase of the event flow.

    Note: This method does not cancel the behavior associated with -this event; see preventDefault() for that functionality.

    \ No newline at end of file +this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/DeviceRotationEvent.html b/openfl/events/DeviceRotationEvent.html index abd0026..15685a8 100644 --- a/openfl/events/DeviceRotationEvent.html +++ b/openfl/events/DeviceRotationEvent.html @@ -119,4 +119,4 @@ this event; see preventDefault() for that functionality.

    toString():String

    Returns a string containing all the properties of the Event object. The string is in the following format:

    [Event type=_value_ bubbles=_value_ -cancelable=_value_]

    Returns:

    A string containing all the properties of the Event object.

    \ No newline at end of file +cancelable=_value_]

    Returns:

    A string containing all the properties of the Event object.

    \ No newline at end of file diff --git a/openfl/events/ErrorEvent.html b/openfl/events/ErrorEvent.html index 90e1d6e..f398be8 100644 --- a/openfl/events/ErrorEvent.html +++ b/openfl/events/ErrorEvent.html @@ -135,4 +135,4 @@ calls to this method have no effect. This method can be called in any phase of the event flow.

    Note: This method does not cancel the behavior associated with -this event; see preventDefault() for that functionality.

    \ No newline at end of file +this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/Event.html b/openfl/events/Event.html index 4cc624e..1655e5e 100644 --- a/openfl/events/Event.html +++ b/openfl/events/Event.html @@ -309,4 +309,4 @@ this event; see preventDefault() for that functionality.

    toString():String

    Returns a string containing all the properties of the Event object. The string is in the following format:

    [Event type=_value_ bubbles=_value_ -cancelable=_value_]

    Returns:

    A string containing all the properties of the Event object.

    \ No newline at end of file +cancelable=_value_]

    Returns:

    A string containing all the properties of the Event object.

    \ No newline at end of file diff --git a/openfl/events/EventDispatcher.html b/openfl/events/EventDispatcher.html index a6c9f4c..880fd4b 100644 --- a/openfl/events/EventDispatcher.html +++ b/openfl/events/EventDispatcher.html @@ -56,18 +56,17 @@ .navbar .container img { margin: 5px 0 0 4px; } -

    The EventDispatcher class is the base class for all classes that dispatch +

    The EventDispatcher class is the base class for all classes that dispatch events. The EventDispatcher class implements the IEventDispatcher interface and is the base class for the DisplayObject class. The EventDispatcher class allows any object on the display list to be an event target and as such, to use the methods of the IEventDispatcher interface.

    -

    Event targets are an important part of the Flash® Player and -Adobe® AIR® event model. The event target serves as -the focal point for how events flow through the display list hierarchy. -When an event such as a mouse click or a keypress occurs, Flash Player or -the AIR application dispatches an event object into the event flow from the -root of the display list. The event object then makes its way through the -display list until it reaches the event target, at which point it begins +

    Event targets are an important part of the OpenFL event model. The event +target serves as the focal point for how events flow through the display +list hierarchy. When an event such as a mouse click or a keypress occurs, +the OpenFL application dispatches an event object into the event flow fro +the root of the display list. The event object then makes its way through +the display list until it reaches the event target, at which point it begins its return trip through the display list. This round-trip journey to the event target is conceptually divided into three phases: the capture phase comprises the journey from the root to the last node before the event @@ -79,13 +78,13 @@ impossible(that is, if the class is already extending another class), you can instead implement the IEventDispatcher interface, create an EventDispatcher member, and write simple hooks to route calls into the -aggregated EventDispatcher.

    Events:

    activate

    [broadcast event] Dispatched when the Flash Player or AIR -application gains operating system focus and becomes +aggregated EventDispatcher.

    Events:

    activate

    [broadcast event] Dispatched when the OpenFL application +gains operating system focus and becomes active. This event is a broadcast event, which means that it is dispatched by all EventDispatcher objects with a listener registered for this event. For more information -about broadcast events, see the DisplayObject class.

    deactivate

    [broadcast event] Dispatched when the Flash Player or AIR -application operating loses system focus and is becoming +about broadcast events, see the DisplayObject class.

    deactivate

    [broadcast event] Dispatched when the OpenFL application +loses operating system focus and is becoming inactive. This event is a broadcast event, which means that it is dispatched by all EventDispatcher objects with a listener registered for this event. For more @@ -224,4 +223,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/events/EventPhase.html b/openfl/events/EventPhase.html index 47d5ad9..cce9a83 100644 --- a/openfl/events/EventPhase.html +++ b/openfl/events/EventPhase.html @@ -54,4 +54,4 @@ margin: 5px 0 0 4px; }

    The EventPhase class provides values for the eventPhase -property of the Event class.

    Variables

    @:value(cast 2)@:impl@:enuminlineread onlyAT_TARGET:EventPhase = 2

    The target phase, which is the second phase of the event flow.

    @:value(cast 3)@:impl@:enuminlineread onlyBUBBLING_PHASE:EventPhase = 3

    The bubbling phase, which is the third phase of the event flow.

    @:value(cast 1)@:impl@:enuminlineread onlyCAPTURING_PHASE:EventPhase = 1

    The capturing phase, which is the first phase of the event flow.

    \ No newline at end of file +property of the Event class.

    Variables

    @:value(cast 2)@:impl@:enuminlineread onlyAT_TARGET:EventPhase = 2

    The target phase, which is the second phase of the event flow.

    @:value(cast 3)@:impl@:enuminlineread onlyBUBBLING_PHASE:EventPhase = 3

    The bubbling phase, which is the third phase of the event flow.

    @:value(cast 1)@:impl@:enuminlineread onlyCAPTURING_PHASE:EventPhase = 1

    The capturing phase, which is the first phase of the event flow.

    \ No newline at end of file diff --git a/openfl/events/EventType.html b/openfl/events/EventType.html index ccf1e7f..2e4e48d 100644 --- a/openfl/events/EventType.html +++ b/openfl/events/EventType.html @@ -59,4 +59,4 @@ event listener, it should be a MouseEvent:

    addEventListener(MouseEvent.CLICK, function(event:TouchEvent) {});

    OpenFL uses the EventType abstract for standard event types -to turn these logical errors into a compile-time errors.

    \ No newline at end of file +to turn these logical errors into a compile-time errors.

    \ No newline at end of file diff --git a/openfl/events/FileListEvent.html b/openfl/events/FileListEvent.html index e8bcd17..0b81616 100644 --- a/openfl/events/FileListEvent.html +++ b/openfl/events/FileListEvent.html @@ -108,4 +108,4 @@ this event; see preventDefault() for that functionality.

    toString():String

    Returns a string containing all the properties of the Event object. The string is in the following format:

    [Event type=_value_ bubbles=_value_ -cancelable=_value_]

    Returns:

    A string containing all the properties of the Event object.

    \ No newline at end of file +cancelable=_value_]

    Returns:

    A string containing all the properties of the Event object.

    \ No newline at end of file diff --git a/openfl/events/FocusEvent.html b/openfl/events/FocusEvent.html index 4dc48c1..4aeb852 100644 --- a/openfl/events/FocusEvent.html +++ b/openfl/events/FocusEvent.html @@ -155,4 +155,4 @@ calls to this method have no effect. This method can be called in any phase of the event flow.

    Note: This method does not cancel the behavior associated with -this event; see preventDefault() for that functionality.

    \ No newline at end of file +this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/FullScreenEvent.html b/openfl/events/FullScreenEvent.html index b66f214..f3bf3a3 100644 --- a/openfl/events/FullScreenEvent.html +++ b/openfl/events/FullScreenEvent.html @@ -128,4 +128,4 @@ calls to this method have no effect. This method can be called in any phase of the event flow.

    Note: This method does not cancel the behavior associated with -this event; see preventDefault() for that functionality.

    \ No newline at end of file +this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/GameInputEvent.html b/openfl/events/GameInputEvent.html index 11dfc00..1d8f84a 100644 --- a/openfl/events/GameInputEvent.html +++ b/openfl/events/GameInputEvent.html @@ -105,4 +105,4 @@ calls to this method have no effect. This method can be called in any phase of the event flow.

    Note: This method does not cancel the behavior associated with -this event; see preventDefault() for that functionality.

    \ No newline at end of file +this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/GeolocationEvent.html b/openfl/events/GeolocationEvent.html index 6cf53fb..b0f520a 100644 --- a/openfl/events/GeolocationEvent.html +++ b/openfl/events/GeolocationEvent.html @@ -124,4 +124,4 @@ this event; see preventDefault() for that functionality.

    toString():String

    Returns a string containing all the properties of the Event object. The string is in the following format:

    [Event type=_value_ bubbles=_value_ -cancelable=_value_]

    Returns:

    A string containing all the properties of the Event object.

    \ No newline at end of file +cancelable=_value_]

    Returns:

    A string containing all the properties of the Event object.

    \ No newline at end of file diff --git a/openfl/events/HTTPStatusEvent.html b/openfl/events/HTTPStatusEvent.html index 7fb6a19..1dd3ddb 100644 --- a/openfl/events/HTTPStatusEvent.html +++ b/openfl/events/HTTPStatusEvent.html @@ -151,4 +151,4 @@ calls to this method have no effect. This method can be called in any phase of the event flow.

    Note: This method does not cancel the behavior associated with -this event; see preventDefault() for that functionality.

    \ No newline at end of file +this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/IEventDispatcher.html b/openfl/events/IEventDispatcher.html index 4d23c5f..37b3dfa 100644 --- a/openfl/events/IEventDispatcher.html +++ b/openfl/events/IEventDispatcher.html @@ -55,7 +55,7 @@ }

    The IEventDispatcher interface defines methods for adding or removing event listeners, checks whether specific types of event listeners are registered, and dispatches events.

    -

    Event targets are an important part of the Flash� Player and Adobe AIR event model. The +

    Event targets are an important part of the OpenFL event model. The event target serves as the focal point for how events flow through the display list hierarchy. When an event such as a mouse click or a keypress occurs, an event object is dispatched into the event flow from the root of the display list. The event object @@ -148,4 +148,4 @@ hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type will be -triggered; false otherwise.

    \ No newline at end of file +triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/events/IOErrorEvent.html b/openfl/events/IOErrorEvent.html index 7d9f068..5cd5d89 100644 --- a/openfl/events/IOErrorEvent.html +++ b/openfl/events/IOErrorEvent.html @@ -136,4 +136,4 @@ calls to this method have no effect. This method can be called in any phase of the event flow.

    Note: This method does not cancel the behavior associated with -this event; see preventDefault() for that functionality.

    \ No newline at end of file +this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/InvokeEvent.html b/openfl/events/InvokeEvent.html index b9de09b..7f5ed2d 100644 --- a/openfl/events/InvokeEvent.html +++ b/openfl/events/InvokeEvent.html @@ -108,4 +108,4 @@ this event; see preventDefault() for that functionality.

    toString():String

    Returns a string containing all the properties of the Event object. The string is in the following format:

    [Event type=_value_ bubbles=_value_ -cancelable=_value_]

    Returns:

    A string containing all the properties of the Event object.

    \ No newline at end of file +cancelable=_value_]

    Returns:

    A string containing all the properties of the Event object.

    \ No newline at end of file diff --git a/openfl/events/KeyboardEvent.html b/openfl/events/KeyboardEvent.html index a7d1cdf..5099700 100644 --- a/openfl/events/KeyboardEvent.html +++ b/openfl/events/KeyboardEvent.html @@ -157,4 +157,4 @@ calls to this method have no effect. This method can be called in any phase of the event flow.

    Note: This method does not cancel the behavior associated with -this event; see preventDefault() for that functionality.

    \ No newline at end of file +this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/MouseEvent.html b/openfl/events/MouseEvent.html index 9693aa7..7dd44e5 100644 --- a/openfl/events/MouseEvent.html +++ b/openfl/events/MouseEvent.html @@ -230,4 +230,4 @@ calls to this method have no effect. This method can be called in any phase of the event flow.

    Note: This method does not cancel the behavior associated with -this event; see preventDefault() for that functionality.

    \ No newline at end of file +this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/NativeProcessExitEvent.html b/openfl/events/NativeProcessExitEvent.html index c18ab53..f6bcae4 100644 --- a/openfl/events/NativeProcessExitEvent.html +++ b/openfl/events/NativeProcessExitEvent.html @@ -122,4 +122,4 @@ calls to this method have no effect. This method can be called in any phase of the event flow.

    Note: This method does not cancel the behavior associated with -this event; see preventDefault() for that functionality.

    \ No newline at end of file +this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/NativeWindowBoundsEvent.html b/openfl/events/NativeWindowBoundsEvent.html index 03e77e1..eabd09d 100644 --- a/openfl/events/NativeWindowBoundsEvent.html +++ b/openfl/events/NativeWindowBoundsEvent.html @@ -119,4 +119,4 @@ calls to this method have no effect. This method can be called in any phase of the event flow.

    Note: This method does not cancel the behavior associated with -this event; see preventDefault() for that functionality.

    \ No newline at end of file +this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/NativeWindowDisplayStateEvent.html b/openfl/events/NativeWindowDisplayStateEvent.html index 40b351e..3942fda 100644 --- a/openfl/events/NativeWindowDisplayStateEvent.html +++ b/openfl/events/NativeWindowDisplayStateEvent.html @@ -119,4 +119,4 @@ calls to this method have no effect. This method can be called in any phase of the event flow.

    Note: This method does not cancel the behavior associated with -this event; see preventDefault() for that functionality.

    \ No newline at end of file +this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/NetStatusEvent.html b/openfl/events/NetStatusEvent.html index 10c99c4..18abf98 100644 --- a/openfl/events/NetStatusEvent.html +++ b/openfl/events/NetStatusEvent.html @@ -138,4 +138,4 @@ calls to this method have no effect. This method can be called in any phase of the event flow.

    Note: This method does not cancel the behavior associated with -this event; see preventDefault() for that functionality.

    \ No newline at end of file +this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/OutputProgressEvent.html b/openfl/events/OutputProgressEvent.html index bb12987..4fbdd89 100644 --- a/openfl/events/OutputProgressEvent.html +++ b/openfl/events/OutputProgressEvent.html @@ -105,4 +105,4 @@ calls to this method have no effect. This method can be called in any phase of the event flow.

    Note: This method does not cancel the behavior associated with -this event; see preventDefault() for that functionality.

    \ No newline at end of file +this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/PermissionEvent.html b/openfl/events/PermissionEvent.html index a37d70b..7b62b0b 100644 --- a/openfl/events/PermissionEvent.html +++ b/openfl/events/PermissionEvent.html @@ -116,4 +116,4 @@ calls to this method have no effect. This method can be called in any phase of the event flow.

    Note: This method does not cancel the behavior associated with -this event; see preventDefault() for that functionality.

    \ No newline at end of file +this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/ProgressEvent.html b/openfl/events/ProgressEvent.html index eef355c..fb522ff 100644 --- a/openfl/events/ProgressEvent.html +++ b/openfl/events/ProgressEvent.html @@ -137,4 +137,4 @@ calls to this method have no effect. This method can be called in any phase of the event flow.

    Note: This method does not cancel the behavior associated with -this event; see preventDefault() for that functionality.

    \ No newline at end of file +this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/RenderEvent.html b/openfl/events/RenderEvent.html index 26644ee..681fc68 100644 --- a/openfl/events/RenderEvent.html +++ b/openfl/events/RenderEvent.html @@ -133,4 +133,4 @@ calls to this method have no effect. This method can be called in any phase of the event flow.

    Note: This method does not cancel the behavior associated with -this event; see preventDefault() for that functionality.

    \ No newline at end of file +this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/SampleDataEvent.html b/openfl/events/SampleDataEvent.html index e4e6763..4ba9ab3 100644 --- a/openfl/events/SampleDataEvent.html +++ b/openfl/events/SampleDataEvent.html @@ -164,4 +164,4 @@ calls to this method have no effect. This method can be called in any phase of the event flow.

    Note: This method does not cancel the behavior associated with -this event; see preventDefault() for that functionality.

    \ No newline at end of file +this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/ScreenMouseEvent.html b/openfl/events/ScreenMouseEvent.html index 143c739..f450b77 100644 --- a/openfl/events/ScreenMouseEvent.html +++ b/openfl/events/ScreenMouseEvent.html @@ -168,4 +168,4 @@ calls to this method have no effect. This method can be called in any phase of the event flow.

    Note: This method does not cancel the behavior associated with -this event; see preventDefault() for that functionality.

    \ No newline at end of file +this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/SecurityErrorEvent.html b/openfl/events/SecurityErrorEvent.html index 73289b1..30561a1 100644 --- a/openfl/events/SecurityErrorEvent.html +++ b/openfl/events/SecurityErrorEvent.html @@ -145,4 +145,4 @@ calls to this method have no effect. This method can be called in any phase of the event flow.

    Note: This method does not cancel the behavior associated with -this event; see preventDefault() for that functionality.

    \ No newline at end of file +this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/ServerSocketConnectEvent.html b/openfl/events/ServerSocketConnectEvent.html index 43d6453..ce7b0d8 100644 --- a/openfl/events/ServerSocketConnectEvent.html +++ b/openfl/events/ServerSocketConnectEvent.html @@ -115,4 +115,4 @@ calls to this method have no effect. This method can be called in any phase of the event flow.

    Note: This method does not cancel the behavior associated with -this event; see preventDefault() for that functionality.

    \ No newline at end of file +this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/TextEvent.html b/openfl/events/TextEvent.html index 3d3fd2e..5b79b90 100644 --- a/openfl/events/TextEvent.html +++ b/openfl/events/TextEvent.html @@ -131,4 +131,4 @@ calls to this method have no effect. This method can be called in any phase of the event flow.

    Note: This method does not cancel the behavior associated with -this event; see preventDefault() for that functionality.

    \ No newline at end of file +this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/TimerEvent.html b/openfl/events/TimerEvent.html index b6830e5..1c39bbf 100644 --- a/openfl/events/TimerEvent.html +++ b/openfl/events/TimerEvent.html @@ -119,4 +119,4 @@ calls to this method have no effect. This method can be called in any phase of the event flow.

    Note: This method does not cancel the behavior associated with -this event; see preventDefault() for that functionality.

    \ No newline at end of file +this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/TouchEvent.html b/openfl/events/TouchEvent.html index 5a85b31..326ff55 100644 --- a/openfl/events/TouchEvent.html +++ b/openfl/events/TouchEvent.html @@ -205,4 +205,4 @@ calls to this method have no effect. This method can be called in any phase of the event flow.

    Note: This method does not cancel the behavior associated with -this event; see preventDefault() for that functionality.

    \ No newline at end of file +this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/UncaughtErrorEvent.html b/openfl/events/UncaughtErrorEvent.html index c56c1b1..128ba3f 100644 --- a/openfl/events/UncaughtErrorEvent.html +++ b/openfl/events/UncaughtErrorEvent.html @@ -221,4 +221,4 @@ calls to this method have no effect. This method can be called in any phase of the event flow.

    Note: This method does not cancel the behavior associated with -this event; see preventDefault() for that functionality.

    \ No newline at end of file +this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/UncaughtErrorEvents.html b/openfl/events/UncaughtErrorEvents.html index 574027a..0b6b7a2 100644 --- a/openfl/events/UncaughtErrorEvents.html +++ b/openfl/events/UncaughtErrorEvents.html @@ -111,4 +111,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/events/VideoTextureEvent.html b/openfl/events/VideoTextureEvent.html index a828fcf..6f2c7dc 100644 --- a/openfl/events/VideoTextureEvent.html +++ b/openfl/events/VideoTextureEvent.html @@ -107,4 +107,4 @@ calls to this method have no effect. This method can be called in any phase of the event flow.

    Note: This method does not cancel the behavior associated with -this event; see preventDefault() for that functionality.

    \ No newline at end of file +this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/index.html b/openfl/events/index.html index a8d2c9d..1fd633b 100644 --- a/openfl/events/index.html +++ b/openfl/events/index.html @@ -179,4 +179,4 @@

    package ::full::

    events. An instance of this class dispatches an uncaughtError event when a runtime error occurs and the error isn't detected and handled in your code. -Use the following properties to access an UncaughtErrorEvents instance:

    VideoTextureEvent

    Almost exactly StageVideoEvent.

    \ No newline at end of file +Use the following properties to access an UncaughtErrorEvents instance:

    VideoTextureEvent

    Almost exactly StageVideoEvent.

    \ No newline at end of file diff --git a/openfl/external/ExternalInterface.html b/openfl/external/ExternalInterface.html index aaaadc2..0b9536b 100644 --- a/openfl/external/ExternalInterface.html +++ b/openfl/external/ExternalInterface.html @@ -3,7 +3,7 @@ openfl.external.ExternalInterface - API Reference

    The ExternalInterface class is an application programming interface that enables straightforward communication between ActionScript and the SWF -container� for example, an HTML page with JavaScript or a desktop +container — for example, an HTML page with JavaScript or a desktop application that uses Flash Player to display a SWF file.

    Using the ExternalInterface class, you can call an ActionScript function in the Flash runtime, using JavaScript in the HTML page. The ActionScript @@ -173,10 +173,10 @@ for a mouse click or keypress event).

    Parameters:

    functionName

    The alphanumeric name of the function to call in the container. Using a non-alphanumeric function name causes a runtime error(error 2155). You can use a -try..catch block to handle the error.

    Returns:

    The response received from the container. If the call failed� +try..catch block to handle the error.

    Returns:

    The response received from the container. If the call failed — for example, if there is no such function in the container, the interface is not available, a recursion occurred(with a Netscape -or Opera browser), or there is a security issue� +or Opera browser), or there is a security issue — null is returned and an error is thrown.

    Throws:

    Error

    The container does not support outgoing calls. Outgoing calls are supported only in Internet Explorer for Windows and browsers that use the @@ -189,4 +189,4 @@

    <param name="allowScriptAccess" value="always" />

    1. In the SWF file, add the following ActionScript:
    -

    openfl.system.Security.allowDomain(_sourceDomain_)

    \ No newline at end of file +

    openfl.system.Security.allowDomain(_sourceDomain_)

    \ No newline at end of file diff --git a/openfl/external/index.html b/openfl/external/index.html index e411cbf..55df1ba 100644 --- a/openfl/external/index.html +++ b/openfl/external/index.html @@ -87,5 +87,5 @@

    package ::full::

    -->
    ..
    ExternalInterface

    The ExternalInterface class is an application programming interface that enables straightforward communication between ActionScript and the SWF -container� for example, an HTML page with JavaScript or a desktop -application that uses Flash Player to display a SWF file.

    \ No newline at end of file +container — for example, an HTML page with JavaScript or a desktop +application that uses Flash Player to display a SWF file.

    \ No newline at end of file diff --git a/openfl/filesystem/File.html b/openfl/filesystem/File.html index 1851160..4bea51c 100644 --- a/openfl/filesystem/File.html +++ b/openfl/filesystem/File.html @@ -73,13 +73,13 @@ properties as the basis for referencing other files used by the application. Then use the resolvePath() method to refine the path. For example, this code points to the preferences.xml file in the application storage directory:

    -
    	var prefsFile:File = File.applicationStorageDirectory;
    -	prefsFile = prefsFile.resolvePath("preferences.xml");
    +
    var prefsFile:File = File.applicationStorageDirectory;
    +prefsFile = prefsFile.resolvePath("preferences.xml");

    If you use a literal native path in referencing a file, it will only work on one platform. For example, the following File object would only work on Windows:

    -
    	new File("C:\Documents and Settings\joe\My Documents\test.txt")
    +
    new File("C:\Documents and Settings\joe\My Documents\test.txt")

    The application storage directory is particularly useful. It gives an application-specific -storage directory for the AIR application. It is defined by the File.applicationStorageDirectory +storage directory for the OpenFL application. It is defined by the File.applicationStorageDirectory property.

    Events:

    cancel

    Dispatched when a pending asynchronous operation is canceled.

    complete

    Dispatched when an asynchronous operation is complete.

    directoryListing

    Dispatched when a directory list is available as a result of a call to the getDirectoryListingAsync() method.

    ioError

    Dispatched when an error occurs during an asynchronous file operation.

    securityError

    Dispatched when an operation violates a security constraint.

    select

    Dispatched when the user selects a file or directory from a file- or directory-browsing dialog box.

    selectMultiple

    Dispatched when the user selects files from the dialog box opened @@ -118,7 +118,7 @@ application storage directory using the nativePath or url property, it will only work on the platform for which that path is valid.

    The following code creates a File object pointing to the "images" subdirectory of the application storage directory.

    -
    import openfl.filesystem.File;
    +
    import openfl.filesystem.File;
     
     var tempFiles:File = File.applicationStorageDirectory;
     tempFiles = tempFiles.resolvePath("images/");
    @@ -128,12 +128,12 @@
     platform for which that path is valid.

    If an operating system does not support a desktop directory, a suitable directory in the file system is used instead.

    The following code outputs a list of files and directories contained in the user's desktop directory.

    -
    import openfl.filesystem.File;
    +
    import openfl.filesystem.File;
     var desktop:File = File.desktopDirectory;
     
     var files:Array = desktop.getDirectoryListing();
     
    -for (var i:uint = 0; i < files.length; i++) {
    +for (i in 0...files.length) {
     	trace(files[i].nativePath);
     }

    staticread onlydocumentsDirectory:File

    The user's documents directory.

    On Windows, this is the My Documents directory (for example, C:\Documents and Settings\userName\My @@ -146,7 +146,7 @@ is used instead.

    The following code uses the File.documentsDirectory property and the File.createDirectory() method to ensure that a directory named "OpenFL Test" exists in the user's documents directory.

    -
    import openfl.filesystem.File;
    +
    import openfl.filesystem.File;
     
     var directory:File = File.documentsDirectory;
     directory = directory.resolvePath("OpenFL Test");
    @@ -171,10 +171,10 @@
     

    If an operating system does not support a user directory, a suitable directory in the file system is used instead.

    The following code outputs a list of files and directories contained in the root level of the user directory:

    -
    import openfl.filesystem.File;
    +
    import openfl.filesystem.File;
     
     var files:Array = File.userDirectory.listDirectory();
    -for (var i:uint = 0; i < files.length; i++) {
    +for (i in 0...files.length) {
     	trace(files[i].nativePath);
     }

    Static methods

    staticcreateTempDirectory():File

    Returns a reference to a new temporary directory. This is a new directory in the system's temporary directory path.

    @@ -184,7 +184,7 @@ devices it is not deleted automatically.

    Returns:

    File A File object referencing the new temporary directory. The following code uses the createTempFile() method to obtain a reference to a new temporary directory.

    -
    import openfl.File;
    +
    import openfl.File;
     var temp:File = File.createTempDirectory();
     trace(temp.nativePath);

    Each time you run this code, a new (unique) file is created.

    staticcreateTempFile():File

    Returns a reference to a new temporary file. This is a new file in the system's temporary @@ -194,7 +194,7 @@

    You may want to delete the temporary file before closing the application, since it is not deleted automatically.

    Returns:

    File A File object referencing the new temporary file; The following code uses the createTempFile() method to obtain a reference to a new temporary file.

    -
    import openfl.File;
    +
    import openfl.File;
     var temp:File = File.createTempFile();
     trace(temp.nativePath);

    staticgetRootDirectories():Array<File>

    Returns an array of File objects, listing the file system root directories.

    For example, on Windows this is a list of volumes such as the C: drive and the D: drive. An empty @@ -208,11 +208,11 @@ The following code outputs a list of root directories: - ```hx + ```haxe import flash.filesystem.File; var rootDirs:Array = File.getRootDirectories(); - for (var i:uint = 0; i < rootDirs.length; i++) { + for (i in 0...rootDirs.length) { trace(rootDirs[i].nativePath); } ``` @@ -231,12 +231,12 @@

    You can then use the resolvePath() method to get a path relative to these directories. For example, the following code sets up a File object to point to the settings.xml file in the application storage directory:

    -
    var file:File = File.applicationStorageDirectory.resolvePath("settings.xml");

    Parameters:

    path

    The path to the file. You can specify the path by using either a URL or native path (platform-specific) +

    var file:File = File.applicationStorageDirectory.resolvePath("settings.xml");

    Parameters:

    path

    The path to the file. You can specify the path by using either a URL or native path (platform-specific) notation.

    Throws:

    ArgumentError

    The syntax of the path parameter is invalid.

    Variables

    read onlyexists:Bool

    Indicates whether the referenced file or directory exists. The value is true if the File object points to an existing file or directory, false otherwise.

    The following code creates a temporary file, then deletes it and uses the File.exists property to check for the existence of the file.

    -
    import openfl.filesystem.*;
    +
    import openfl.filesystem.*;
     
     var temp:File = File.createTempFile();
     trace(temp.exists); // true
    @@ -247,10 +247,10 @@
     icon property is null.

    read onlyisDirectory:Bool

    Indicates whether the reference is to a directory. The value is true if the File object points to a directory; false otherwise.

    The following code creates an array of File objects pointing to files and directories in the user directory and then uses the isDirectory property to list only those File objects that point to directories (not to files).

    -
    import openfl.filesystem.*;
    +
    import openfl.filesystem.*;
     
     var userDirFiles:Array = File.userDirectory.getDirectoryListing();
    -for (var i:uint = 0; i < userDirFiles.length; i++) {
    +for (i in 0...userDirFiles.length) {
     	if (userDirFiles[i].isDirectory) {
     		trace(userDirFiles[i].nativePath);
     	}
    @@ -258,10 +258,10 @@
     referenced file or directory is hidden, false otherwise.

    The following code creates an array of File objects pointing to files and directories in the user directory and then uses the isHidden property to list hidden files and directories.

    -
    import openfl.filesystem.*;
    +
    import openfl.filesystem.*;
     
     var userDirFiles:Array = File.userDirectory.getDirectoryListing();
    -for (var i:uint = 0; i < userDirFiles.length; i++) {
    +for (i in 0...userDirFiles.length) {
     	if (userDirFiles[i].isHidden) {
     		trace(userDirFiles[i].nativePath);
     	}
    @@ -282,7 +282,7 @@
     

    You can use the resolvePath() method to get a path relative to these directories.

    Throws:

    ArgumentError

    The syntax of the path is invalid.

    SecurityError

    The caller is not in the application security sandbox. The following code shows the difference between the nativePath property and the url property of a File object. The comments show results on an example Windows computer.

    -
    import openfl.filesystem.File;
    +
    import openfl.filesystem.File;
     var docs:File = File.documentsDirectory;
     trace(docs.nativePath); // C:\Documents and Settings\turing\My Documents
     trace(docs.url); // file:///C:/Documents%20and%20Settings/turing/My%20Documents

    read onlyparent:File

    The directory that contains the file or directory referenced by this File object.

    @@ -291,7 +291,7 @@

    This property is identical to the return value for resolvePath("..") except that the parent of a root directory is null.

    The following code uses the parent property to show the directory that contains a temporary file.

    -
    import openfl.filesystem.File;
    +
    import openfl.filesystem.File;
     
     var tempFile:File = File.createTempDirectory();
     trace(tempFile.parent.nativePath);
    @@ -304,7 +304,7 @@
     browseForDirectory()) is currently running.
     The following code uses the File.browseForDirectory() method to let the user select a directory. When the directory
     is selected, the code lists the contents of the selected directory in the trace() output.

    -
    import openfl.filesystem.File;
    +
    import openfl.filesystem.File;
     import openfl.events.Event;
     var directory:File = File.documentsDirectory;
     try
    @@ -316,11 +316,11 @@
     {
     	trace("Failed:", error.message);
     }
    -function directorySelected(event:Event):void
    +function directorySelected(event:Event):Void
     {
     	directory = event.target as File;
     	var files:Array = directory.getDirectoryListing();
    -	for(var i:uint = 0; i < files.length; i++)
    +	for(i in 0...files.length)
     	{
     		trace(files[i].name);
     	}
    @@ -333,7 +333,7 @@
     browseForDirectory()) is currently running.

    SecurityError

    The application does not have the necessary permissions. The following code uses the File.browseForOpen() method to let the user choose a text file. When the file is selected, the code reads the file data into a string.

    -
    import openfl.filesystem.*;
    +
    import openfl.filesystem.*;
     import openfl.events.Event;
     import openfl.net.FileFilter;
     var fileToOpen:File = new File();
    @@ -347,7 +347,7 @@
     {
     	trace("Failed:", error.message);
     }
    -function fileSelected(event:Event):void
    +function fileSelected(event:Event):Void
     {
     	var stream:FileStream = new FileStream();
     	stream.open(event.target, FileMode.READ);
    @@ -364,7 +364,7 @@
     browseForDirectory()) is currently running.

    SecurityError

    The application does not have the necessary permissions. The following code uses the File.browseForOpenMultiple() method to let the user choose multiple files. When the files are selected, the code outputs the paths for the selected files.

    -
    import openfl.filesystem.*;
    +
    import openfl.filesystem.*;
     import openfl.events.FileListEvent;
     var docsDir:File = File.documentsDirectory;
     try
    @@ -376,9 +376,9 @@
     {
     	trace("Failed:", error.message);
     }
    -function filesSelected(event:FileListEvent):void
    +function filesSelected(event:FileListEvent):Void
     {
    -	for (var i:uint = 0; i < event.files.length; i++)
    +	for (i in 0...event.files.length)
     	{
     		trace(event.files[i].nativePath);
     	}
    @@ -392,7 +392,7 @@
     browseForDirectory()) is currently running.

    SecurityError

    The application does not have the necessary permissions. The following code uses the File.browseForSave() method to let the user select a path for saving a file. When the files are selected, the code saves data to the selected file path.

    -
    import openfl.filesystem.*;
    +
    import openfl.filesystem.*;
     import openfl.events.Event;
     var docsDir:File = File.documentsDirectory;
     try
    @@ -404,7 +404,7 @@
     {
     	trace("Failed:", error.message);
     }
    -function saveData(event:Event):void
    +function saveData(event:Event):Void
     {
     	var newFile:File = event.target as File;
     	var str:String = "Hello.";
    @@ -423,13 +423,13 @@
     as Linux), when multiple files exist with names differing only in case, the canonicalize() method adjusts
     the path to match the first file found (in an order determined by the file system).

    The following code shows how to use the canonicalize() method to find the correct capitalization of a -directory name. Before running this example, create a directory named AIR Test on the desktop of your computer.

    -
    import openfl.filesystem.*;
    +directory name. Before running this example, create a directory named OpenFL Test on the desktop of your computer.

    +
    import openfl.filesystem.*;
     
    -var path:File = File.desktopDirectory.resolvePath("air test");
    +var path:File = File.desktopDirectory.resolvePath("openfl test");
     trace(path.nativePath);
     path.canonicalize();
    -trace(path.nativePath); // ...\AIR Test

    clone():File

    Returns a copy of this File object. Event registrations are not copied.

    +trace(path.nativePath); // ...\OpenFL Test

    clone():File

    Returns a copy of this File object. Event registrations are not copied.

    Note: This method does not copy the file itself. It simply makes a copy of the instance of the Haxe File object. To copy a file, use the copyTo() method.

    @:value({ overwrite : false })copyTo(newLocation:FileReference, overwrite:Bool = false):Void

    Copies the file or directory at the location specified by this File object to the location specified by the newLocation parameter. The copy process creates any required parent directories @@ -454,7 +454,7 @@

    The following code shows how to use the copyTo() method to copy a file. Before running this code, create a test1.txt file in the OpenFL Test subdirectory of the home directory on your computer. The resulting copied file is named test2.txt. The try and catch statements show how to respond to errors.

    -
    import openfl.filesystem.File;
    +
    import openfl.filesystem.File;
     var sourceFile:File = File.documentsDirectory;
     sourceFile = sourceFile.resolvePath("OpenFL Test/test1.txt");
     var destination:File = File.documentsDirectory;
    @@ -474,9 +474,9 @@
     exists. If true, the operation overwrites existing file or directory of the same name.

    Throws:

    SecurityError

    The application does not have the necessary permissions to write to the destination. The following code shows how to use the copyToAsync() method to copy a file. Before running this code, be sure to create a test1.txt file in the OpenFL Test subdirectory of the documents directory on your computer. -The resulting copied file is named test2.txt, and it is also in the AIR Test subdirectory. When you set the +The resulting copied file is named test2.txt, and it is also in the OpenFL Test subdirectory. When you set the overwrite parameter to true, the operation overwrites any existing test2.txt file.

    -
    import openfl.filesystem.File;
    +
    import openfl.filesystem.File;
     import openfl.events.Event;
     var sourceFile:File = File.documentsDirectory;
     sourceFile = sourceFile.resolvePath("OpenFL Test/test1.txt");
    @@ -484,7 +484,7 @@
     destination = destination.resolvePath("OpenFL Test/test2.txt");
     sourceFile.copyToAsync(destination, true);
     sourceFile.addEventListener(Event.COMPLETE, fileCopiedHandler);
    -function fileCopiedHandler(event:Event):void {
    +function fileCopiedHandler(event:Event):Void {
     	trace("Done.");
     }

    Events:

    complete

    Dispatched when the file or directory has been successfully copied.

    ioError

    The source does not exist; or the source could not be copied to the target; or the source and destination refer to the same file or folder and overwrite is set to true. On Windows, you cannot @@ -492,9 +492,9 @@ file that is open.

    createDirectory():Void

    Creates the specified directory and any necessary parent directories. If the directory already exists, no action is taken.

    Throws:

    IOError

    The directory did not exist and could not be created.

    SecurityError

    The application does not have the necessary permissions. The following code moves a file named test.txt on the desktop to the OpenFL Test subdirectory of the -documents directory. The call to the createDirectory() method ensures that the OpenFL Test directory +documents directory. The call to the createDirectory() method ensures that the OpenFL Test directory exists before the file is moved.

    -
    import openfl.filesystem.*;
    +
    import openfl.filesystem.*;
     var source:File = File.desktopDirectory.resolvePath("test.txt");
     var target:File = File.documentsDirectory.resolvePath("OpenFL Test/test.txt");
     var targetParent:File = target.parent;
    @@ -504,56 +504,48 @@
     an exception.

    Throws:

    IOError

    The directory does not exist, or the directory could not be deleted. On Windows, you cannot delete a directory that contains a file that is open.

    SecurityError

    The application does not have the necessary permissions to delete the directory. The following code creates an empty directory and then uses the deleteDirectory() method to delete the directory.

    -
    import openfl.filesystem.File;
    +
    import openfl.filesystem.File;
     var directory:File = File.documentsDirectory.resolvePath("Empty Junk Directory/");
     File.createDirectory(directory);
     trace(directory.exists); // true
     directory.deleteDirectory();
    -trace(directory.exists); // false

    @:value({ deleteDirectoryContents : false })deleteDirectoryAsync(deleteDirectoryContents:Bool = false):Void

    Deletes the directory asynchronously.

    -

    @events complete Dispatched when the directory has been deleted successfully. -@events ioError The directory does not exist or could not be deleted. On Windows, you cannot delete a -directory that contains a file that is open.

    Parameters:

    deleteDirectoryContents

    Specifies whether or not to delete a directory that contains files or +trace(directory.exists); // false

    @:value({ deleteDirectoryContents : false })deleteDirectoryAsync(deleteDirectoryContents:Bool = false):Void

    Deletes the directory asynchronously.

    Parameters:

    deleteDirectoryContents

    Specifies whether or not to delete a directory that contains files or subdirectories. When false, if the directory contains files or directories, a call to this method throws -an exception.

    Throws:

    SecurityError

    The application does not have the necessary permissions to delete the directory.

    deleteFile():Void

    Deletes the file.

    Throws:

    IOError

    The directory does not exist, or the directory could not be deleted. On Windows, you +an exception.

    Throws:

    SecurityError

    The application does not have the necessary permissions to delete the directory.

    Events:

    complete

    Dispatched when the directory has been deleted successfully.

    ioError

    The directory does not exist or could not be deleted. On Windows, you cannot delete a +directory that contains a file that is open.

    deleteFile():Void

    Deletes the file.

    Throws:

    IOError

    The directory does not exist, or the directory could not be deleted. On Windows, you cannot delete a directory that contains a file that is open.

    SecurityError

    The application does not have the necessary permissions to delete the directory. The following code creates a temporary file and then calls the deleteFile() method to delete it.

    -
    import openfl.filesystem.*;
    +
    import openfl.filesystem.*;
     var file:File = File.createTempFile();
     trace(file.exists); // true
     file.deleteFile();
    -trace(file.exists); // false

    deleteFileAsync():Void

    Deletes the file asynchronously.

    -

    @events complete Dispatched when the directory has been deleted successfully. -@events ioError The directory does not exist or could not be deleted. On Windows, you cannot delete a -directory that contains a file that is open.

    Throws:

    SecurityError

    The application does not have the necessary permissions to delete the directory.

    getDirectoryListing():Array<File>

    Returns an array of File objects corresponding to files and directories in the directory +trace(file.exists); // false

    deleteFileAsync():Void

    Deletes the file asynchronously.

    Throws:

    SecurityError

    The application does not have the necessary permissions to delete the directory.

    Events:

    complete

    Dispatched when the directory has been deleted successfully.

    ioError

    The directory does not exist or could not be deleted. On Windows, you cannot delete a +directory that contains a file that is open.

    getDirectoryListing():Array<File>

    Returns an array of File objects corresponding to files and directories in the directory represented by this File object. This method does not explore the contents of subdirectories.

    Returns:

    Array An array of File objects. The following code shows how to use the getDirectoryListing() method to enumerate the contents of the user directory.

    -
    import openfl.filesystem.File;
    +
    import openfl.filesystem.File;
     var directory:File = File.userDirectory;
     var list:Array = directory.getDirectoryListing();
    -for (var i:uint = 0; i < list.length; i++) {
    +for (i in 0...list.length) {
     	trace(list[i].nativePath);
     }

    getDirectoryListingAsync():Void

    Asynchronously retrieves an array of File objects corresponding to the contents of the -directory represented by this File object.

    -

    @events ioError You do not have adequate permissions to read this directory, or the directory does -not exist. -@events directoryListing The directory contents have been enumerated successfully. The contents -event includes a files property, which is the resulting array of File objects.

    -

    The following code shows how to use the getDirectoryListingAsync() method to enumerate the contents +directory represented by this File object.

    Events:

    ioError

    You do not have adequate permissions to read this directory, or the directory does +not exist.

    directoryListing

    The directory contents have been enumerated successfully. The contents +event includes a files property, which is the resulting array of File objects. +The following code shows how to use the getDirectoryListingAsync() method to enumerate the contents of the user directory.

    -
    import openfl.filesystem.File;
    +
    import openfl.filesystem.File;
     import openfl.events.FileListEvent;
    -
     var directory:File = File.userDirectory;
     directory.getDirectoryListingAsync();
     directory.addEventListener(FileListEvent.DIRECTORY_LISTING, directoryListingHandler);
    -
    -function directoryListingHandler(event:FileListEvent):void {
    +function directoryListingHandler(event:FileListEvent):Void {
     	var list:Array = event.files;
    -	for (var i:uint = 0; i < list.length; i++) {
    +	for (i in 0...list.length) {
     		trace(list[i].nativePath);
     	}
    -}

    @:value({ useDotDot : false })getRelativePath(ref:FileReference, useDotDot:Bool = false):String

    Finds the relative path between two File paths.

    +}

    @:value({ useDotDot : false })getRelativePath(ref:FileReference, useDotDot:Bool = false):String

    Finds the relative path between two File paths.

    The relative path is the list of components that can be appended to (resolved against) this reference in order to locate the second (parameter) reference. The relative path is returned using the "/" separator character.

    @@ -575,7 +567,7 @@ code, create a test1.txt file in the OpenFL Test subdirectory of the documents directory on your computer. When you set the overwrite parameter to true, the operation overwrites any existing test2.txt file.

    -
    import openfl.filesystem.File;
    +
    import openfl.filesystem.File;
     import openfl.events.Event;
     var sourceFile:File = File.documentsDirectory;
     sourceFile = sourceFile.resolvePath("OpenFL Test/test1.txt");
    @@ -597,19 +589,19 @@
     operation overwrites any existing file or directory of the same name.

    Throws:

    SecurityError

    The application does not have the necessary permissions to move the file. The following code shows how to use the moveToAsync() method to rename a file. The original filename is test1.txt and the resulting name is test2.txt. Since both the source and destination File object -point to the same directory (the Apollo Test subdirectory of the user's documents directory), the +point to the same directory (the OpenFL Test subdirectory of the user's documents directory), the moveToAsync() method renames the file, rather than moving it to a new directory. Before running this -code, create a test1.txt file in the Apollo Test subdirectory of the documents directory on your +code, create a test1.txt file in the OpenFL Test subdirectory of the documents directory on your computer. When you set overwrite parameter to true, the operation overwrites any existing test2.txt file.

    -
    import openfl.filesystem.File;
    +
    import openfl.filesystem.File;
     import openfl.events.Event;
     var sourceFile:File = File.documentsDirectory;
    -sourceFile = sourceFile.resolvePath("Apollo Test/test1.txt");
    +sourceFile = sourceFile.resolvePath("OpenFL Test/test1.txt");
     var destination:File = File.documentsDirectory;
    -destination = destination.resolvePath("Apollo Test/test2.txt");
    +destination = destination.resolvePath("OpenFL Test/test2.txt");
     sourceFile.moveToAsync(destination, true);
     sourceFile.addEventListener(Event.COMPLETE, fileMoveCompleteHandler);
    -function fileMoveCompleteHandler(event:Event):void
    +function fileMoveCompleteHandler(event:Event):Void
     {
     	trace("Done.")
     }
    @@ -1318,4 +1310,4 @@
     event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/filesystem/FileMode.html b/openfl/filesystem/FileMode.html index de8c335..5cfd24b 100644 --- a/openfl/filesystem/FileMode.html +++ b/openfl/filesystem/FileMode.html @@ -54,4 +54,4 @@ }

    Variables

    @:value(cast "append")@:impl@:enuminlineread onlyAPPEND:String = cast "append"

    Used for a file to be opened in write mode, with all written data appended to the end of the file. Upon opening, any nonexistent file is created. .

    @:value(cast "read")@:impl@:enuminlineread onlyREAD:String = cast "read"

    Used for a file to be opened in read-only mode. The file must exist (missing files are not created).

    @:value(cast "update")@:impl@:enuminlineread onlyUPDATE:String = cast "update"

    Used for a file to be opened in read/write mode. Upon opening, any nonexistent file is created.

    @:value(cast "write")@:impl@:enuminlineread onlyWRITE:String = cast "write"

    Used for a file to be opened in write-only mode. Upon opening, any nonexistent file is created, and -any existing file is truncated (its data is deleted).

    \ No newline at end of file +any existing file is truncated (its data is deleted).

    \ No newline at end of file diff --git a/openfl/filesystem/FileStream.html b/openfl/filesystem/FileStream.html index 298be65..aa45866 100644 --- a/openfl/filesystem/FileStream.html +++ b/openfl/filesystem/FileStream.html @@ -406,4 +406,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/filesystem/index.html b/openfl/filesystem/index.html index 8d3dcf8..75a0bc7 100644 --- a/openfl/filesystem/index.html +++ b/openfl/filesystem/index.html @@ -88,4 +88,4 @@

    package ::full::

    ..
    File

    A File object represents a path to a file or directory. This can be an existing file or directory, or it can be one that does not yet exist; for instance, it can represent the path to a file or directory that you plan to create.

    FileMode

    FileStream

    A FileStream object is used to read and write files. Files can be opened synchronously -by calling the open() method or asynchronously by calling the openAsync() method.

    \ No newline at end of file +by calling the open() method or asynchronously by calling the openAsync() method.

    \ No newline at end of file diff --git a/openfl/filters/BitmapFilter.html b/openfl/filters/BitmapFilter.html index 03d8d9d..3ab227a 100644 --- a/openfl/filters/BitmapFilter.html +++ b/openfl/filters/BitmapFilter.html @@ -58,4 +58,4 @@ and GradientGlowFilter classes all extend the BitmapFilter class. You can apply these filter effects to any display object.

    You can neither directly instantiate nor extend BitmapFilter.

    Constructor

    new()

    Methods

    clone():BitmapFilter

    Returns a BitmapFilter object that is an exact copy of the original -BitmapFilter object.

    Returns:

    A BitmapFilter object.

    \ No newline at end of file +BitmapFilter object.

    Returns:

    A BitmapFilter object.

    \ No newline at end of file diff --git a/openfl/filters/BitmapFilterQuality.html b/openfl/filters/BitmapFilterQuality.html index 7608ba1..9c47fd0 100644 --- a/openfl/filters/BitmapFilterQuality.html +++ b/openfl/filters/BitmapFilterQuality.html @@ -54,4 +54,4 @@ margin: 5px 0 0 4px; }

    The BitmapFilterQuality class contains values to set the rendering quality -of a BitmapFilter object.

    Variables

    @:value(cast 3)@:impl@:enuminlineread onlyHIGH:BitmapFilterQuality = 3

    Defines the high quality filter setting.

    @:value(cast 1)@:impl@:enuminlineread onlyLOW:BitmapFilterQuality = 1

    Defines the low quality filter setting.

    @:value(cast 2)@:impl@:enuminlineread onlyMEDIUM:BitmapFilterQuality = 2

    Defines the medium quality filter setting.

    \ No newline at end of file +of a BitmapFilter object.

    Variables

    @:value(cast 3)@:impl@:enuminlineread onlyHIGH:BitmapFilterQuality = 3

    Defines the high quality filter setting.

    @:value(cast 1)@:impl@:enuminlineread onlyLOW:BitmapFilterQuality = 1

    Defines the low quality filter setting.

    @:value(cast 2)@:impl@:enuminlineread onlyMEDIUM:BitmapFilterQuality = 2

    Defines the medium quality filter setting.

    \ No newline at end of file diff --git a/openfl/filters/BitmapFilterShader.html b/openfl/filters/BitmapFilterShader.html index 6045695..a359717 100644 --- a/openfl/filters/BitmapFilterShader.html +++ b/openfl/filters/BitmapFilterShader.html @@ -81,4 +81,4 @@

    The precision mode selection affects the following shader operations. These operations are faster on an Intel processor with the SSE instruction set:

    • sin(x)
    • cos(x)
    • tan(x)
    • asin(x)
    • acos(x)
    • atan(x)
    • atan(x, y)
    • exp(x)
    • exp2(x)
    • log(x)
    • log2(x)
    • pow(x, y)
    • reciprocal(x)
    • sqrt(x)

    program:Program3D

    The compiled Program3D if available.

    -

    This property is not available on the Flash target.

    Inherited Methods

    \ No newline at end of file +

    This property is not available on the Flash target.

    Inherited Methods

    \ No newline at end of file diff --git a/openfl/filters/BitmapFilterType.html b/openfl/filters/BitmapFilterType.html index 7b23229..3340e7c 100644 --- a/openfl/filters/BitmapFilterType.html +++ b/openfl/filters/BitmapFilterType.html @@ -54,4 +54,4 @@ margin: 5px 0 0 4px; }

    The BitmapFilterType class contains values to set the type of a -BitmapFilter.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyFULL:BitmapFilterType = 0

    Defines the setting that applies a filter to the entire area of an object.

    @:value(cast 1)@:impl@:enuminlineread onlyINNER:BitmapFilterType = 1

    Defines the setting that applies a filter to the inner area of an object.

    @:value(cast 2)@:impl@:enuminlineread onlyOUTER:BitmapFilterType = 2

    Defines the setting that applies a filter to the outer area of an object.

    \ No newline at end of file +BitmapFilter.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyFULL:BitmapFilterType = 0

    Defines the setting that applies a filter to the entire area of an object.

    @:value(cast 1)@:impl@:enuminlineread onlyINNER:BitmapFilterType = 1

    Defines the setting that applies a filter to the inner area of an object.

    @:value(cast 2)@:impl@:enuminlineread onlyOUTER:BitmapFilterType = 2

    Defines the setting that applies a filter to the outer area of an object.

    \ No newline at end of file diff --git a/openfl/filters/BlurFilter.html b/openfl/filters/BlurFilter.html index 2ae5253..6b4f13c 100644 --- a/openfl/filters/BlurFilter.html +++ b/openfl/filters/BlurFilter.html @@ -132,4 +132,4 @@ rendering, by simply increasing the values of the blurX and blurY properties.

    You can use the following BitmapFilterQuality constants to specify -values of the quality property:

    Methods

    Inherited Variables

    Inherited Methods

    \ No newline at end of file +values of the quality property:

    Methods

    Inherited Variables

    Inherited Methods

    \ No newline at end of file diff --git a/openfl/filters/ColorMatrixFilter.html b/openfl/filters/ColorMatrixFilter.html index cdedcac..2cf13a1 100644 --- a/openfl/filters/ColorMatrixFilter.html +++ b/openfl/filters/ColorMatrixFilter.html @@ -130,4 +130,4 @@ Pentium® 3 and later and Apple® G4 and later. The accelerator is used when the multiplier terms are in the range -15.99 to 15.99 and the adder terms a[4], a[9], a[14], and a[19] are -in the range -8000 to 8000.

    Throws:

    TypeError

    The Array is null when being set

    Methods

    Inherited Variables

    Inherited Methods

    \ No newline at end of file +in the range -8000 to 8000.

    Throws:

    TypeError

    The Array is null when being set

    Methods

    Inherited Variables

    Inherited Methods

    \ No newline at end of file diff --git a/openfl/filters/ConvolutionFilter.html b/openfl/filters/ConvolutionFilter.html index b4e756a..e2c87af 100644 --- a/openfl/filters/ConvolutionFilter.html +++ b/openfl/filters/ConvolutionFilter.html @@ -159,4 +159,4 @@ as the color channels. A value of false indicates that the convolution applies to all channels, including the alpha channel. A value of true indicates that the convolution applies only to the -color channels. The default value is true.

    Methods

    Inherited Variables

    Inherited Methods

    \ No newline at end of file +color channels. The default value is true.

    Methods

    Inherited Variables

    Inherited Methods

    \ No newline at end of file diff --git a/openfl/filters/DisplacementMapFilter.html b/openfl/filters/DisplacementMapFilter.html index 33f0c81..e4205af 100644 --- a/openfl/filters/DisplacementMapFilter.html +++ b/openfl/filters/DisplacementMapFilter.html @@ -122,14 +122,14 @@ BitmapDataChannel.RED

    mapBitmap:BitmapData

    A BitmapData object containing the displacement map data.

    Throws:

    TypeError

    The BitmapData is null when being set

    mapPoint:Point

    A value that contains the offset of the upper-left corner of the target display object from the upper-left corner of the map image.

    Throws:

    TypeError

    The Point is null when being set

    mode:DisplacementMapFilterMode

    The mode for the filter. Possible values are DisplacementMapFilterMode constants: - DisplacementMapFilterMode.WRAP � Wraps the displacement value to + DisplacementMapFilterMode.WRAP — Wraps the displacement value to the other side of the source image. - DisplacementMapFilterMode.CLAMP � Clamps the displacement value + DisplacementMapFilterMode.CLAMP — Clamps the displacement value to the edge of the source image. - DisplacementMapFilterMode.IGNORE � If the displacement value is + DisplacementMapFilterMode.IGNORE — If the displacement value is out of range, ignores the displacement and uses the source pixel. - DisplacementMapFilterMode.COLOR � If the displacement value is + DisplacementMapFilterMode.COLOR — If the displacement value is outside the image, substitutes the values in the color and alpha properties.

    Throws:

    ArgumentError

    The mode string is not one of the valid types

    TypeError

    The String is null when being set

    scaleX:Float

    The multiplier to use to scale the x displacement result from the map calculation.

    scaleY:Float

    The multiplier to use to scale the y displacement result from the -map calculation.

    Methods

    Inherited Variables

    Inherited Methods

    \ No newline at end of file +map calculation.

    Methods

    Inherited Variables

    Inherited Methods

    \ No newline at end of file diff --git a/openfl/filters/DisplacementMapFilterMode.html b/openfl/filters/DisplacementMapFilterMode.html index 96b7648..757b3cc 100644 --- a/openfl/filters/DisplacementMapFilterMode.html +++ b/openfl/filters/DisplacementMapFilterMode.html @@ -56,4 +56,4 @@

    The DisplacementMapFilterMode class provides values for the mode property of the DisplacementMapFilter class.

    Variables

    @:value(cast "clamp")@:impl@:enuminlineread onlyCLAMP:DisplacementMapFilterMode = "clamp"

    Clamps the displacement value to the edge of the source image.

    @:value(cast "color")@:impl@:enuminlineread onlyCOLOR:DisplacementMapFilterMode = "color"

    If the displacement value is outside the image, substitutes the values in the color and alpha properties.

    @:value(cast "ignore")@:impl@:enuminlineread onlyIGNORE:DisplacementMapFilterMode = "ignore"

    If the displacement value is out of range, ignores the displacement and -uses the source pixel.

    @:value(cast "wrap")@:impl@:enuminlineread onlyWRAP:DisplacementMapFilterMode = "wrap"

    Wraps the displacement value to the other side of the source image.

    \ No newline at end of file +uses the source pixel.

    @:value(cast "wrap")@:impl@:enuminlineread onlyWRAP:DisplacementMapFilterMode = "wrap"

    Wraps the displacement value to the other side of the source image.

    \ No newline at end of file diff --git a/openfl/filters/DropShadowFilter.html b/openfl/filters/DropShadowFilter.html index e7c1fb7..73f7d4c 100644 --- a/openfl/filters/DropShadowFilter.html +++ b/openfl/filters/DropShadowFilter.html @@ -136,4 +136,4 @@ similar effect, and with faster rendering, by simply increasing the values of the blurX and blurY properties.

    strength:Float

    The strength of the imprint or spread. The higher the value, the more color is imprinted and the stronger the contrast between the shadow and -the background. Valid values are from 0 to 255.0. The default is 1.0.

    Methods

    Inherited Variables

    Inherited Methods

    \ No newline at end of file +the background. Valid values are from 0 to 255.0. The default is 1.0.

    Methods

    Inherited Variables

    Inherited Methods

    \ No newline at end of file diff --git a/openfl/filters/GlowFilter.html b/openfl/filters/GlowFilter.html index 878fdf6..3db7096 100644 --- a/openfl/filters/GlowFilter.html +++ b/openfl/filters/GlowFilter.html @@ -139,4 +139,4 @@ a similar effect, and with faster rendering, by simply increasing the values of the blurX and blurY properties.

    strength:Float

    The strength of the imprint or spread. The higher the value, the more color is imprinted and the stronger the contrast between the glow and the -background. Valid values are 0 to 255. The default is 2.

    Methods

    Inherited Variables

    Inherited Methods

    \ No newline at end of file +background. Valid values are 0 to 255. The default is 2.

    Methods

    Inherited Variables

    Inherited Methods

    \ No newline at end of file diff --git a/openfl/filters/ShaderFilter.html b/openfl/filters/ShaderFilter.html index 00caaf0..7a4ca14 100644 --- a/openfl/filters/ShaderFilter.html +++ b/openfl/filters/ShaderFilter.html @@ -127,4 +127,4 @@ passed to the shader during execution. At execution time Flash Player or AIR computes the normal bounds of a movie clip and extends the bounds based on the leftExtension, rightExtension, topExtension, -and bottomExtension values.

    Methods

    invalidate():Void

    Inherited Variables

    Inherited Methods

    \ No newline at end of file +and bottomExtension values.

    Methods

    invalidate():Void

    Inherited Variables

    Inherited Methods

    \ No newline at end of file diff --git a/openfl/filters/index.html b/openfl/filters/index.html index a103815..c9caf22 100644 --- a/openfl/filters/index.html +++ b/openfl/filters/index.html @@ -138,4 +138,4 @@

    package ::full::

    object being filtered. The filtered object is used as an input to the shader, and the shader output becomes the filter result. To create a new filter, use the constructor new ShaderFilter(). The use -of filters depends on the object to which you apply the filter:

    \ No newline at end of file +of filters depends on the object to which you apply the filter:

    \ No newline at end of file diff --git a/openfl/geom/ColorTransform.html b/openfl/geom/ColorTransform.html index c3f7f69..1c33774 100644 --- a/openfl/geom/ColorTransform.html +++ b/openfl/geom/ColorTransform.html @@ -112,4 +112,4 @@ transformation after the original color transformation.

    Parameters:

    second

    The ColorTransform object to be combined with the current ColorTransform object.

    toString():String

    Formats and returns a string that describes all of the properties of the ColorTransform object.

    Returns:

    A string that lists all of the properties of the -ColorTransform object.

    \ No newline at end of file +ColorTransform object.

    \ No newline at end of file diff --git a/openfl/geom/Matrix.html b/openfl/geom/Matrix.html index 77a51b5..22d2707 100644 --- a/openfl/geom/Matrix.html +++ b/openfl/geom/Matrix.html @@ -188,4 +188,4 @@ the Matrix object to the specified point.

    Parameters:

    point

    The point for which you want to get the result of the Matrix transformation.

    Returns:

    The point resulting from applying the Matrix transformation.

    translate(dx:Float, dy:Float):Void

    Translates the matrix along the x and y axes, as specified by the dx and dy parameters.

    Parameters:

    dx

    The amount of movement along the x axis to the right, in -pixels.

    dy

    The amount of movement down along the y axis, in pixels.

    \ No newline at end of file +pixels.

    dy

    The amount of movement down along the y axis, in pixels.

    \ No newline at end of file diff --git a/openfl/geom/Matrix3D.html b/openfl/geom/Matrix3D.html index 51670a9..2b3eea8 100644 --- a/openfl/geom/Matrix3D.html +++ b/openfl/geom/Matrix3D.html @@ -459,4 +459,4 @@ If you want to transpose a matrix without altering the current matrix, first copy the current matrix by using the clone() method and then apply the transpose() method to the copy.

    -

    An orthogonal matrix is a square matrix whose transpose is equal to its inverse.

    \ No newline at end of file +

    An orthogonal matrix is a square matrix whose transpose is equal to its inverse.

    \ No newline at end of file diff --git a/openfl/geom/Orientation3D.html b/openfl/geom/Orientation3D.html index 376b74f..b84634a 100644 --- a/openfl/geom/Orientation3D.html +++ b/openfl/geom/Orientation3D.html @@ -87,4 +87,4 @@ smooth, gimbal-lock-free rotation. A gimbal lock can occur when during the rotation around two or more axes the axes are aligned, leading to unexpected results.

    -

    The Matrix3D interpolate() method uses quaternion.

    \ No newline at end of file +

    The Matrix3D interpolate() method uses quaternion.

    \ No newline at end of file diff --git a/openfl/geom/PerspectiveProjection.html b/openfl/geom/PerspectiveProjection.html index ff5a230..47da51c 100644 --- a/openfl/geom/PerspectiveProjection.html +++ b/openfl/geom/PerspectiveProjection.html @@ -102,4 +102,4 @@ property defined for its transformations. In fact, use either a PerspectiveProjection or a Matrix3D object to specify the perspective transformation. If when using the PerspectiveProjection object, a Matrix3D object was needed, the toMatrix3D() method can retrieve the underlying Matrix3D object of the display object. -For example, the toMatrix3D() method can be used with the Utils3D.projectVectors() method.

    Returns:

    The underlying Matrix3D object.

    \ No newline at end of file +For example, the toMatrix3D() method can be used with the Utils3D.projectVectors() method.

    Returns:

    The underlying Matrix3D object.

    \ No newline at end of file diff --git a/openfl/geom/Point.html b/openfl/geom/Point.html index d82c5a7..851e349 100644 --- a/openfl/geom/Point.html +++ b/openfl/geom/Point.html @@ -87,4 +87,4 @@ point to create a new point.

    Parameters:

    v

    The point to be subtracted.

    Returns:

    The new point.

    toString():String

    Returns a string that contains the values of the x and y coordinates. The string has the form "(x=_x_, y=_y_)", so calling the toString() method for a -point at 23,17 would return "(x=23, y=17)".

    Returns:

    The string representation of the coordinates.

    \ No newline at end of file +point at 23,17 would return "(x=23, y=17)".

    Returns:

    The string representation of the coordinates.

    \ No newline at end of file diff --git a/openfl/geom/Rectangle.html b/openfl/geom/Rectangle.html index 83c2929..9ab1545 100644 --- a/openfl/geom/Rectangle.html +++ b/openfl/geom/Rectangle.html @@ -153,11 +153,11 @@ the top and the bottom by the dy value.

    Parameters:

    dx

    The value to be added to the left and the right of the Rectangle object. The following equation is used to calculate the new width and position of the rectangle:

    -
    x -= dx;
    +
    x -= dx;
     width += 2 * dx;
    dy

    The value to be added to the top and the bottom of the Rectangle. The following equation is used to calculate the new height and position of the rectangle:

    -
    y -= dy;
    +
    y -= dy;
     height += 2 * dy;

    inflatePoint(point:Point):Void

    Increases the size of the Rectangle object. This method is similar to the Rectangle.inflate() method except it takes a Point object as a parameter. @@ -197,4 +197,4 @@

    The resulting union rectangle.

    Note: The union() method ignores rectangles with 0 as the height or width value, such as: var rect2:Rectangle = new Rectangle(300,300,50,0);

    Parameters:

    toUnion

    A Rectangle object to add to this Rectangle object.

    Returns:

    A new Rectangle object that is the union of the two -rectangles.

    \ No newline at end of file +rectangles.

    \ No newline at end of file diff --git a/openfl/geom/Transform.html b/openfl/geom/Transform.html index 98bd40f..d877b8c 100644 --- a/openfl/geom/Transform.html +++ b/openfl/geom/Transform.html @@ -135,4 +135,4 @@ null. And if the matrix3D property is set to a value(not null), the matrix property is null.

    read onlypixelBounds:Rectangle

    A Rectangle object that defines the bounding rectangle of the display -object on the stage.

    \ No newline at end of file +object on the stage.

    \ No newline at end of file diff --git a/openfl/geom/Utils3D.html b/openfl/geom/Utils3D.html index 321b4c1..6ee4b0a 100644 --- a/openfl/geom/Utils3D.html +++ b/openfl/geom/Utils3D.html @@ -86,4 +86,4 @@ projected point. The t value is the projection depth value, the distance from the eye to the Vector3D object in the view or eye space. You should pre-allocate the Vector and specify the u and v values. The projectVectors method fills the t -value for each projected point.

    \ No newline at end of file +value for each projected point.

    \ No newline at end of file diff --git a/openfl/geom/Vector3D.html b/openfl/geom/Vector3D.html index 0a09cb0..7626ed1 100644 --- a/openfl/geom/Vector3D.html +++ b/openfl/geom/Vector3D.html @@ -189,4 +189,4 @@ subtract() method does not change the current Vector3D object. Instead, this method returns a new Vector3D object with the new values.

    Parameters:

    a

    The Vector3D object to be subtracted from the current Vector3D object.

    Returns:

    A new Vector3D object that is the difference between the current Vector3D and the specified Vector3D object.

    toString():String

    Returns a string representation of the current Vector3D object. The string contains -the values of the x, y, and z properties.

    Returns:

    A string containing the values of the x, y, and z properties.

    \ No newline at end of file +the values of the x, y, and z properties.

    Returns:

    A string containing the values of the x, y, and z properties.

    \ No newline at end of file diff --git a/openfl/geom/index.html b/openfl/geom/index.html index 28a5bdf..2e278c9 100644 --- a/openfl/geom/index.html +++ b/openfl/geom/index.html @@ -133,4 +133,4 @@

    package ::full::

    right-handed three-dimensional coordinate system, the positive z-axis points away from the viewer and the value of the z property increases as the object moves away from the viewer's eye. The origin point (0,0,0) of the global space is the upper-left corner of -the stage.

    \ No newline at end of file +the stage.

    \ No newline at end of file diff --git a/openfl/globalization/DateTimeFormatter.html b/openfl/globalization/DateTimeFormatter.html index f998b61..20f1b4c 100644 --- a/openfl/globalization/DateTimeFormatter.html +++ b/openfl/globalization/DateTimeFormatter.html @@ -52,4 +52,4 @@ .navbar .container img { margin: 5px 0 0 4px; } -

    Static methods

    Constructor

    @:value({ timeStyle : LONG, dateStyle : LONG })new(requestedLocaleIDName:String, dateStyle:DateTimeStyle = LONG, timeStyle:DateTimeStyle = LONG)

    Variables

    Methods

    format(date:Date):String

    formatUTC(date:Date):String

    @:value({ context : STANDALONE, nameStyle : FULL })getMonthNames(nameStyle:DateTimeNameStyle = FULL, context:DateTimeNameContext = STANDALONE):Vector<String>

    @:value({ context : STANDALONE, nameStyle : FULL })getWeekdayNames(nameStyle:DateTimeNameStyle = FULL, context:DateTimeNameContext = STANDALONE):Vector<String>

    setDateTimePattern(pattern:String):Void

    @:value({ timeStyle : LONG, dateStyle : LONG })setDateTimeStyles(dateStyle:DateTimeStyle = LONG, timeStyle:DateTimeStyle = LONG):Void

    \ No newline at end of file +

    Static methods

    Constructor

    @:value({ timeStyle : LONG, dateStyle : LONG })new(requestedLocaleIDName:String, dateStyle:DateTimeStyle = LONG, timeStyle:DateTimeStyle = LONG)

    Variables

    Methods

    format(date:Date):String

    formatUTC(date:Date):String

    @:value({ context : STANDALONE, nameStyle : FULL })getMonthNames(nameStyle:DateTimeNameStyle = FULL, context:DateTimeNameContext = STANDALONE):Vector<String>

    @:value({ context : STANDALONE, nameStyle : FULL })getWeekdayNames(nameStyle:DateTimeNameStyle = FULL, context:DateTimeNameContext = STANDALONE):Vector<String>

    setDateTimePattern(pattern:String):Void

    @:value({ timeStyle : LONG, dateStyle : LONG })setDateTimeStyles(dateStyle:DateTimeStyle = LONG, timeStyle:DateTimeStyle = LONG):Void

    \ No newline at end of file diff --git a/openfl/globalization/DateTimeNameContext.html b/openfl/globalization/DateTimeNameContext.html index 8a5c339..e90902d 100644 --- a/openfl/globalization/DateTimeNameContext.html +++ b/openfl/globalization/DateTimeNameContext.html @@ -52,4 +52,4 @@ .navbar .container img { margin: 5px 0 0 4px; } -

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyFORMAT:DateTimeNameContext = 0

    @:value(cast 1)@:impl@:enuminlineread onlySTANDALONE:DateTimeNameContext = 1

    \ No newline at end of file +

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyFORMAT:DateTimeNameContext = 0

    @:value(cast 1)@:impl@:enuminlineread onlySTANDALONE:DateTimeNameContext = 1

    \ No newline at end of file diff --git a/openfl/globalization/DateTimeNameStyle.html b/openfl/globalization/DateTimeNameStyle.html index f32b683..326a9cf 100644 --- a/openfl/globalization/DateTimeNameStyle.html +++ b/openfl/globalization/DateTimeNameStyle.html @@ -52,4 +52,4 @@ .navbar .container img { margin: 5px 0 0 4px; } -

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyFULL:DateTimeNameStyle = 0

    @:value(cast 1)@:impl@:enuminlineread onlyLONG_ABBREVIATION:DateTimeNameStyle = 1

    @:value(cast 2)@:impl@:enuminlineread onlySHORT_ABBREVIATION:DateTimeNameStyle = 2

    \ No newline at end of file +

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyFULL:DateTimeNameStyle = 0

    @:value(cast 1)@:impl@:enuminlineread onlyLONG_ABBREVIATION:DateTimeNameStyle = 1

    @:value(cast 2)@:impl@:enuminlineread onlySHORT_ABBREVIATION:DateTimeNameStyle = 2

    \ No newline at end of file diff --git a/openfl/globalization/DateTimeStyle.html b/openfl/globalization/DateTimeStyle.html index d58278c..7d2b36f 100644 --- a/openfl/globalization/DateTimeStyle.html +++ b/openfl/globalization/DateTimeStyle.html @@ -52,4 +52,4 @@ .navbar .container img { margin: 5px 0 0 4px; } -

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyCUSTOM:DateTimeStyle = 0

    @:value(cast 1)@:impl@:enuminlineread onlyLONG:DateTimeStyle = 1

    @:value(cast 2)@:impl@:enuminlineread onlyMEDIUM:DateTimeStyle = 2

    @:value(cast 3)@:impl@:enuminlineread onlyNONE:DateTimeStyle = 3

    @:value(cast 4)@:impl@:enuminlineread onlySHORT:DateTimeStyle = 4

    \ No newline at end of file +

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyCUSTOM:DateTimeStyle = 0

    @:value(cast 1)@:impl@:enuminlineread onlyLONG:DateTimeStyle = 1

    @:value(cast 2)@:impl@:enuminlineread onlyMEDIUM:DateTimeStyle = 2

    @:value(cast 3)@:impl@:enuminlineread onlyNONE:DateTimeStyle = 3

    @:value(cast 4)@:impl@:enuminlineread onlySHORT:DateTimeStyle = 4

    \ No newline at end of file diff --git a/openfl/globalization/LastOperationStatus.html b/openfl/globalization/LastOperationStatus.html index e31d663..fcac9ff 100644 --- a/openfl/globalization/LastOperationStatus.html +++ b/openfl/globalization/LastOperationStatus.html @@ -52,4 +52,4 @@ .navbar .container img { margin: 5px 0 0 4px; } -

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyBUFFER_OVERFLOW_ERROR:LastOperationStatus = 0

    @:value(cast 1)@:impl@:enuminlineread onlyERROR_CODE_UNKNOWN:LastOperationStatus = 1

    @:value(cast 2)@:impl@:enuminlineread onlyILLEGAL_ARGUMENT_ERROR:LastOperationStatus = 2

    @:value(cast 3)@:impl@:enuminlineread onlyINDEX_OUT_OF_BOUNDS_ERROR:LastOperationStatus = 3

    @:value(cast 4)@:impl@:enuminlineread onlyINVALID_ATTR_VALUE:LastOperationStatus = 4

    @:value(cast 5)@:impl@:enuminlineread onlyINVALID_CHAR_FOUND:LastOperationStatus = 5

    @:value(cast 6)@:impl@:enuminlineread onlyMEMORY_ALLOCATION_ERROR:LastOperationStatus = 6

    @:value(cast 7)@:impl@:enuminlineread onlyNO_ERROR:LastOperationStatus = 7

    @:value(cast 8)@:impl@:enuminlineread onlyNUMBER_OVERFLOW_ERROR:LastOperationStatus = 8

    @:value(cast 9)@:impl@:enuminlineread onlyPARSE_ERROR:LastOperationStatus = 9

    @:value(cast 10)@:impl@:enuminlineread onlyPATTERN_SYNTAX_ERROR:LastOperationStatus = 10

    @:value(cast 11)@:impl@:enuminlineread onlyPLATFORM_API_FAILED:LastOperationStatus = 11

    @:value(cast 12)@:impl@:enuminlineread onlyTRUNCATED_CHAR_FOUND:LastOperationStatus = 12

    @:value(cast 13)@:impl@:enuminlineread onlyUNEXPECTED_TOKEN:LastOperationStatus = 13

    @:value(cast 14)@:impl@:enuminlineread onlyUNSUPPORTED_ERROR:LastOperationStatus = 14

    @:value(cast 15)@:impl@:enuminlineread onlyUSING_DEFAULT_WARNING:LastOperationStatus = 15

    @:value(cast 16)@:impl@:enuminlineread onlyUSING_FALLBACK_WARNING:LastOperationStatus = 16

    \ No newline at end of file +

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyBUFFER_OVERFLOW_ERROR:LastOperationStatus = 0

    @:value(cast 1)@:impl@:enuminlineread onlyERROR_CODE_UNKNOWN:LastOperationStatus = 1

    @:value(cast 2)@:impl@:enuminlineread onlyILLEGAL_ARGUMENT_ERROR:LastOperationStatus = 2

    @:value(cast 3)@:impl@:enuminlineread onlyINDEX_OUT_OF_BOUNDS_ERROR:LastOperationStatus = 3

    @:value(cast 4)@:impl@:enuminlineread onlyINVALID_ATTR_VALUE:LastOperationStatus = 4

    @:value(cast 5)@:impl@:enuminlineread onlyINVALID_CHAR_FOUND:LastOperationStatus = 5

    @:value(cast 6)@:impl@:enuminlineread onlyMEMORY_ALLOCATION_ERROR:LastOperationStatus = 6

    @:value(cast 7)@:impl@:enuminlineread onlyNO_ERROR:LastOperationStatus = 7

    @:value(cast 8)@:impl@:enuminlineread onlyNUMBER_OVERFLOW_ERROR:LastOperationStatus = 8

    @:value(cast 9)@:impl@:enuminlineread onlyPARSE_ERROR:LastOperationStatus = 9

    @:value(cast 10)@:impl@:enuminlineread onlyPATTERN_SYNTAX_ERROR:LastOperationStatus = 10

    @:value(cast 11)@:impl@:enuminlineread onlyPLATFORM_API_FAILED:LastOperationStatus = 11

    @:value(cast 12)@:impl@:enuminlineread onlyTRUNCATED_CHAR_FOUND:LastOperationStatus = 12

    @:value(cast 13)@:impl@:enuminlineread onlyUNEXPECTED_TOKEN:LastOperationStatus = 13

    @:value(cast 14)@:impl@:enuminlineread onlyUNSUPPORTED_ERROR:LastOperationStatus = 14

    @:value(cast 15)@:impl@:enuminlineread onlyUSING_DEFAULT_WARNING:LastOperationStatus = 15

    @:value(cast 16)@:impl@:enuminlineread onlyUSING_FALLBACK_WARNING:LastOperationStatus = 16

    \ No newline at end of file diff --git a/openfl/globalization/LocaleID.html b/openfl/globalization/LocaleID.html index d6b0d5e..2b7c657 100644 --- a/openfl/globalization/LocaleID.html +++ b/openfl/globalization/LocaleID.html @@ -52,4 +52,4 @@ .navbar .container img { margin: 5px 0 0 4px; } -

    Static variables

    @:value("i-default")staticinlineread onlyDEFAULT:String = "i-default"

    Constructor

    new(name:String)

    Variables

    Methods

    getLanguage():String

    getRegion():String

    getScript():String

    getVariant():String

    \ No newline at end of file +

    Static variables

    @:value("i-default")staticinlineread onlyDEFAULT:String = "i-default"

    Constructor

    new(name:String)

    Variables

    Methods

    getLanguage():String

    getRegion():String

    getScript():String

    getVariant():String

    \ No newline at end of file diff --git a/openfl/globalization/index.html b/openfl/globalization/index.html index 9447709..81daefc 100644 --- a/openfl/globalization/index.html +++ b/openfl/globalization/index.html @@ -85,4 +85,4 @@

    package ::full::

    package ::full::

    ::end:: --> -
    ..
    DateTimeFormatter

    DateTimeNameContext

    DateTimeNameStyle

    DateTimeStyle

    LastOperationStatus

    LocaleID

    \ No newline at end of file +
    ..
    DateTimeFormatter

    DateTimeNameContext

    DateTimeNameStyle

    DateTimeStyle

    LastOperationStatus

    LocaleID

    \ No newline at end of file diff --git a/openfl/media/AudioPlaybackMode.html b/openfl/media/AudioPlaybackMode.html index 46a4610..fde495f 100644 --- a/openfl/media/AudioPlaybackMode.html +++ b/openfl/media/AudioPlaybackMode.html @@ -84,4 +84,4 @@

    Try to minimize usage of AudioPlaybackMode.VOICE, and try to switch to AudioPlaybackMode.MEDIA as soon as possible after a voice call ends, which allows other applications to play in media mode.

    -

    This setting has no special effect on the desktop or TV.

    \ No newline at end of file +

    This setting has no special effect on the desktop or TV.

    \ No newline at end of file diff --git a/openfl/media/CameraPosition.html b/openfl/media/CameraPosition.html index d14b006..6894076 100644 --- a/openfl/media/CameraPosition.html +++ b/openfl/media/CameraPosition.html @@ -55,4 +55,4 @@ }

    The CameraPosition class defines constants for the position property of the Camera class.

    See also:

    • openfl.media.Camera

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyBACK:CameraPosition = 0

    The Camera.position property returns this value for a back camera.

    @:value(cast 1)@:impl@:enuminlineread onlyFRONT:CameraPosition = 1

    The Camera.position property returns this value for a front camera.

    @:value(cast 2)@:impl@:enuminlineread onlyUNKNOWN:CameraPosition = 2

    The Camera.position property returns this value when the position of -the Camera cannot be determined. This is the default value.

    \ No newline at end of file +the Camera cannot be determined. This is the default value.

    \ No newline at end of file diff --git a/openfl/media/ID3Info.html b/openfl/media/ID3Info.html index 3bf428b..fbfbe31 100644 --- a/openfl/media/ID3Info.html +++ b/openfl/media/ID3Info.html @@ -58,4 +58,4 @@

    The ID3Info class contains properties that reflect ID3 metadata. You can get additional metadata for MP3 files by accessing the id3 property of the Sound class; for example, mySound.id3.TIME. For more information, see the entry for -Sound.id3 and the ID3 tag definitions at http://www.id3.org.

    Constructor

    new()

    Variables

    album:String

    The name of the album; corresponds to the ID3 2.0 tag TALB.

    artist:String

    The name of the artist; corresponds to the ID3 2.0 tag TPE1.

    comment:String

    A comment about the recording; corresponds to the ID3 2.0 tag COMM.

    genre:String

    The genre of the song; corresponds to the ID3 2.0 tag TCON.

    songName:String

    The name of the song; corresponds to the ID3 2.0 tag TIT2.

    track:String

    The track number; corresponds to the ID3 2.0 tag TRCK.

    year:String

    The year of the recording; corresponds to the ID3 2.0 tag TYER.

    \ No newline at end of file +Sound.id3 and the ID3 tag definitions at http://www.id3.org.

    Constructor

    new()

    Variables

    album:String

    The name of the album; corresponds to the ID3 2.0 tag TALB.

    artist:String

    The name of the artist; corresponds to the ID3 2.0 tag TPE1.

    comment:String

    A comment about the recording; corresponds to the ID3 2.0 tag COMM.

    genre:String

    The genre of the song; corresponds to the ID3 2.0 tag TCON.

    songName:String

    The name of the song; corresponds to the ID3 2.0 tag TIT2.

    track:String

    The track number; corresponds to the ID3 2.0 tag TRCK.

    year:String

    The year of the recording; corresponds to the ID3 2.0 tag TYER.

    \ No newline at end of file diff --git a/openfl/media/Sound.html b/openfl/media/Sound.html index 600f8ad..fc37ce7 100644 --- a/openfl/media/Sound.html +++ b/openfl/media/Sound.html @@ -373,4 +373,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/media/SoundChannel.html b/openfl/media/SoundChannel.html index 32bf447..b3469e8 100644 --- a/openfl/media/SoundChannel.html +++ b/openfl/media/SoundChannel.html @@ -195,4 +195,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/media/SoundLoaderContext.html b/openfl/media/SoundLoaderContext.html index 170d24c..bcfa577 100644 --- a/openfl/media/SoundLoaderContext.html +++ b/openfl/media/SoundLoaderContext.html @@ -149,4 +149,4 @@

    For more information related to security, see the Flash Player Developer Center Topic: <a href="http://www.adobe.com/go/devnet_security_en" -scope="external">Security.

    \ No newline at end of file +scope="external">Security.

    \ No newline at end of file diff --git a/openfl/media/SoundMixer.html b/openfl/media/SoundMixer.html index ce530c9..af757ee 100644 --- a/openfl/media/SoundMixer.html +++ b/openfl/media/SoundMixer.html @@ -114,4 +114,4 @@

    For more information related to security, see the Flash Player Developer Center Topic: <a href="http://www.adobe.com/go/devnet_security_en" -scope="external">Security.

    \ No newline at end of file +scope="external">Security.

    \ No newline at end of file diff --git a/openfl/media/SoundTransform.html b/openfl/media/SoundTransform.html index 333e3d4..8bdf3a2 100644 --- a/openfl/media/SoundTransform.html +++ b/openfl/media/SoundTransform.html @@ -60,4 +60,4 @@ 1(full pan right). A value of 0 represents no panning(balanced center between right and left).

    rightToLeft:Float

    A value, from 0(none) to 1(all), specifying how much of the right input is played in the left speaker.

    rightToRight:Float

    A value, from 0(none) to 1(all), specifying how much of the right input -is played in the right speaker.

    volume:Float

    The volume, ranging from 0(silent) to 1(full volume).

    \ No newline at end of file +is played in the right speaker.

    volume:Float

    The volume, ranging from 0(silent) to 1(full volume).

    \ No newline at end of file diff --git a/openfl/media/Video.html b/openfl/media/Video.html index d1e88d7..7876892 100644 --- a/openfl/media/Video.html +++ b/openfl/media/Video.html @@ -460,7 +460,7 @@ property of the scrollRect Rectangle object. You can scroll an object up and down by setting the y property of the scrollRect Rectangle object. If the display object is rotated -90� and you scroll it left and right, the display object actually scrolls +90° and you scroll it left and right, the display object actually scrolls up and down.

    @:betashader:Shader

    BETA**

    Applies a custom Shader object to use when rendering this display object (or its children) when using hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to @@ -512,16 +512,16 @@ to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

    Inherited Methods

    Defined by DisplayObject

    getBounds(targetCoordinateSpace:DisplayObject):Rectangle

    Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object. Consider the following code, which shows how the rectangle returned can @@ -608,4 +608,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/media/index.html b/openfl/media/index.html index eaf38f9..61341ef 100644 --- a/openfl/media/index.html +++ b/openfl/media/index.html @@ -119,4 +119,4 @@

    package ::full::

    server to other users. Using these features, you can develop media applications such as a simple video player, a video player with multipoint publishing from one server to another, or a video sharing application for -a user community.

    \ No newline at end of file +a user community.

    \ No newline at end of file diff --git a/openfl/net/DatagramSocket.html b/openfl/net/DatagramSocket.html index 704e999..08b694d 100644 --- a/openfl/net/DatagramSocket.html +++ b/openfl/net/DatagramSocket.html @@ -56,7 +56,8 @@

    You can test for support at run time using the DatagramSocket.isSupported property.

    OpenFL target support: This feature is supported on all desktop operating -systems, on iOS, and on Android.

    +systems, on iOS, and on Android. This feature is not supported on the html5 +target or other non-sys targets.

    Adobe AIR profile support: his feature is supported on all desktop operating systems, on iOS (starting with AIR 3.8), and on Android (starting with AIR 3.8). This feature is not supported on AIR for TV devices. See @@ -151,4 +152,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/net/FileFilter.html b/openfl/net/FileFilter.html index 7867da1..eb773e0 100644 --- a/openfl/net/FileFilter.html +++ b/openfl/net/FileFilter.html @@ -81,7 +81,7 @@ var docFilter = new FileFilter("Documents", "*.pdf;*.doc;*.txt"); var myFileReference = new FileReference(); myFileReference.browse([imagesFilter, docFilter]);
    -

    Or in an AIR application:

    +

    Or in an OpenFL desktop application:

    var imagesFilter = new FileFilter("Images", "*.jpg;*.gif;*.png");
     var docFilter = new FileFilter("Documents", "*.pdf;*.doc;*.txt");
     var myFile = new File();
    @@ -115,4 +115,4 @@
     itself is not visible to the user; the user sees only the value of the
     description property.) The macType property contains a
     semicolon-delimited list of Macintosh file types, as shown in the
    -following string: "JPEG;jp2_;GIFF".

    \ No newline at end of file +following string: "JPEG;jp2_;GIFF".

    \ No newline at end of file diff --git a/openfl/net/FileReference.html b/openfl/net/FileReference.html index 0cfc7d1..6ce451a 100644 --- a/openfl/net/FileReference.html +++ b/openfl/net/FileReference.html @@ -288,19 +288,17 @@ AIR runtime, the select event acts slightly differently depending on what method invokes it. When the select event is dispatched after a -browse() call, Flash Player or the AIR -application can read all the FileReference -object's properties, because the file selected -by the user is on the local file system. When -the select event occurs after a download() -call, Flash Player or the AIR application can -read only the name property, because the file -hasn't yet been downloaded to the local file -system at the moment the select event is -dispatched. When the file is downloaded and the -complete event dispatched, Flash Player or the -AIR application can read all other properties of -the FileReference object.

    uploadCompleteData

    Dispatched after data is received from the +browse() call, the OpenFL application can read +all the FileReference object's properties, because +the file selected by the user is on the local file +system. When the select event occurs after a +download() call, the OpenFL application can read +only the name property, because the file hasn't +yet been downloaded to the local file system at the +moment the select event is dispatched. When the +file is downloaded and the complete even +dispatched, the OpenFL application can read all +other properties of the FileReference object.

    uploadCompleteData

    Dispatched after data is received from the server after a successful upload. This event is not dispatched if data is not returned from the server.

    Constructor

    new()

    Creates a new FileReference object. When populated, a FileReference @@ -1041,4 +1039,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/net/FileReferenceList.html b/openfl/net/FileReferenceList.html index 0dd7e11..40064b2 100644 --- a/openfl/net/FileReferenceList.html +++ b/openfl/net/FileReferenceList.html @@ -173,4 +173,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/net/IDynamicPropertyOutput.html b/openfl/net/IDynamicPropertyOutput.html index 1541865..939d941 100644 --- a/openfl/net/IDynamicPropertyOutput.html +++ b/openfl/net/IDynamicPropertyOutput.html @@ -63,4 +63,4 @@ values to properties of dynamic objects; or to create new properties for dynamic objects.

    Parameters:

    name

    The name of the property. You can use this parameter either to specify the name of an existing property of the dynamic object or -to create a new property.

    value

    The value to write to the specified property.

    \ No newline at end of file +to create a new property.

    value

    The value to write to the specified property.

    \ No newline at end of file diff --git a/openfl/net/IDynamicPropertyWriter.html b/openfl/net/IDynamicPropertyWriter.html index 174eafc..6bd97b8 100644 --- a/openfl/net/IDynamicPropertyWriter.html +++ b/openfl/net/IDynamicPropertyWriter.html @@ -64,4 +64,4 @@ object with dynamic properties. If ObjectEncoding.dynamicPropertyWriter is set, this method is invoked for each object with dynamic properties.

    Parameters:

    obj

    The object to write to.

    output

    The IDynamicPropertyOutput object that contains the name -and value to dynamically write to the object.

    \ No newline at end of file +and value to dynamically write to the object.

    \ No newline at end of file diff --git a/openfl/net/IPVersion.html b/openfl/net/IPVersion.html index 20cde73..70f1af1 100644 --- a/openfl/net/IPVersion.html +++ b/openfl/net/IPVersion.html @@ -58,4 +58,4 @@

    IPv4 addresses are expressed in Haxe as a string in dot-decimal notation, such as: "192.0.2.0".

    @:value(cast 1)@:impl@:enuminlineread onlyIPV6:IPVersion = 1

    IPv6 addresses are expressed in Haxe as a string in hexadecimal-colon notation and enclosed in brackets, such as: -"[2001:db8:ccc3:ffff:0:444d:555e:666f]".

    \ No newline at end of file +"[2001:db8:ccc3:ffff:0:444d:555e:666f]".

    \ No newline at end of file diff --git a/openfl/net/NetConnection.html b/openfl/net/NetConnection.html index 0135f58..e8693d2 100644 --- a/openfl/net/NetConnection.html +++ b/openfl/net/NetConnection.html @@ -295,4 +295,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/net/NetStream.html b/openfl/net/NetStream.html index 706ed3c..09f5bed 100644 --- a/openfl/net/NetStream.html +++ b/openfl/net/NetStream.html @@ -943,4 +943,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/net/ObjectEncoding.html b/openfl/net/ObjectEncoding.html index 54bddaf..0145ede 100644 --- a/openfl/net/ObjectEncoding.html +++ b/openfl/net/ObjectEncoding.html @@ -106,4 +106,4 @@ format, this may change. You can use this constant only if you're not concerned about interoperability with previous versions.

    @:value(cast 10)@:impl@:enuminlineread onlyHXSF:ObjectEncoding = 10

    Specifies that objects are serialized using the Haxe Serialization Format.

    @:value(cast 12)@:impl@:enuminlineread onlyJSON:ObjectEncoding = 12

    Specifies that objects are serialized using -JavaScript Object Notation.

    \ No newline at end of file +JavaScript Object Notation.

    \ No newline at end of file diff --git a/openfl/net/Responder.html b/openfl/net/Responder.html index 9e84ff5..d20051c 100644 --- a/openfl/net/Responder.html +++ b/openfl/net/Responder.html @@ -66,4 +66,4 @@ status. Operation errors target the Responder object instead of the NetConnection object for easier error handling.

    Constructor

    @:value({ status : null })new(result:Function, ?status:Function)

    Creates a new Responder object. You pass a Responder object to NetConnection.call() to handle return values from the server. You may -pass null for either or both parameters.

    \ No newline at end of file +pass null for either or both parameters.

    \ No newline at end of file diff --git a/openfl/net/SecureSocket.html b/openfl/net/SecureSocket.html index d83f619..b5ea8b5 100644 --- a/openfl/net/SecureSocket.html +++ b/openfl/net/SecureSocket.html @@ -57,7 +57,8 @@ Secure Sockets Layer (SSL) and Transport Layer Security (TLS) protocols.

    You can test for support at run time using the SecureSocket.isSupported property.

    -

    OpenFL target support: This feature is not supported on all platforms.

    +

    OpenFL target support: This feature is supported on all desktop operating +systems, on iOS, and on Android. It is not supported on non-sys targets.

    Adobe AIR profile support: This feature is supported on all desktop operating systems, but is not supported on all AIR for TV devices. On mobile devices, it is supported on Android and also supported on iOS starting from @@ -382,4 +383,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/net/ServerSocket.html b/openfl/net/ServerSocket.html index 7798681..ea901ac 100644 --- a/openfl/net/ServerSocket.html +++ b/openfl/net/ServerSocket.html @@ -58,7 +58,8 @@

    You can test for support at run time using the ServerSocket.isSupported property.

    OpenFL target support: This feature is supported on all desktop operating -systems, on iOS, and on Android. This feature is not supported on html5.

    +systems, on iOS, and on Android. This feature is not supported on the html5 +target or other non-sys targets.

    Adobe AIR profile support: This feature is supported on all desktop operating systems, on iOS (starting with AIR 3.8), and on Android (starting with AIR 3.8). This feature is not supported on AIR for TV devices. See @@ -80,10 +81,10 @@ serious network failure occurs). Any data sent over the connection is broken into transmittable packets and reassembled on the other end. All packets are guaranteed to arrive (within reason) — any lost packets are retransmitted. In general, the TCP protocol manages the available network -bandwidth better than the UDP protocol. Most AIR applications that require socket communications +bandwidth better than the UDP protocol. Most OpenFL applications that require socket communications should use the ServerSocket and Socket classes rather than the DatagramSocket class.

    -

    The ServerSocket class can only be used in targets that support TCP.

    Events:

    close

    Dispatched when the operating system closes this socket.

    connect

    Dispatched when a remote socket seeks to connect to this server socket.

    Static variables

    @:value(true)staticread onlyisSupported:Bool = true

    Indicates whether or not ServerSocket features are supported in the run-time environment.

    Constructor

    new()

    Creates a ServerSocket object.

    Throws:

    SecurityError

    This error occurs ff the calling content is running outside the AIR -application security sandbox.

    Variables

    read onlybound:Bool

    Indicates whether the socket is bound to a local address and port.

    read onlylistening:Bool

    Indicates whether the server socket is listening for incoming connections.

    read onlylocalAddress:String

    The IP address on which the socket is listening.

    read onlylocalPort:Int

    The port on which the socket is listening.

    Methods

    @:value({ localAddress : "0.0.0.0", localPort : 0 })bind(localPort:Int = 0, localAddress:String = "0.0.0.0"):Void

    Binds this socket to the specified local address and port.

    Parameters:

    localPort

    (default = 0) The number of the port to bind to on the local computer. +

    The ServerSocket class can only be used in targets that support TCP.

    Events:

    close

    Dispatched when the operating system closes this socket.

    connect

    Dispatched when a remote socket seeks to connect to this server socket.

    Static variables

    @:value(true)staticread onlyisSupported:Bool = true

    Indicates whether or not ServerSocket features are supported in the run-time environment.

    Constructor

    new()

    Creates a ServerSocket object.

    Throws:

    SecurityError

    This error occurs if the calling content is +running outside the AIR application security sandbox.

    Variables

    read onlybound:Bool

    Indicates whether the socket is bound to a local address and port.

    read onlylistening:Bool

    Indicates whether the server socket is listening for incoming connections.

    read onlylocalAddress:String

    The IP address on which the socket is listening.

    read onlylocalPort:Int

    The port on which the socket is listening.

    Methods

    @:value({ localAddress : "0.0.0.0", localPort : 0 })bind(localPort:Int = 0, localAddress:String = "0.0.0.0"):Void

    Binds this socket to the specified local address and port.

    Parameters:

    localPort

    (default = 0) The number of the port to bind to on the local computer. If localPort, is set to 0 (the default), the next available system port is bound. Permission to connect to a port number below 1024 is subject to the system security policy. On Mac and Linux systems, for example, the application must be running with root privileges to connect @@ -147,4 +148,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/net/SharedObject.html b/openfl/net/SharedObject.html index 008336f..f1905a1 100644 --- a/openfl/net/SharedObject.html +++ b/openfl/net/SharedObject.html @@ -303,7 +303,7 @@ To create a remote shared object, call getRemote() the call connect() to connect the remote shared object to the server, as in the following:

    -
    var nc:NetConnection = new NetConnection();
    +
    var nc:NetConnection = new NetConnection();
     nc.connect("rtmp://somedomain.com/applicationName");
     var myRemoteSO:SharedObject = SharedObject.getRemote("mo", nc.uri, false);
     myRemoteSO.connect(nc);
    @@ -424,7 +424,7 @@ dispatched — might be lost.

    Call the connect() method to connect to a remote shared object, for example:

    -
    var myRemoteSO:SharedObject = SharedObject.getRemote("mo", myNC.uri, false);
    +
    var myRemoteSO:SharedObject = SharedObject.getRemote("mo", myNC.uri, false);
     myRemoteSO.connect(myNC);

    Parameters:

    myConnection

    A NetConnection object that uses the Real-Time Messaging Protocol (RTMP), such as a NetConnection object used to communicate with Flash Media @@ -627,4 +627,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/net/SharedObjectFlushStatus.html b/openfl/net/SharedObjectFlushStatus.html index f77465c..13b78bc 100644 --- a/openfl/net/SharedObjectFlushStatus.html +++ b/openfl/net/SharedObjectFlushStatus.html @@ -55,4 +55,4 @@ }

    The SharedObjectFlushStatus class provides values for the code returned from a call to the SharedObject.flush() method.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyFLUSHED:SharedObjectFlushStatus = 0

    Indicates that the flush completed successfully.

    @:value(cast 1)@:impl@:enuminlineread onlyPENDING:SharedObjectFlushStatus = 1

    Indicates that the user is being prompted to increase disk space for the -shared object before the flush can occur.

    \ No newline at end of file +shared object before the flush can occur.

    \ No newline at end of file diff --git a/openfl/net/Socket.html b/openfl/net/Socket.html index f844eec..90ab48a 100644 --- a/openfl/net/Socket.html +++ b/openfl/net/Socket.html @@ -62,6 +62,9 @@

    To use the methods of the Socket class, first use the constructor, new Socket, to create a Socket object.

    A socket transmits and receives data asynchronously.

    +

    OpenFL target support: This feature is supported on all desktop operating +systems, on iOS, and on Android. On the html5 target, it uses web sockets +instead of raw unix-style sockets.

    On some operating systems, flush() is called automatically between execution frames, but on other operating systems, such as Windows, the data is never sent unless you call flush() explicitly. To ensure your @@ -429,4 +432,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/net/URLLoader.html b/openfl/net/URLLoader.html index 5c8bb98..1658802 100644 --- a/openfl/net/URLLoader.html +++ b/openfl/net/URLLoader.html @@ -326,4 +326,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/net/URLLoaderDataFormat.html b/openfl/net/URLLoaderDataFormat.html index 8584ae6..c3d75ac 100644 --- a/openfl/net/URLLoaderDataFormat.html +++ b/openfl/net/URLLoaderDataFormat.html @@ -54,4 +54,4 @@ margin: 5px 0 0 4px; }

    The URLLoaderDataFormat class provides values that specify how downloaded -data is received.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyBINARY:URLLoaderDataFormat = 0

    Specifies that downloaded data is received as raw binary data.

    @:value(cast 1)@:impl@:enuminlineread onlyTEXT:URLLoaderDataFormat = 1

    Specifies that downloaded data is received as text.

    @:value(cast 2)@:impl@:enuminlineread onlyVARIABLES:URLLoaderDataFormat = 2

    Specifies that downloaded data is received as URL-encoded variables.

    \ No newline at end of file +data is received.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyBINARY:URLLoaderDataFormat = 0

    Specifies that downloaded data is received as raw binary data.

    @:value(cast 1)@:impl@:enuminlineread onlyTEXT:URLLoaderDataFormat = 1

    Specifies that downloaded data is received as text.

    @:value(cast 2)@:impl@:enuminlineread onlyVARIABLES:URLLoaderDataFormat = 2

    Specifies that downloaded data is received as URL-encoded variables.

    \ No newline at end of file diff --git a/openfl/net/URLRequest.html b/openfl/net/URLRequest.html index 8e122ea..b7bbb0e 100644 --- a/openfl/net/URLRequest.html +++ b/openfl/net/URLRequest.html @@ -229,4 +229,4 @@

    Note: This property does not affect the user agent string when the URLRequest object is used with the load() method of an HTMLLoader object. To set the user agent string for an HTMLLoader object, set the userAgent property of the -HTMLLoader object or set the static URLRequestDefaults.userAgent property.

    \ No newline at end of file +HTMLLoader object or set the static URLRequestDefaults.userAgent property.

    \ No newline at end of file diff --git a/openfl/net/URLRequestDefaults.html b/openfl/net/URLRequestDefaults.html index 96a7d2c..65fbd2c 100644 --- a/openfl/net/URLRequestDefaults.html +++ b/openfl/net/URLRequestDefaults.html @@ -99,4 +99,4 @@ setting.

    This default value varies depending on the runtime operating system (such as Mac OS, Linux or Windows), the runtime language, and the runtime version, as in the -following examples:

    • "Mozilla/5.0 (Macintosh; U; PPC Mac OS X; en) AppleWebKit/526.9+ (KHTML, like Gecko) AdobeAIR/1.5"
    • "Mozilla/5.0 (Windows; U; en) AppleWebKit/526.9+ (KHTML, like Gecko) AdobeAIR/1.5"
    • "Mozilla/5.0 (X11; U; Linux i686; en-US) AppleWebKit/526.9+ (KHTML, like Gecko) AdobeAIR/1.5"
    \ No newline at end of file +following examples:

    • "Mozilla/5.0 (Macintosh; U; PPC Mac OS X; en) AppleWebKit/526.9+ (KHTML, like Gecko) AdobeAIR/1.5"
    • "Mozilla/5.0 (Windows; U; en) AppleWebKit/526.9+ (KHTML, like Gecko) AdobeAIR/1.5"
    • "Mozilla/5.0 (X11; U; Linux i686; en-US) AppleWebKit/526.9+ (KHTML, like Gecko) AdobeAIR/1.5"
    \ No newline at end of file diff --git a/openfl/net/URLRequestHeader.html b/openfl/net/URLRequestHeader.html index 7d3b570..3daee7d 100644 --- a/openfl/net/URLRequestHeader.html +++ b/openfl/net/URLRequestHeader.html @@ -58,7 +58,7 @@ consists of a name/value pair. URLRequestHeader objects are used in the requestHeaders property of the URLRequest class.

    In Adobe® AIR®, content in the application -security sandbox(such as content installed with the AIR application) can +security sandbox (such as content installed with the AIR application) can use any request headers, without error. However, for content running in Adobe AIR that is in a different security sandbox, or for content running in Flash® Player, using following request headers cause a @@ -114,4 +114,4 @@ Content-Type or SOAPAction).

    value

    The value associated with the name property (such as text/plain).

    Variables

    name:String

    An HTTP request header name(such as Content-Type or SOAPAction).

    value:String

    The value associated with the name property(such as -text/plain).

    \ No newline at end of file +text/plain).

    \ No newline at end of file diff --git a/openfl/net/URLRequestMethod.html b/openfl/net/URLRequestMethod.html index f6bc225..014620d 100644 --- a/openfl/net/URLRequestMethod.html +++ b/openfl/net/URLRequestMethod.html @@ -60,4 +60,4 @@

    Note: For content running in Adobe AIR, when using the navigateToURL() function, the runtime treats a URLRequest that uses the POST method(one that has its method property -set to URLRequestMethod.POST) as using the GET method.

    @:value(cast "PUT")@:impl@:enuminlineread onlyPUT:URLRequestMethod = "PUT"

    Specifies that the URLRequest object is a PUT.

    \ No newline at end of file +set to URLRequestMethod.POST) as using the GET method.

    @:value(cast "PUT")@:impl@:enuminlineread onlyPUT:URLRequestMethod = "PUT"

    Specifies that the URLRequest object is a PUT.

    \ No newline at end of file diff --git a/openfl/net/URLStream.html b/openfl/net/URLStream.html index 056e1b2..908d693 100644 --- a/openfl/net/URLStream.html +++ b/openfl/net/URLStream.html @@ -455,4 +455,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/net/URLVariables.html b/openfl/net/URLVariables.html index 8b019cb..2d4fc50 100644 --- a/openfl/net/URLVariables.html +++ b/openfl/net/URLVariables.html @@ -63,4 +63,4 @@

    This method is used internally by the URLVariables events. Most users do not need to call this method directly.

    Parameters:

    source

    A URL-encoded query string containing name/value pairs.

    Throws:

    Error

    The source parameter must be a URL-encoded query string containing name/value pairs.

    statictoString(this:Dynamic):String

    Returns a string containing all enumerable variables, in the MIME content -encoding application/x-www-form-urlencoded.

    Returns:

    A URL-encoded string containing name/value pairs.

    \ No newline at end of file +encoding application/x-www-form-urlencoded.

    Returns:

    A URL-encoded string containing name/value pairs.

    \ No newline at end of file diff --git a/openfl/net/XMLSocket.html b/openfl/net/XMLSocket.html index f00f9f7..f8c9484 100644 --- a/openfl/net/XMLSocket.html +++ b/openfl/net/XMLSocket.html @@ -1,23 +1,17 @@ -openfl.net.XMLSocket - API Reference

    The XMLSocket class implements client sockets that let the Flash Player or -AIR application communicate with a server computer identified by an IP -address or domain name. The XMLSocket class is useful for client-server -applications that require low latency, such as real-time chat systems. A -traditional HTTP-based chat solution frequently polls the server and -downloads new messages using an HTTP request. In contrast, an XMLSocket -chat solution maintains an open connection to the server, which lets the -server immediately send incoming messages without a request from the -client. To use the XMLSocket class, the server computer must run a daemon -that understands the protocol used by the XMLSocket class. The protocol is -described in the following list: - XML messages are sent over a full-duplex TCP/IP stream socket -connection. - Each XML message is a complete XML document, terminated by a zero (0) -byte. -* An unlimited number of XML messages can be sent and received over a -single XMLSocket connection.

    +

    The XMLSocket class implements client sockets that let the OpenFL +application communicate with a server computer identified by an IP address +or domain name. The XMLSocket class is useful for client-server applications +that require low latency, such as real-time chat systems. A traditional +HTTP-based chat solution frequently polls the server and downloads new +messages using an HTTP request. In contrast, an XMLSocket chat solution +maintains an open connection to the server, which lets the server +immediately send incoming messages without a request from the client. To use +the XMLSocket class, the server computer must run a daemon that understands +the protocol used by the XMLSocket class. The protocol is described in the +following list:

    • XML messages are sent over a full-duplex TCP/IP stream socket connection.
    • Each XML message is a complete XML document, terminated by a zero (0) +byte.
    • An unlimited number of XML messages can be sent and received over a +single XMLSocket connection.

    Setting up a server to communicate with the XMLSocket object can be challenging. If your application does not require real-time interactivity, use the URLLoader class instead of the XMLSocket class.

    @@ -313,4 +303,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/net/dns/AAAARecord.html b/openfl/net/dns/AAAARecord.html index ff1bf52..1e20c8c 100644 --- a/openfl/net/dns/AAAARecord.html +++ b/openfl/net/dns/AAAARecord.html @@ -62,4 +62,4 @@

    The length of time (in seconds) that the resource record is valid. Records should not be cached for longer than this value. A ttl of zero means the record is volatile and must not be cached. A ttl less than -zero means that the resource record is not valid.

    Inherited Methods

    \ No newline at end of file +zero means that the resource record is not valid.

    Inherited Methods

    \ No newline at end of file diff --git a/openfl/net/dns/ARecord.html b/openfl/net/dns/ARecord.html index 8cd71e6..2bdade6 100644 --- a/openfl/net/dns/ARecord.html +++ b/openfl/net/dns/ARecord.html @@ -62,4 +62,4 @@

    The length of time (in seconds) that the resource record is valid. Records should not be cached for longer than this value. A ttl of zero means the record is volatile and must not be cached. A ttl less than -zero means that the resource record is not valid.

    Inherited Methods

    \ No newline at end of file +zero means that the resource record is not valid.

    Inherited Methods

    \ No newline at end of file diff --git a/openfl/net/dns/DNSResolver.html b/openfl/net/dns/DNSResolver.html index ae3c017..9fd8bf6 100644 --- a/openfl/net/dns/DNSResolver.html +++ b/openfl/net/dns/DNSResolver.html @@ -193,4 +193,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/net/dns/MXRecord.html b/openfl/net/dns/MXRecord.html index 319dd85..70bb4b4 100644 --- a/openfl/net/dns/MXRecord.html +++ b/openfl/net/dns/MXRecord.html @@ -64,4 +64,4 @@

    The length of time (in seconds) that the resource record is valid. Records should not be cached for longer than this value. A ttl of zero means the record is volatile and must not be cached. A ttl less than -zero means that the resource record is not valid.

    Inherited Methods

    \ No newline at end of file +zero means that the resource record is not valid.

    Inherited Methods

    \ No newline at end of file diff --git a/openfl/net/dns/PTRRecord.html b/openfl/net/dns/PTRRecord.html index 3d76cb9..9e8bda2 100644 --- a/openfl/net/dns/PTRRecord.html +++ b/openfl/net/dns/PTRRecord.html @@ -62,4 +62,4 @@

    The length of time (in seconds) that the resource record is valid. Records should not be cached for longer than this value. A ttl of zero means the record is volatile and must not be cached. A ttl less than -zero means that the resource record is not valid.

    Inherited Methods

    \ No newline at end of file +zero means that the resource record is not valid.

    Inherited Methods

    \ No newline at end of file diff --git a/openfl/net/dns/ResourceRecord.html b/openfl/net/dns/ResourceRecord.html index cc9882e..d640096 100644 --- a/openfl/net/dns/ResourceRecord.html +++ b/openfl/net/dns/ResourceRecord.html @@ -60,4 +60,4 @@

    The length of time (in seconds) that the resource record is valid. Records should not be cached for longer than this value. A ttl of zero means the record is volatile and must not be cached. A ttl less than -zero means that the resource record is not valid.

    \ No newline at end of file +zero means that the resource record is not valid.

    \ No newline at end of file diff --git a/openfl/net/dns/SRVRecord.html b/openfl/net/dns/SRVRecord.html index e30c0bc..fd6af33 100644 --- a/openfl/net/dns/SRVRecord.html +++ b/openfl/net/dns/SRVRecord.html @@ -65,4 +65,4 @@

    The length of time (in seconds) that the resource record is valid. Records should not be cached for longer than this value. A ttl of zero means the record is volatile and must not be cached. A ttl less than -zero means that the resource record is not valid.

    Inherited Methods

    \ No newline at end of file +zero means that the resource record is not valid.

    Inherited Methods

    \ No newline at end of file diff --git a/openfl/net/dns/index.html b/openfl/net/dns/index.html index f70d8b3..df2a892 100644 --- a/openfl/net/dns/index.html +++ b/openfl/net/dns/index.html @@ -91,4 +91,4 @@

    package ::full::

    containing a mail exchange server address.

    PTRRecord

    The PTRRecord class represents a Domain Name System (DNS) PTR resource record containing a canonical domain name.

    ResourceRecord

    The ResourceRecord class is the base class for Domain Name System (DNS) resource record classes.

    SRVRecord

    The SRVRecord class represents a Domain Name System (DNS) SRV resource -record containing a service host.

    \ No newline at end of file +record containing a service host.

    \ No newline at end of file diff --git a/openfl/net/index.html b/openfl/net/index.html index 4a6fff2..a191c6d 100644 --- a/openfl/net/index.html +++ b/openfl/net/index.html @@ -169,20 +169,14 @@

    package ::full::

    insufficient data is available.

    URLVariables

    The URLVariables class allows you to transfer variables between an application and a server. Use URLVariables objects with methods of the URLLoader class, with the data property of the URLRequest -class, and with openfl.net package functions.

    XMLSocket

    The XMLSocket class implements client sockets that let the Flash Player or -AIR application communicate with a server computer identified by an IP -address or domain name. The XMLSocket class is useful for client-server -applications that require low latency, such as real-time chat systems. A -traditional HTTP-based chat solution frequently polls the server and -downloads new messages using an HTTP request. In contrast, an XMLSocket -chat solution maintains an open connection to the server, which lets the -server immediately send incoming messages without a request from the -client. To use the XMLSocket class, the server computer must run a daemon -that understands the protocol used by the XMLSocket class. The protocol is -described in the following list: - XML messages are sent over a full-duplex TCP/IP stream socket -connection. - Each XML message is a complete XML document, terminated by a zero (0) -byte. -* An unlimited number of XML messages can be sent and received over a -single XMLSocket connection.

    \ No newline at end of file +class, and with openfl.net package functions.

    XMLSocket

    The XMLSocket class implements client sockets that let the OpenFL +application communicate with a server computer identified by an IP address +or domain name. The XMLSocket class is useful for client-server applications +that require low latency, such as real-time chat systems. A traditional +HTTP-based chat solution frequently polls the server and downloads new +messages using an HTTP request. In contrast, an XMLSocket chat solution +maintains an open connection to the server, which lets the server +immediately send incoming messages without a request from the client. To use +the XMLSocket class, the server computer must run a daemon that understands +the protocol used by the XMLSocket class. The protocol is described in the +following list:

    \ No newline at end of file diff --git a/openfl/permissions/PermissionStatus.html b/openfl/permissions/PermissionStatus.html index 4ac1a61..92a5e7a 100644 --- a/openfl/permissions/PermissionStatus.html +++ b/openfl/permissions/PermissionStatus.html @@ -56,4 +56,4 @@

    The PermissionStatus class is an enumeration of constant values that specify the authorization status of a permission.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyDENIED:PermissionStatus = 0

    Specifies that the permission has been denied.

    @:value(cast 1)@:impl@:enuminlineread onlyGRANTED:PermissionStatus = 1

    Specifies that the permission has been granted.

    @:value(cast 2)@:impl@:enuminlineread onlyONLY_WHEN_IN_USE:PermissionStatus = 2

    Specifies that the permission has been granted only when the app is in use.

    @:value(cast 3)@:impl@:enuminlineread onlyUNKNOWN:PermissionStatus = 3

    Specifies that the permission hasn't been requested yet.

    NOTE: On Android, permissionStatus will return UNKNOWN if permission -was denied with "Never ask again" option checked.

    \ No newline at end of file +was denied with "Never ask again" option checked.

    \ No newline at end of file diff --git a/openfl/permissions/index.html b/openfl/permissions/index.html index 349b706..a30c45c 100644 --- a/openfl/permissions/index.html +++ b/openfl/permissions/index.html @@ -86,4 +86,4 @@

    package ::full::

    ::end:: -->
    ..
    PermissionStatus

    The PermissionStatus class is an enumeration of constant values that specify -the authorization status of a permission.

    \ No newline at end of file +the authorization status of a permission.

    \ No newline at end of file diff --git a/openfl/printing/PrintJob.html b/openfl/printing/PrintJob.html index 82e4a18..19439ea 100644 --- a/openfl/printing/PrintJob.html +++ b/openfl/printing/PrintJob.html @@ -279,4 +279,4 @@ return false:

    Returns:

    A value of true if the user clicks OK when the Print dialog box appears; false if the user clicks Cancel or if an error occurs.

    Throws:

    IllegalOperationError

    in AIR 2 or later, if another PrintJob -is currently active

    \ No newline at end of file +is currently active

    \ No newline at end of file diff --git a/openfl/printing/PrintJobOptions.html b/openfl/printing/PrintJobOptions.html index 833d6b3..81d4e41 100644 --- a/openfl/printing/PrintJobOptions.html +++ b/openfl/printing/PrintJobOptions.html @@ -78,4 +78,4 @@
    var options = new PrintJobOptions();
     options.printAsBitmap = true;
     myPrintJob.addPage(mySprite, null, options);
    -

    Note: Adobe AIR does not support vector printing on Mac OS.

    \ No newline at end of file +

    Note: Adobe AIR does not support vector printing on Mac OS.

    \ No newline at end of file diff --git a/openfl/printing/PrintJobOrientation.html b/openfl/printing/PrintJobOrientation.html index 23f83be..73cdfd2 100644 --- a/openfl/printing/PrintJobOrientation.html +++ b/openfl/printing/PrintJobOrientation.html @@ -58,4 +58,4 @@ constant is used with the PrintJob.orientation property. Use the syntax PrintJobOrientation.LANDSCAPE.

    @:value(cast 1)@:impl@:enuminlineread onlyPORTRAIT:PrintJobOrientation = 1

    The portrait (vertical) image orientation for printing. This constant is used with the PrintJob.orientation property. Use the syntax -PrintJobOrientation.PORTRAIT.

    \ No newline at end of file +PrintJobOrientation.PORTRAIT.

    \ No newline at end of file diff --git a/openfl/printing/index.html b/openfl/printing/index.html index f9a7f6d..2629f0d 100644 --- a/openfl/printing/index.html +++ b/openfl/printing/index.html @@ -93,4 +93,4 @@

    package ::full::

    printing dynamic content, such as database content and dynamic text.

    PrintJobOptions

    The PrintJobOptions class contains properties to use with the options parameter of the PrintJob.addPage() method. For more information about addPage(), see the PrintJob class.

    PrintJobOrientation

    This class provides values that are used by the PrintJob.orientation -property for the image position of a printed page.

    \ No newline at end of file +property for the image position of a printed page.

    \ No newline at end of file diff --git a/openfl/profiler/Telemetry.html b/openfl/profiler/Telemetry.html index 064c3a7..65987a5 100644 --- a/openfl/profiler/Telemetry.html +++ b/openfl/profiler/Telemetry.html @@ -86,4 +86,4 @@ controlled from the Telemetry Server using Telemetry Protocol, would be ignored by Telemetry (will not be sent to Telemetry Server).

    Parameters:

    metric

    Metric name

    startSpanMarker

    Start marker.

    value

    Optional parameter. Any primitive value/object to be sent along with name, marker and duration

    Throws:

    ArgumentError

    If metric uses reserved namespaces like flash native -namespace (i.e. if metric name starts with '.')

    staticunregisterCommandHandler(commandName:String):Bool

    @returns

    Parameters:

    commandName
    \ No newline at end of file +namespace (i.e. if metric name starts with '.')

    staticunregisterCommandHandler(commandName:String):Bool

    @returns

    Parameters:

    commandName
    \ No newline at end of file diff --git a/openfl/profiler/index.html b/openfl/profiler/index.html index 3a94a81..fa14ee0 100644 --- a/openfl/profiler/index.html +++ b/openfl/profiler/index.html @@ -86,4 +86,4 @@

    package ::full::

    ::end:: -->
    ..
    Telemetry

    The Telemetry class lets an application profile ActionScript code and register handlers -for commands

    \ No newline at end of file +for commands

    \ No newline at end of file diff --git a/openfl/security/CertificateStatus.html b/openfl/security/CertificateStatus.html index 6023ccb..a85ed83 100644 --- a/openfl/security/CertificateStatus.html +++ b/openfl/security/CertificateStatus.html @@ -85,4 +85,4 @@ the certificate does not chain to any of the root certificates in the client trust store. On some operating systems, the untrustedSigners status is also reported if the certificate is in the list of untrusted -certificates on the client computer.

    \ No newline at end of file +certificates on the client computer.

    \ No newline at end of file diff --git a/openfl/security/X500DistinguishedName.html b/openfl/security/X500DistinguishedName.html index 5da022c..7108df8 100644 --- a/openfl/security/X500DistinguishedName.html +++ b/openfl/security/X500DistinguishedName.html @@ -68,4 +68,4 @@ string. Properties with no DN value are set to null.

    Note: The X500DistinguishedName properties store only the first occurrence of each DN attribute, although the DN protocol allows for multiple -attributes of the same type.

    See also:

    Variables

    read onlycommonName:String

    Returns the DN CommonName attribute.

    read onlycountryName:String

    Returns the DN CountryName attribute.

    read onlylocalityName:String

    Returns the DN LocalityName attribute.

    read onlyorganizationName:String

    Returns the DN OrganizationName attribute.

    read onlyorganizationalUnitName:String

    Returns the DN OrganizationalUnitName attribute.

    read onlystateOrProvinceName:String

    Returns the DN StateOrProvinceName attribute.

    Methods

    toString():String

    Returns all DN properties in one string.

    \ No newline at end of file +attributes of the same type.

    See also:

    Variables

    read onlycommonName:String

    Returns the DN CommonName attribute.

    read onlycountryName:String

    Returns the DN CountryName attribute.

    read onlylocalityName:String

    Returns the DN LocalityName attribute.

    read onlyorganizationName:String

    Returns the DN OrganizationName attribute.

    read onlyorganizationalUnitName:String

    Returns the DN OrganizationalUnitName attribute.

    read onlystateOrProvinceName:String

    Returns the DN StateOrProvinceName attribute.

    Methods

    toString():String

    Returns all DN properties in one string.

    \ No newline at end of file diff --git a/openfl/security/X509Certificate.html b/openfl/security/X509Certificate.html index 591273a..9ed9c66 100644 --- a/openfl/security/X509Certificate.html +++ b/openfl/security/X509Certificate.html @@ -77,4 +77,4 @@ issuer's list of issued certificates.

    read onlysignatureAlgorithmOID:String

    Provides the signature algorithm Object Identifier (OID).

    read onlysignatureAlgorithmParams:ByteArray

    Provides the signature algorithm's parameters. If there are no signature algorithm parameters, this value is set to null.

    read onlysubject:X500DistinguishedName

    Provides the subject's Distinguished Name (DN).

    read onlysubjectPublicKey:String

    Provides the subject's public key.

    read onlysubjectPublicKeyAlgorithmOID:String

    Provides the algorithm OID for the subject's public key.

    read onlysubjectUniqueID:String

    Provides the subject's unique identifier.

    read onlyvalidNotAfter:Date

    Indicates the date on which the certificate's validity period ends.

    read onlyvalidNotBefore:Date

    Indicates the date on which the certificate's validity period begins.

    read onlyversion:UInt

    Provides the version number of the certificate format. This property indicates whether the certificate has extensions, a unique identifier, -or only the basic fields.

    • version = 2: Indicates X.509 Version 3 - Extensions are present
    • version = 1: Indicates X.509 Version 2 - Extensions are not present, but a unique identifier is present.
    • version = null: Indicates X.509 Version 1 - Only the basic certificate fields are present
    \ No newline at end of file +or only the basic fields.

    • version = 2: Indicates X.509 Version 3 - Extensions are present
    • version = 1: Indicates X.509 Version 2 - Extensions are not present, but a unique identifier is present.
    • version = null: Indicates X.509 Version 1 - Only the basic certificate fields are present
    \ No newline at end of file diff --git a/openfl/security/index.html b/openfl/security/index.html index 3e8ff5a..7f00a4e 100644 --- a/openfl/security/index.html +++ b/openfl/security/index.html @@ -93,4 +93,4 @@

    package ::full::

    RFC2459. After you make a successful call to SecureSocket.connect(), the server's certificate data is stored as an X509Certificate instance in the SecureSocket.serverCertificate -property.

    \ No newline at end of file +property.

    \ No newline at end of file diff --git a/openfl/sensors/Accelerometer.html b/openfl/sensors/Accelerometer.html index 1c5baa1..8b58616 100644 --- a/openfl/sensors/Accelerometer.html +++ b/openfl/sensors/Accelerometer.html @@ -74,6 +74,10 @@ environment for the Flash Player runtime. If Accelerometer.isSupported is true at runtime, then Accelerometer support currently exists.

    +

    OpenFL target support: This feature is supported on mobile targets, +including iOS and Android, and on the html5 target in browsers that +support the devicemotion event. This feature is not supported on desktop +targets.

    Adobe AIR profile support: This feature is supported only on mobile devices. It is not supported on desktop or AIR for TV devices. See AIR Profile Support @@ -144,4 +148,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/sensors/DeviceRotation.html b/openfl/sensors/DeviceRotation.html index 0d62b12..1996ddd 100644 --- a/openfl/sensors/DeviceRotation.html +++ b/openfl/sensors/DeviceRotation.html @@ -87,4 +87,4 @@ lesser than this value. Any change in the update interval affects all registered listeners. You can use the DeviceRotation class without calling the setRequestedUpdateInterval() method. In this case, the -application receives updates based on the device's default interval.

    \ No newline at end of file +application receives updates based on the device's default interval.

    \ No newline at end of file diff --git a/openfl/sensors/Geolocation.html b/openfl/sensors/Geolocation.html index eb2d841..0c4b6a2 100644 --- a/openfl/sensors/Geolocation.html +++ b/openfl/sensors/Geolocation.html @@ -106,4 +106,4 @@

    Note: First-generation iPhones, which do not include a GPS unit, dispatch update events only occasionally. On these devices, a Geolocation object initially dispatches one or two update events. It -then dispatches update events when information changes noticeably.

    \ No newline at end of file +then dispatches update events when information changes noticeably.

    \ No newline at end of file diff --git a/openfl/sensors/index.html b/openfl/sensors/index.html index 808b0d7..a94ae75 100644 --- a/openfl/sensors/index.html +++ b/openfl/sensors/index.html @@ -96,4 +96,4 @@

    package ::full::

    detect this rotation and return this data. The DeviceRotation class provides methods to query whether or not device rotation event handling is supported, and also to set the rate at which device rotation events are dispatched.

    Geolocation

    The Geolocation class dispatches events in response to the device's location -sensor.

    \ No newline at end of file +sensor.

    \ No newline at end of file diff --git a/openfl/system/ApplicationDomain.html b/openfl/system/ApplicationDomain.html index f690afc..5aa8654 100644 --- a/openfl/system/ApplicationDomain.html +++ b/openfl/system/ApplicationDomain.html @@ -91,4 +91,4 @@ name.

    hasDefinition(name:String):Bool

    Checks to see if a public definition exists within the specified application domain. The definition can be that of a class, a namespace, or a function.

    Parameters:

    name

    The name of the definition.

    Returns:

    A value of true if the specified definition exists; -otherwise, false.

    \ No newline at end of file +otherwise, false.

    \ No newline at end of file diff --git a/openfl/system/Capabilities.html b/openfl/system/Capabilities.html index e6a9424..fbb66e4 100644 --- a/openfl/system/Capabilities.html +++ b/openfl/system/Capabilities.html @@ -177,8 +177,8 @@ language used for all menus, dialog boxes, error messages, and help files. The following table lists the possible values:

    LanguageValue
    Czechcs
    Danishda
    Dutchnl
    Englishen
    Finnishfi
    Frenchfr
    Germande
    Hungarianhu
    Italianit
    Japaneseja
    Koreanko
    Norwegianno
    Other/unknownxu
    Polishpl
    Portuguesept
    Russianru
    Simplified Chinesezh-CN
    Spanishes
    Swedishsv
    Traditional Chinesezh-TW
    Turkishtr

    Note: The value of Capabilities.language property is limited to -the possible values on this list. Because of this limitation, Adobe -AIR applications should use the first element in the +the possible values on this list. Because of this limitation, OpenFL +applications should use the first element in the Capabilities.languages array to determine the primary user interface language for the system.

    The server string is L.

    @:value(false)staticread onlylocalFileReadDisable:Bool = false

    Specifies whether read access to the user's hard disk has been @@ -196,12 +196,12 @@

    Reading runtime shared libraries is also blocked if this property is set to true, but reading local shared objects is allowed without regard to the value of this property.

    -

    The server string is LFD.

    staticread onlymanufacturer:String

    Specifies the manufacturer of the running version of Flash Player or the -AIR runtime, in the format "Adobe -_OSName_". The value for _OSName_ -could be "Windows", "Macintosh", -"Linux", or another operating system name. The server string -is M.

    +

    The server string is LFD.

    staticread onlymanufacturer:String

    Specifies the manufacturer of the running version of OpenFL, in the +format "ManufacturerName OSName". The value for _ManufacturerName_ +is typically "OpenFL". When targeting Adobe Flash Player or AIR, the +value for _ManufacturerName_ is "Adobe". The value for _OSName_ +could be "Windows", "Macintosh", "Linux", or another operating +system name. The server string is M.

    Do not use Capabilities.manufacturer to determine a capability based on the operating system if a more specific capability property exists. Basing a capability on the operating system is a bad @@ -225,25 +225,24 @@ Capabilities class description.

    staticread onlypixelAspectRatio:Float

    Specifies the pixel aspect ratio of the screen. The server string is AR.

    @:value("StandAlone")staticread onlyplayerType:String = "StandAlone"

    Specifies the type of runtime environment. This property can have one of the following values:

    • "ActiveX" for the Flash Player ActiveX control used by -Microsoft Internet Explorer
    • "Desktop" for the Adobe AIR runtime(except for SWF +Microsoft Internet Explorer
    • "Desktop" for the Adobe AIR runtime (except for SWF content loaded by an HTML page, which has Capabilities.playerType set to "PlugIn")
    • "External" for the external Flash Player<ph -outputclass="flashonly"> or in test mode
    • "PlugIn" for the Flash Player browser plug-in(and for +outputclass="flashonly"> or in test mode
    • "PlugIn" for the Flash Player browser plug-in (and for SWF content loaded by an HTML page in an AIR application)
    • "StandAlone" for the stand-alone Flash Player

    The server string is PT.

    @:value("color")staticread onlyscreenColor:String = "color"

    Specifies the screen color. This property can have the value "color", "gray"(for grayscale), or "bw"(for black and white). The server string is COL.

    staticread onlyscreenDPI:Float

    Specifies the dots-per-inch(dpi) resolution of the screen, in pixels. The server string is DP.

    staticread onlyscreenResolutionX:Float

    Specifies the maximum horizontal resolution of the screen. The server -string is R(which returns both the width and height of the -screen). This property does not update with a user's screen resolution and -instead only indicates the resolution at the time Flash Player or an Adobe -AIR application started. Also, the value only specifies the primary -screen.

    staticread onlyscreenResolutionY:Float

    Specifies the maximum vertical resolution of the screen. The server string -is R(which returns both the width and height of the screen). -This property does not update with a user's screen resolution and instead -only indicates the resolution at the time Flash Player or an Adobe AIR -application started. Also, the value only specifies the primary screen.

    @:value("")staticread onlyserverString:String = ""

    A URL-encoded string that specifies values for each Capabilities property.

    +string is R (which returns both the width and height of the screen). +This property does not update with a user's screen resolution and +instead only indicates the resolution at the time the OpenFL application +started. Also, the value only specifies the primary screen.

    staticread onlyscreenResolutionY:Float

    Specifies the maximum vertical resolution of the screen. The server +string is R (which returns both the width and height of the screen). +This property does not update with a user's screen resolution and +instead only indicates the resolution at the time the OpenFL application +started. Also, the value only specifies the primary screen.

    @:value("")staticread onlyserverString:String = ""

    A URL-encoded string that specifies values for each Capabilities property.

    The following example shows a URL-encoded string: A=t&SA=t&SV=t&EV=t&MP3=t&AE=t&VE=t&ACC=f&PR=t&SP=t& SB=f&DEB=t&V=WIN%208%2C5%2C0%2C208&M=Adobe%20Windows& @@ -285,4 +284,4 @@ Then, your application can revert to a different codec.

    The following table shows the server string for each multichannel audio type:

    Multichannel audio typeServer string
    AudioDecoder.DOLBY_DIGITALDD
    AudioDecoder.DOLBY_DIGITAL_PLUSDDP
    AudioDecoder.DTSDTS
    AudioDecoder.DTS_EXPRESSDTE
    AudioDecoder.DTS_HD_HIGH_RESOLUTION_AUDIODTH
    AudioDecoder.DTS_HD_MASTER_AUDIODTM

    Parameters:

    type

    A String value representing a multichannel audio type. The valid values are the constants defined in flash.media.AudioDecoder.

    Returns:

    The Boolean value true if the system supports the multichannel audio -type passed in the type parameter. Otherwise, the return value is false.

    \ No newline at end of file +type passed in the type parameter. Otherwise, the return value is false.

    \ No newline at end of file diff --git a/openfl/system/ImageDecodingPolicy.html b/openfl/system/ImageDecodingPolicy.html index 7f80682..2f79bcb 100644 --- a/openfl/system/ImageDecodingPolicy.html +++ b/openfl/system/ImageDecodingPolicy.html @@ -59,4 +59,4 @@ it will be re-decoded as needed.

    @:value(cast 1)@:impl@:enuminlineread onlyON_LOAD:ImageDecodingPolicy = 1

    Specifies that the image being loaded will be decoded on load, prior to the complete event being sent. The decoded image data is cached, and may be flushed at will by the system. If flushed, it will be re-decoded -as needed.

    \ No newline at end of file +as needed.

    \ No newline at end of file diff --git a/openfl/system/LoaderContext.html b/openfl/system/LoaderContext.html index 21a064c..2d98433 100644 --- a/openfl/system/LoaderContext.html +++ b/openfl/system/LoaderContext.html @@ -138,9 +138,9 @@ cannot control the choice of application domain into which the loaded SWF file is placed; and if you have specified a choice of application domain, it will be ignored. However, if you are loading a SWF file -into your own security domain � either because the SWF file comes +into your own security domain — either because the SWF file comes from your own domain, or because you are importing it into your -security domain � then you can control the choice of application +security domain — then you can control the choice of application domain for the loaded SWF file.

    You can pass an application domain only from your own security domain in LoaderContext.applicationDomain. Attempting to pass an @@ -286,4 +286,4 @@

    Content in the AIR application security sandbox cannot load content from other sandboxes into its SecurityDomain.

    For more information, see the "Security" chapter in the ActionScript -3.0 Developer's Guide.

    \ No newline at end of file +3.0 Developer's Guide.

    \ No newline at end of file diff --git a/openfl/system/Security.html b/openfl/system/Security.html index 00ef956..9bef16c 100644 --- a/openfl/system/Security.html +++ b/openfl/system/Security.html @@ -95,9 +95,9 @@ persistent shared objects from that SWF file after porting it to version 7 or later, or from a different SWF file of version 7 or later, set Security.exactSettings to false before calling -SharedObject.getLocal().

    Throws:

    SecurityError

    A Flash Player or AIR application already used -the value of exactSettings at least once in a -decision about player settings.

    staticread onlysandboxType:String

    Indicates the type of security sandbox in which the calling file is +SharedObject.getLocal().

    Throws:

    SecurityError

    An OpenFL application already used the value of +exactSettings at least once in a decision about +player settings.

    staticread onlysandboxType:String

    Indicates the type of security sandbox in which the calling file is operating. Security.sandboxType has one of the following values:

    Static methods

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })staticallowDomain(?p1:Dynamic, ?p2:Dynamic, ?p3:Dynamic, ?p4:Dynamic, ?p5:Dynamic):Void

    Lets SWF files in the identified domains access objects and variables -in the SWF file that contains the allowDomain() call. -Note: Calling this method from code in the AIR application sandbox +in the SWF file that contains the allowDomain() call.

    +

    Note: Calling this method from code in the AIR application sandbox throws a SecurityError exception. Content outside of the application security domain cannot directly cross-script content in the application sandbox. However, content outside of the application @@ -234,7 +234,7 @@ object that you pass to Loader.load(). For example, if you load a child SWF file into a parent SWF, you can access the contentLoaderInfo property of the Loader object for the parent SWF:

    -
    Security.allowDomain(loader.contentLoaderInfo.url)
    +
    Security.allowDomain(loader.contentLoaderInfo.url)

    Make sure that you wait until the child SWF file begins loading to get the correct value of the url property. To determine when the child SWF has begun loading, use the progress event.

    @@ -399,7 +399,7 @@ request that requires a policy file is made. With Security.loadPolicyFile(), Flash Player or AIR can load policy files from arbitrary locations, as shown in the following example:

    -
    Security.loadPolicyFile("http://www.example.com/sub/dir/pf.xml");
    +
    Security.loadPolicyFile("http://www.example.com/sub/dir/pf.xml");

    This causes Flash Player or AIR to attempt to retrieve a policy file from the specified URL. Any permissions granted by the policy file at that location will apply to all content at the same level or lower in @@ -457,4 +457,4 @@

    For more information related to security, see the Flash Player Developer Center Topic: <a href="http://www.adobe.com/go/devnet_security_en" -scope="external">Security.

    Parameters:

    url

    The URL location of the policy file to be loaded.

    \ No newline at end of file +scope="external">Security.

    Parameters:

    url

    The URL location of the policy file to be loaded.

    \ No newline at end of file diff --git a/openfl/system/SecurityDomain.html b/openfl/system/SecurityDomain.html index 9b0f54f..b307564 100644 --- a/openfl/system/SecurityDomain.html +++ b/openfl/system/SecurityDomain.html @@ -58,4 +58,4 @@

    The SecurityDomain class represents the current security "sandbox," also known as a security domain. By passing an instance of this class to Loader.load(), you can request that loaded media be placed in a -particular sandbox.

    Static variables

    @:value(new SecurityDomain())staticread onlycurrentDomain:SecurityDomain = new SecurityDomain()

    Gets the current security domain.

    \ No newline at end of file +particular sandbox.

    Static variables

    @:value(new SecurityDomain())staticread onlycurrentDomain:SecurityDomain = new SecurityDomain()

    Gets the current security domain.

    \ No newline at end of file diff --git a/openfl/system/System.html b/openfl/system/System.html index 482b665..e63156c 100644 --- a/openfl/system/System.html +++ b/openfl/system/System.html @@ -63,8 +63,8 @@

    This class contains only static methods and properties. You cannot create new instances of the System class.

    Static variables

    staticread onlytotalMemory:Int

    The amount of memory(in bytes) currently in use that has been directly allocated by Flash Player or AIR.

    -

    This property does not return all memory used by an Adobe AIR -application or by the application(such as a browser) containing Flash +

    This property does not return all memory used by an OpenFL +application or by the application (such as a browser) containing Flash Player content. The browser or operating system may consume other memory. The System.privateMemory property reflects all memory used by an application.

    @@ -73,12 +73,12 @@ property is set to 0. The System.totalMemoryNumber property allows larger values.

    @:value(false)staticuseCodePage:Bool = false

    A Boolean value that determines which code page to use to interpret external text files. When the property is set to false, -external text files are interpretted as Unicode.(These files must be +external text files are interpretted as Unicode. (These files must be encoded as Unicode when you save them.) When the property is set to true, external text files are interpretted using the traditional code page of the operating system running the application. The default value of useCodePage is false.

    -

    Text that you load as an external file(using +

    Text that you load as an external file (using Loader.load(), the URLLoader class or URLStream) must have been saved as Unicode in order for the application to recognize it as Unicode. To encode external files as Unicode, save the files in an @@ -109,12 +109,17 @@ the application(Flash Player 6 and later, or AIR) interprets the text as Unicode.

    Static methods

    staticexit(code:Int):Void

    Closes Flash Player.

    For the standalone Flash Player debugger version only.

    -

    AIR applications should call the NativeApplication.exit() -method to exit the application.

    Parameters:

    code

    A value to pass to the operating system. Typically, if the +

    OpenFL applications on desktop operating systems should call the +NativeApplication.exit() method to exit the application. It is not +recommended to manually exit an application on mobile operating systems.

    Parameters:

    code

    A value to pass to the operating system. Typically, if the process exits normally, the value is 0.

    staticgc():Void

    Forces the garbage collection process.

    -

    For the Flash Player debugger version and AIR applications only. -In an AIR application, the System.gc() method is only enabled -in content running in the AIR Debug Launcher(ADL) or, in an installed +

    OpenFL target support: This feature is supported on all desktop +operating systems, on iOS, and on Android. This feature is not supported +on the html5 target.

    +

    For Adobe Flash Player, the System.gc() method is only enabled in +the debugger version of the runtime.

    +

    In an AIR application, the System.gc() method is only enabled +in content running in the AIR Debug Launcher (ADL) or, in an installed application, in content in the application security sandbox.

    staticpause():Void

    Pauses Flash Player or the AIR Debug Launcher(ADL). After calling this method, nothing in the application continues except the delivery of Socket events.

    @@ -126,7 +131,7 @@ event(such as a keyboard or input device event handler).

    This method is provided for SWF content running in Flash Player 9. It allows only adding String content to the Clipboard.

    -

    Flash Player 10 content and content in the application security sandbox -in an AIR application can call the Clipboard.setData() -method.

    Parameters:

    string

    A plain-text string of characters to put on the system -Clipboard, replacing its current contents(if any).

    \ No newline at end of file +

    Flash Player 10 content, content in the application security sandbox +in an AIR application, and Haxe "sys" targets can call the +Clipboard.setData() method.

    Parameters:

    string

    A plain-text string of characters to put on the system +Clipboard, replacing its current contents(if any).

    \ No newline at end of file diff --git a/openfl/system/TouchscreenType.html b/openfl/system/TouchscreenType.html index 0ef6b6d..775cc8f 100644 --- a/openfl/system/TouchscreenType.html +++ b/openfl/system/TouchscreenType.html @@ -58,4 +58,4 @@

    The TouchscreenType class is an enumeration class that provides values for the different types of touch screens. Use the values defined by the TouchscreenType class with the -Capabilities.touchscreenType property.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyFINGER:TouchscreenType = 0

    A touchscreen designed to respond to finger touches.

    @:value(cast 1)@:impl@:enuminlineread onlyNONE:TouchscreenType = 1

    The computer or device does not have a supported touchscreen.

    @:value(cast 2)@:impl@:enuminlineread onlySTYLUS:TouchscreenType = 2

    A touchscreen designed for use with a stylus.

    \ No newline at end of file +Capabilities.touchscreenType property.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyFINGER:TouchscreenType = 0

    A touchscreen designed to respond to finger touches.

    @:value(cast 1)@:impl@:enuminlineread onlyNONE:TouchscreenType = 1

    The computer or device does not have a supported touchscreen.

    @:value(cast 2)@:impl@:enuminlineread onlySTYLUS:TouchscreenType = 2

    A touchscreen designed for use with a stylus.

    \ No newline at end of file diff --git a/openfl/system/index.html b/openfl/system/index.html index b68d1a0..b2b1881 100644 --- a/openfl/system/index.html +++ b/openfl/system/index.html @@ -122,4 +122,4 @@

    package ::full::

    with shared objects and the use of the Clipboard.

    TouchscreenType

    The TouchscreenType class is an enumeration class that provides values for the different types of touch screens. Use the values defined by the TouchscreenType class with the -Capabilities.touchscreenType property.

    \ No newline at end of file +Capabilities.touchscreenType property.

    \ No newline at end of file diff --git a/openfl/text/AntiAliasType.html b/openfl/text/AntiAliasType.html index 952244f..a7e516e 100644 --- a/openfl/text/AntiAliasType.html +++ b/openfl/text/AntiAliasType.html @@ -64,4 +64,4 @@ earlier. This setting is recommended for applications that do not have a lot of text. This constant is used for the antiAliasType property in the TextField class. Use the syntax -AntiAliasType.NORMAL.

    \ No newline at end of file +AntiAliasType.NORMAL.

    \ No newline at end of file diff --git a/openfl/text/AutoCapitalize.html b/openfl/text/AutoCapitalize.html index 55fcba3..2cf2882 100644 --- a/openfl/text/AutoCapitalize.html +++ b/openfl/text/AutoCapitalize.html @@ -54,4 +54,4 @@ margin: 5px 0 0 4px; }

    The AutoCapitalize class defines constants for the autoCapitalize property -of the StageText class.

    See also:

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyALL:AutoCapitalize = 0

    Capitalize every character.

    @:value(cast 1)@:impl@:enuminlineread onlyNONE:AutoCapitalize = 1

    No automatic capitalization.

    @:value(cast 2)@:impl@:enuminlineread onlySENTENCE:AutoCapitalize = 2

    Capitalize the first word of every sentence.

    @:value(cast 3)@:impl@:enuminlineread onlyWORD:AutoCapitalize = 3

    Capitalize every word.

    \ No newline at end of file +of the StageText class.

    See also:

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyALL:AutoCapitalize = 0

    Capitalize every character.

    @:value(cast 1)@:impl@:enuminlineread onlyNONE:AutoCapitalize = 1

    No automatic capitalization.

    @:value(cast 2)@:impl@:enuminlineread onlySENTENCE:AutoCapitalize = 2

    Capitalize the first word of every sentence.

    @:value(cast 3)@:impl@:enuminlineread onlyWORD:AutoCapitalize = 3

    Capitalize every word.

    \ No newline at end of file diff --git a/openfl/text/Font.html b/openfl/text/Font.html index d015c4c..6b79683 100644 --- a/openfl/text/Font.html +++ b/openfl/text/Font.html @@ -85,4 +85,4 @@ Progress, completion and error callbacks will be dispatched in the current thread using callbacks attached to a returned Future object.

    Parameters:

    path

    A font name

    Returns:

    A Future Font

    staticregisterFont(font:Dynamic):Void

    Registers a font in the global font list.

    Constructor

    @:value({ name : null })new(?name:String)

    Variables

    fontName:String

    The name of an embedded font.

    fontStyle:FontStyle

    The style of the font. This value can be any of the values defined in the FontStyle class.

    fontType:FontType

    The type of the font. This value can be any of the constants defined in -the FontType class.

    \ No newline at end of file +the FontType class.

    \ No newline at end of file diff --git a/openfl/text/FontStyle.html b/openfl/text/FontStyle.html index 4f9ae9b..075d777 100644 --- a/openfl/text/FontStyle.html +++ b/openfl/text/FontStyle.html @@ -60,4 +60,4 @@ parameter in the setAdvancedAntiAliasingTable() method. Use the syntax FontStyle.ITALIC.

    @:value(cast 3)@:impl@:enuminlineread onlyREGULAR:FontStyle = 3

    Defines the plain style of a font for the fontStyle parameter in the setAdvancedAntiAliasingTable() method. Use the syntax -FontStyle.REGULAR.

    \ No newline at end of file +FontStyle.REGULAR.

    \ No newline at end of file diff --git a/openfl/text/FontType.html b/openfl/text/FontType.html index a950891..69af28c 100644 --- a/openfl/text/FontType.html +++ b/openfl/text/FontType.html @@ -89,4 +89,4 @@ However, embedded CFF fonts are typically 20% to 30% smaller than regular embedded fonts.

    Fonts of type EMBEDDED_CFF can only be used by the flash.text.engine classes. A -TextField directed to use such a font will fail to render.

    \ No newline at end of file +TextField directed to use such a font will fail to render.

    \ No newline at end of file diff --git a/openfl/text/GridFitType.html b/openfl/text/GridFitType.html index 3994753..886dfee 100644 --- a/openfl/text/GridFitType.html +++ b/openfl/text/GridFitType.html @@ -69,4 +69,4 @@ dynamic text, and it is sometimes a useful tradeoff for animation vs. text quality. This constant is used in setting the gridFitType property of the TextField class. Use the syntax -GridFitType.SUBPIXEL.

    \ No newline at end of file +GridFitType.SUBPIXEL.

    \ No newline at end of file diff --git a/openfl/text/ReturnKeyLabel.html b/openfl/text/ReturnKeyLabel.html index c4e3729..0ad13f3 100644 --- a/openfl/text/ReturnKeyLabel.html +++ b/openfl/text/ReturnKeyLabel.html @@ -54,4 +54,4 @@ margin: 5px 0 0 4px; }

    The ReturnKeyLabel class defines the values to use for the returnKeyLabel -property of the StageText class.

    See also:

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyDEFAULT:ReturnKeyLabel = 0

    Use the default label.

    @:value(cast 1)@:impl@:enuminlineread onlyDONE:ReturnKeyLabel = 1

    Use the label, "Done".

    @:value(cast 2)@:impl@:enuminlineread onlyGO:ReturnKeyLabel = 2

    Use the label, "Go".

    @:value(cast 3)@:impl@:enuminlineread onlyNEXT:ReturnKeyLabel = 3

    Use the label, "Next".

    @:value(cast 4)@:impl@:enuminlineread onlySEARCH:ReturnKeyLabel = 4

    Use the label, "Search".

    \ No newline at end of file +property of the StageText class.

    See also:

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyDEFAULT:ReturnKeyLabel = 0

    Use the default label.

    @:value(cast 1)@:impl@:enuminlineread onlyDONE:ReturnKeyLabel = 1

    Use the label, "Done".

    @:value(cast 2)@:impl@:enuminlineread onlyGO:ReturnKeyLabel = 2

    Use the label, "Go".

    @:value(cast 3)@:impl@:enuminlineread onlyNEXT:ReturnKeyLabel = 3

    Use the label, "Next".

    @:value(cast 4)@:impl@:enuminlineread onlySEARCH:ReturnKeyLabel = 4

    Use the label, "Search".

    \ No newline at end of file diff --git a/openfl/text/SoftKeyboardType.html b/openfl/text/SoftKeyboardType.html index da6aa25..b78b9d8 100644 --- a/openfl/text/SoftKeyboardType.html +++ b/openfl/text/SoftKeyboardType.html @@ -62,4 +62,4 @@ 0 through 9 prominently. This keyboard type does not support auto-capitalization.

    @:value(cast 5)@:impl@:enuminlineread onlyPHONE:SoftKeyboardType = 5

    A keyboard optimized for entering phone numbers. This type features the numbers along with "+"," and "#" characters prominently.

    @:value(cast 6)@:impl@:enuminlineread onlyPUNCTUATION:SoftKeyboardType = 6

    A keyboard optimized for entering punctuation.

    @:value(cast 7)@:impl@:enuminlineread onlyURL:SoftKeyboardType = 7

    A keyboard optimized for entering URLs. This type features ".", "/", -and ".com" prominently.

    \ No newline at end of file +and ".com" prominently.

    \ No newline at end of file diff --git a/openfl/text/StageText.html b/openfl/text/StageText.html index e984007..62a7258 100644 --- a/openfl/text/StageText.html +++ b/openfl/text/StageText.html @@ -67,7 +67,7 @@ the text input fields instead of the player, you cannot use embedded fonts.

    OpenFL target support: On all platforms, except AIR, StageText uses the -runtime TextField.

    +runtime TextField fallback.

    Adobe AIR profile support: This feature is supported on iOS and Android platforms. StageText uses native text input fields on Android and iOS mobile devices. On other platforms, StageText uses the Flash Runtime TextField.

    @@ -346,4 +346,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/text/StageTextClearButtonMode.html b/openfl/text/StageTextClearButtonMode.html index ba2d3ce..bea61f6 100644 --- a/openfl/text/StageTextClearButtonMode.html +++ b/openfl/text/StageTextClearButtonMode.html @@ -54,4 +54,4 @@ margin: 5px 0 0 4px; }

    The StageTextClearButtonMode class defines the values to use for the -clearButtonMode property of the StageText class.

    See also:

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyALWAYS:StageTextClearButtonMode = 0

    The StageText clear button is always shown.

    @:value(cast 1)@:impl@:enuminlineread onlyNEVER:StageTextClearButtonMode = 1

    The StageText clear button is never shown.

    @:value(cast 2)@:impl@:enuminlineread onlyUNLESS_EDITING:StageTextClearButtonMode = 2

    The StageText clear button is not visible while editing.

    @:value(cast 3)@:impl@:enuminlineread onlyWHILE_EDITING:StageTextClearButtonMode = 3

    The StageText clear button is visible while editing.

    \ No newline at end of file +clearButtonMode property of the StageText class.

    See also:

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyALWAYS:StageTextClearButtonMode = 0

    The StageText clear button is always shown.

    @:value(cast 1)@:impl@:enuminlineread onlyNEVER:StageTextClearButtonMode = 1

    The StageText clear button is never shown.

    @:value(cast 2)@:impl@:enuminlineread onlyUNLESS_EDITING:StageTextClearButtonMode = 2

    The StageText clear button is not visible while editing.

    @:value(cast 3)@:impl@:enuminlineread onlyWHILE_EDITING:StageTextClearButtonMode = 3

    The StageText clear button is visible while editing.

    \ No newline at end of file diff --git a/openfl/text/StageTextInitOptions.html b/openfl/text/StageTextInitOptions.html index f2b0b7a..51dde19 100644 --- a/openfl/text/StageTextInitOptions.html +++ b/openfl/text/StageTextInitOptions.html @@ -52,4 +52,4 @@ .navbar .container img { margin: 5px 0 0 4px; } -

    The StageTextInitOptions class defines the options available for initializing a StageText object.

    See also:

    • openfl.text.StageText

    Constructor

    @:value({ multiline : false })new(multiline:Bool = false)

    Creates a StageTextInitOptions object.

    Variables

    multiline:Bool

    Specifies whether the StageText object displays multiple lines of text.

    \ No newline at end of file +

    The StageTextInitOptions class defines the options available for initializing a StageText object.

    See also:

    • openfl.text.StageText

    Constructor

    @:value({ multiline : false })new(multiline:Bool = false)

    Creates a StageTextInitOptions object.

    Variables

    multiline:Bool

    Specifies whether the StageText object displays multiple lines of text.

    \ No newline at end of file diff --git a/openfl/text/StaticText.html b/openfl/text/StaticText.html index 1898dcd..4fc2832 100644 --- a/openfl/text/StaticText.html +++ b/openfl/text/StaticText.html @@ -372,7 +372,7 @@ property of the scrollRect Rectangle object. You can scroll an object up and down by setting the y property of the scrollRect Rectangle object. If the display object is rotated -90� and you scroll it left and right, the display object actually scrolls +90° and you scroll it left and right, the display object actually scrolls up and down.

    @:betashader:Shader

    BETA**

    Applies a custom Shader object to use when rendering this display object (or its children) when using hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to @@ -424,16 +424,16 @@ to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

    Inherited Methods

    Defined by DisplayObject

    getBounds(targetCoordinateSpace:DisplayObject):Rectangle

    Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object. Consider the following code, which shows how the rectangle returned can @@ -520,4 +520,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/text/StyleSheet.html b/openfl/text/StyleSheet.html index f980d13..288b501 100644 --- a/openfl/text/StyleSheet.html +++ b/openfl/text/StyleSheet.html @@ -207,4 +207,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/text/TextField.html b/openfl/text/TextField.html index 826a2f6..e69955f 100644 --- a/openfl/text/TextField.html +++ b/openfl/text/TextField.html @@ -839,7 +839,7 @@ property of the scrollRect Rectangle object. You can scroll an object up and down by setting the y property of the scrollRect Rectangle object. If the display object is rotated -90� and you scroll it left and right, the display object actually scrolls +90° and you scroll it left and right, the display object actually scrolls up and down.

    @:betashader:Shader

    BETA**

    Applies a custom Shader object to use when rendering this display object (or its children) when using hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to @@ -891,16 +891,16 @@ to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. -Thus, for a DisplayObjectContainer rotated 90� counterclockwise, the +Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is -rotated 90� counterclockwise. The object's coordinates refer to the +rotated 90° counterclockwise. The object's coordinates refer to the registration point position.

    Inherited Methods

    Defined by InteractiveObject

    requestSoftKeyboard():Bool

    Raises a virtual keyboard.

    Calling this method focuses the InteractiveObject instance and raises the soft keyboard, if necessary. The needsSoftKeyboard must @@ -996,4 +996,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/text/TextFieldAutoSize.html b/openfl/text/TextFieldAutoSize.html index 810cce1..044fda7 100644 --- a/openfl/text/TextFieldAutoSize.html +++ b/openfl/text/TextFieldAutoSize.html @@ -60,4 +60,4 @@ that the left side of the text field remains fixed and any resizing of a single line is on the right side.

    @:value(cast 2)@:impl@:enuminlineread onlyNONE:TextFieldAutoSize = 2

    Specifies that no resizing is to occur.

    @:value(cast 3)@:impl@:enuminlineread onlyRIGHT:TextFieldAutoSize = 3

    Specifies that the text is to be treated as right-justified text, meaning that the right side of the text field remains fixed and any resizing of a -single line is on the left side.

    \ No newline at end of file +single line is on the left side.

    \ No newline at end of file diff --git a/openfl/text/TextFieldType.html b/openfl/text/TextFieldType.html index c0d0008..27dca7c 100644 --- a/openfl/text/TextFieldType.html +++ b/openfl/text/TextFieldType.html @@ -54,4 +54,4 @@ margin: 5px 0 0 4px; }

    The TextFieldType class is an enumeration of constant values used in -setting the type property of the TextField class.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyDYNAMIC:TextFieldType = 0

    Used to specify a dynamic TextField.

    @:value(cast 1)@:impl@:enuminlineread onlyINPUT:TextFieldType = 1

    Used to specify an input TextField.

    \ No newline at end of file +setting the type property of the TextField class.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyDYNAMIC:TextFieldType = 0

    Used to specify a dynamic TextField.

    @:value(cast 1)@:impl@:enuminlineread onlyINPUT:TextFieldType = 1

    Used to specify an input TextField.

    \ No newline at end of file diff --git a/openfl/text/TextFormat.html b/openfl/text/TextFormat.html index 20fa31f..8964c5b 100644 --- a/openfl/text/TextFormat.html +++ b/openfl/text/TextFormat.html @@ -158,4 +158,4 @@ hyperlink. The default value is null, which indicates that the text does not have a hyperlink.

    Note: The text with the assigned text format must be set with -the htmlText property for the hyperlink to work.

    \ No newline at end of file +the htmlText property for the hyperlink to work.

    \ No newline at end of file diff --git a/openfl/text/TextFormatAlign.html b/openfl/text/TextFormatAlign.html index 10780ff..6402d38 100644 --- a/openfl/text/TextFormatAlign.html +++ b/openfl/text/TextFormatAlign.html @@ -62,4 +62,4 @@ TextFormatAlign.LEFT.

    @:value(cast 4)@:impl@:enuminlineread onlyRIGHT:TextFormatAlign = 4

    Constant; aligns text to the right within the text field. Use the syntax TextFormatAlign.RIGHT.

    @:value(cast 5)@:impl@:enuminlineread onlySTART:TextFormatAlign = 5

    Constant; aligns text to the start edge of a line. Same as left for left-to-right languages and same as right for right-to-left languages.

    -

    The START constant may only be used with the StageText class.

    \ No newline at end of file +

    The START constant may only be used with the StageText class.

    \ No newline at end of file diff --git a/openfl/text/TextLineMetrics.html b/openfl/text/TextLineMetrics.html index ac4f7cf..4db12bf 100644 --- a/openfl/text/TextLineMetrics.html +++ b/openfl/text/TextLineMetrics.html @@ -91,4 +91,4 @@ pixels (2 pixels on each side). See the "Text Line width" measurement in the overview diagram for this class.

    x:Float

    The x value is the left position of the first character in pixels. This value includes the margin, indent (if any), and gutter widths. -See the "Text Line x-position" in the overview diagram for this class.

    \ No newline at end of file +See the "Text Line x-position" in the overview diagram for this class.

    \ No newline at end of file diff --git a/openfl/text/engine/FontPosture.html b/openfl/text/engine/FontPosture.html index 32a441b..9c811ec 100644 --- a/openfl/text/engine/FontPosture.html +++ b/openfl/text/engine/FontPosture.html @@ -56,4 +56,4 @@ }

    The FontPosture class is an enumeration of constant values used with FontDescription.fontPosture and StageText.fontPostures to set text to -italic or normal.

    See also:

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyITALIC:FontPosture = 0

    Used to indicate italic font posture.

    @:value(cast 1)@:impl@:enuminlineread onlyNORMAL:FontPosture = 1

    Used to indicate normal font posture.

    \ No newline at end of file +italic or normal.

    See also:

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyITALIC:FontPosture = 0

    Used to indicate italic font posture.

    @:value(cast 1)@:impl@:enuminlineread onlyNORMAL:FontPosture = 1

    Used to indicate normal font posture.

    \ No newline at end of file diff --git a/openfl/text/engine/FontWeight.html b/openfl/text/engine/FontWeight.html index a968a55..82cc2f0 100644 --- a/openfl/text/engine/FontWeight.html +++ b/openfl/text/engine/FontWeight.html @@ -56,4 +56,4 @@ }

    The FontWeight class is an enumeration of constant values used with FontDescription.fontWeight and StageText.fontWeight to set text to bold -or normal.

    See also:

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyBOLD:FontWeight = 0

    Used to indicate bold font weight.

    @:value(cast 1)@:impl@:enuminlineread onlyNORMAL:FontWeight = 1

    Used to indicate normal font weight.

    \ No newline at end of file +or normal.

    See also:

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyBOLD:FontWeight = 0

    Used to indicate bold font weight.

    @:value(cast 1)@:impl@:enuminlineread onlyNORMAL:FontWeight = 1

    Used to indicate normal font weight.

    \ No newline at end of file diff --git a/openfl/text/engine/index.html b/openfl/text/engine/index.html index 1f31f0c..41884e6 100644 --- a/openfl/text/engine/index.html +++ b/openfl/text/engine/index.html @@ -89,4 +89,4 @@

    package ::full::

    FontDescription.fontPosture and StageText.fontPostures to set text to italic or normal.

    FontWeight

    The FontWeight class is an enumeration of constant values used with FontDescription.fontWeight and StageText.fontWeight to set text to bold -or normal.

    \ No newline at end of file +or normal.

    \ No newline at end of file diff --git a/openfl/text/index.html b/openfl/text/index.html index dd1fcb8..369885b 100644 --- a/openfl/text/index.html +++ b/openfl/text/index.html @@ -136,4 +136,4 @@

    package ::full::

    openfl.text.TextField.getLineMetrics() method. For measurements related to the text field containing the line of text (for example, the "Text Field height" measurement in the diagram), see -openfl.text.TextField.

    \ No newline at end of file +openfl.text.TextField.

    \ No newline at end of file diff --git a/openfl/ui/GameInput.html b/openfl/ui/GameInput.html index c68ca43..d67d36c 100644 --- a/openfl/ui/GameInput.html +++ b/openfl/ui/GameInput.html @@ -128,4 +128,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/ui/GameInputControl.html b/openfl/ui/GameInputControl.html index d6b0d01..27f5e4c 100644 --- a/openfl/ui/GameInputControl.html +++ b/openfl/ui/GameInputControl.html @@ -173,4 +173,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/ui/GameInputDevice.html b/openfl/ui/GameInputDevice.html index 12e510f..0ec5446 100644 --- a/openfl/ui/GameInputDevice.html +++ b/openfl/ui/GameInputDevice.html @@ -56,4 +56,4 @@ If startCachingSamples returns samples that require more memory than you specify, it throws a memory error.

    Variables

    enabled:Bool

    Enables or disables this device.

    read onlyid:String

    Returns the ID of this device.

    read onlyname:String

    Returns the name of this device.

    read onlynumControls:Int

    Returns the number of controls on this device.

    sampleInterval:Int

    Specifies the rate (in milliseconds) at which to retrieve control values.

    Methods

    @:value({ append : false })getCachedSamples(data:ByteArray, append:Bool = false):Int

    Writes cached sample values to the ByteArray. @return

    Parameters:

    data
    append

    getControlAt(i:Int):GameInputControl

    Retrieves a specific control from a device. -@return

    Parameters:

    i

    startCachingSamples(numSamples:Int, controls:Vector<String>):Void

    Requests this device to start keeping a cache of sampled values.

    Parameters:

    numSamples
    null

    controls

    stopCachingSamples():Void

    Stops sample caching.

    \ No newline at end of file +@return

    Parameters:

    i

    startCachingSamples(numSamples:Int, controls:Vector<String>):Void

    Requests this device to start keeping a cache of sampled values.

    Parameters:

    numSamples
    null

    controls

    stopCachingSamples():Void

    Stops sample caching.

    \ No newline at end of file diff --git a/openfl/ui/KeyLocation.html b/openfl/ui/KeyLocation.html index ca9c9df..51fef53 100644 --- a/openfl/ui/KeyLocation.html +++ b/openfl/ui/KeyLocation.html @@ -67,4 +67,4 @@ Shift key on a PC 101 Key US keyboard.

    @:value(cast 0)@:impl@:enuminlineread onlySTANDARD:KeyLocation = 0

    Indicates the key activation is not distinguished as the left or right version of the key, and did not originate on the numeric keypad (or did not originate with a virtual key corresponding to the numeric -keypad). Example: The Q key on a PC 101 Key US keyboard.

    \ No newline at end of file +keypad). Example: The Q key on a PC 101 Key US keyboard.

    \ No newline at end of file diff --git a/openfl/ui/Keyboard.html b/openfl/ui/Keyboard.html index 33386e5..c0b1208 100644 --- a/openfl/ui/Keyboard.html +++ b/openfl/ui/Keyboard.html @@ -86,4 +86,4 @@ domain from accessing a keystroke generated from a SWF file in another domain.

    Returns:

    The value true if the last key pressed can be accessed. If access is not permitted, this method returns -false.

    \ No newline at end of file +false.

    \ No newline at end of file diff --git a/openfl/ui/Mouse.html b/openfl/ui/Mouse.html index 16885db..681e3b9 100644 --- a/openfl/ui/Mouse.html +++ b/openfl/ui/Mouse.html @@ -82,4 +82,4 @@ Mouse.show().

    staticshow():Void

    Displays the pointer. The pointer is visible by default.

    Note: You need to call Mouse.show() only once, regardless of the number of previous calls to -Mouse.hide().

    \ No newline at end of file +Mouse.hide().

    \ No newline at end of file diff --git a/openfl/ui/MouseCursor.html b/openfl/ui/MouseCursor.html index 7b67fb1..baf47eb 100644 --- a/openfl/ui/MouseCursor.html +++ b/openfl/ui/MouseCursor.html @@ -55,4 +55,4 @@ }

    The MouseCursor class is an enumeration of constant values used in setting the cursor property of the Mouse class.

    Variables

    @:value(cast "arrow")@:impl@:enuminlineread onlyARROW:MouseCursor = "arrow"

    Used to specify that the arrow cursor should be used.

    @:value(cast "auto")@:impl@:enuminlineread onlyAUTO:MouseCursor = "auto"

    Used to specify that the cursor should be selected automatically based -on the object under the mouse.

    @:value(cast "button")@:impl@:enuminlineread onlyBUTTON:MouseCursor = "button"

    Used to specify that the button pressing hand cursor should be used.

    @:value(cast "hand")@:impl@:enuminlineread onlyHAND:MouseCursor = "hand"

    Used to specify that the dragging hand cursor should be used.

    @:value(cast "ibeam")@:impl@:enuminlineread onlyIBEAM:MouseCursor = "ibeam"

    Used to specify that the I-beam cursor should be used.

    \ No newline at end of file +on the object under the mouse.

    @:value(cast "button")@:impl@:enuminlineread onlyBUTTON:MouseCursor = "button"

    Used to specify that the button pressing hand cursor should be used.

    @:value(cast "hand")@:impl@:enuminlineread onlyHAND:MouseCursor = "hand"

    Used to specify that the dragging hand cursor should be used.

    @:value(cast "ibeam")@:impl@:enuminlineread onlyIBEAM:MouseCursor = "ibeam"

    Used to specify that the I-beam cursor should be used.

    \ No newline at end of file diff --git a/openfl/ui/Multitouch.html b/openfl/ui/Multitouch.html index ee3eb18..193a5d5 100644 --- a/openfl/ui/Multitouch.html +++ b/openfl/ui/Multitouch.html @@ -116,4 +116,4 @@ true. Multitouch.supportsGestureEvent returns true even if the hardware does not support gesture events.

    staticread onlysupportsTouchEvents:Bool

    Indicates whether the current environment supports basic touch input, such -as a single finger tap. Touch events are listed in the TouchEvent class.

    \ No newline at end of file +as a single finger tap. Touch events are listed in the TouchEvent class.

    \ No newline at end of file diff --git a/openfl/ui/MultitouchInputMode.html b/openfl/ui/MultitouchInputMode.html index f9ef143..b7315f0 100644 --- a/openfl/ui/MultitouchInputMode.html +++ b/openfl/ui/MultitouchInputMode.html @@ -63,4 +63,4 @@ supported by the current environment, and other touch events(such as a simple tap) are interpreted as mouse events.

    @:value(cast 1)@:impl@:enuminlineread onlyNONE:MultitouchInputMode = 1

    Specifies that all user contact with a touch-enabled device is interpreted as a type of mouse event.

    @:value(cast 2)@:impl@:enuminlineread onlyTOUCH_POINT:MultitouchInputMode = 2

    Specifies that all user contact with a touch-enabled device is interpreted -as a type of mouse event.

    \ No newline at end of file +as a type of mouse event.

    \ No newline at end of file diff --git a/openfl/ui/index.html b/openfl/ui/index.html index e00b09e..302a7c6 100644 --- a/openfl/ui/index.html +++ b/openfl/ui/index.html @@ -116,4 +116,4 @@

    package ::full::

    events includes the following classes:

    MultitouchInputMode

    The MultitouchInputMode class provides values for the inputMode property in the openfl.ui.Multitouch class. These values set the type of touch events the Flash runtime dispatches when the -user interacts with a touch-enabled device.

    \ No newline at end of file +user interacts with a touch-enabled device.

    \ No newline at end of file diff --git a/openfl/utils/AGALMiniAssembler.html b/openfl/utils/AGALMiniAssembler.html index 00fb369..088264f 100644 --- a/openfl/utils/AGALMiniAssembler.html +++ b/openfl/utils/AGALMiniAssembler.html @@ -52,4 +52,4 @@ .navbar .container img { margin: 5px 0 0 4px; } -

    Constructor

    @:value({ debugging : false })new(debugging:Bool = false)

    Variables

    read onlyerror:String

    verbose:Bool

    Methods

    @:value({ ignoreLimits : false, version : 1 })assemble(mode:String, source:String, version:Int = 1, ignoreLimits:Bool = false):ByteArray

    assemble2(context3D:Context3D, version:Int, vertexSource:String, fragmentSource:String):Program3D

    \ No newline at end of file +

    Constructor

    @:value({ debugging : false })new(debugging:Bool = false)

    Variables

    read onlyerror:String

    verbose:Bool

    Methods

    @:value({ ignoreLimits : false, version : 1 })assemble(mode:String, source:String, version:Int = 1, ignoreLimits:Bool = false):ByteArray

    assemble2(context3D:Context3D, version:Int, vertexSource:String, fragmentSource:String):Program3D

    \ No newline at end of file diff --git a/openfl/utils/AssetBundle.html b/openfl/utils/AssetBundle.html index 70f3452..e1808cd 100644 --- a/openfl/utils/AssetBundle.html +++ b/openfl/utils/AssetBundle.html @@ -52,4 +52,4 @@ .navbar .container img { margin: 5px 0 0 4px; } -

    Alias

    alias for AssetBundle
    \ No newline at end of file +

    Alias

    alias for AssetBundle
    \ No newline at end of file diff --git a/openfl/utils/AssetCache.html b/openfl/utils/AssetCache.html index d4067a5..b97a4bc 100644 --- a/openfl/utils/AssetCache.html +++ b/openfl/utils/AssetCache.html @@ -65,4 +65,4 @@ Assets.setBitmapData("assets/image2", image2); Assets.clear("assets"); // will clear image2 -Assets.clear("image"); // will clear image1

    Parameters:

    prefix

    A ID prefix

    getBitmapData(id:String):BitmapData

    Retrieves a cached BitmapData.

    Parameters:

    id

    The ID of the cached BitmapData

    Returns:

    The cached BitmapData instance

    getFont(id:String):Font

    Retrieves a cached Font.

    Parameters:

    id

    The ID of the cached Font

    Returns:

    The cached Font instance

    getSound(id:String):Sound

    Retrieves a cached Sound.

    Parameters:

    id

    The ID of the cached Sound

    Returns:

    The cached Sound instance

    hasBitmapData(id:String):Bool

    Checks whether a BitmapData asset is cached.

    Parameters:

    id

    The ID of a BitmapData asset

    Returns:

    Whether the object has been cached

    hasFont(id:String):Bool

    Checks whether a Font asset is cached.

    Parameters:

    id

    The ID of a Font asset

    Returns:

    Whether the object has been cached

    hasSound(id:String):Bool

    Checks whether a Sound asset is cached.

    Parameters:

    id

    The ID of a Sound asset

    Returns:

    Whether the object has been cached

    removeBitmapData(id:String):Bool

    Removes a BitmapData from the cache.

    Parameters:

    id

    The ID of a BitmapData asset

    Returns:

    true if the asset was removed, false if it was not in the cache

    removeFont(id:String):Bool

    Removes a Font from the cache.

    Parameters:

    id

    The ID of a Font asset

    Returns:

    true if the asset was removed, false if it was not in the cache

    removeSound(id:String):Bool

    Removes a Sound from the cache.

    Parameters:

    id

    The ID of a Sound asset

    Returns:

    true if the asset was removed, false if it was not in the cache

    setBitmapData(id:String, bitmapData:BitmapData):Void

    Adds or replaces a BitmapData asset in the cache.

    Parameters:

    id

    The ID of a BitmapData asset

    bitmapData

    The matching BitmapData instance

    setFont(id:String, font:Font):Void

    Adds or replaces a Font asset in the cache.

    Parameters:

    id

    The ID of a Font asset

    bitmapData

    The matching Font instance

    setSound(id:String, sound:Sound):Void

    Adds or replaces a Sound asset in the cache.

    Parameters:

    id

    The ID of a Sound asset

    bitmapData

    The matching Sound instance

    \ No newline at end of file +Assets.clear("image"); // will clear image1

    Parameters:

    prefix

    A ID prefix

    getBitmapData(id:String):BitmapData

    Retrieves a cached BitmapData.

    Parameters:

    id

    The ID of the cached BitmapData

    Returns:

    The cached BitmapData instance

    getFont(id:String):Font

    Retrieves a cached Font.

    Parameters:

    id

    The ID of the cached Font

    Returns:

    The cached Font instance

    getSound(id:String):Sound

    Retrieves a cached Sound.

    Parameters:

    id

    The ID of the cached Sound

    Returns:

    The cached Sound instance

    hasBitmapData(id:String):Bool

    Checks whether a BitmapData asset is cached.

    Parameters:

    id

    The ID of a BitmapData asset

    Returns:

    Whether the object has been cached

    hasFont(id:String):Bool

    Checks whether a Font asset is cached.

    Parameters:

    id

    The ID of a Font asset

    Returns:

    Whether the object has been cached

    hasSound(id:String):Bool

    Checks whether a Sound asset is cached.

    Parameters:

    id

    The ID of a Sound asset

    Returns:

    Whether the object has been cached

    removeBitmapData(id:String):Bool

    Removes a BitmapData from the cache.

    Parameters:

    id

    The ID of a BitmapData asset

    Returns:

    true if the asset was removed, false if it was not in the cache

    removeFont(id:String):Bool

    Removes a Font from the cache.

    Parameters:

    id

    The ID of a Font asset

    Returns:

    true if the asset was removed, false if it was not in the cache

    removeSound(id:String):Bool

    Removes a Sound from the cache.

    Parameters:

    id

    The ID of a Sound asset

    Returns:

    true if the asset was removed, false if it was not in the cache

    setBitmapData(id:String, bitmapData:BitmapData):Void

    Adds or replaces a BitmapData asset in the cache.

    Parameters:

    id

    The ID of a BitmapData asset

    bitmapData

    The matching BitmapData instance

    setFont(id:String, font:Font):Void

    Adds or replaces a Font asset in the cache.

    Parameters:

    id

    The ID of a Font asset

    bitmapData

    The matching Font instance

    setSound(id:String, sound:Sound):Void

    Adds or replaces a Sound asset in the cache.

    Parameters:

    id

    The ID of a Sound asset

    bitmapData

    The matching Sound instance

    \ No newline at end of file diff --git a/openfl/utils/AssetLibrary.html b/openfl/utils/AssetLibrary.html index 3fcd3fd..1bb8f3e 100644 --- a/openfl/utils/AssetLibrary.html +++ b/openfl/utils/AssetLibrary.html @@ -52,4 +52,4 @@ .navbar .container img { margin: 5px 0 0 4px; } -

    Static methods

    @:value({ rootPath : null })staticfromBytes(bytes:ByteArray, ?rootPath:String):AssetLibrary

    @:value({ rootPath : null })staticfromFile(path:String, ?rootPath:String):AssetLibrary

    staticfromManifest(manifest:AssetManifest):AssetLibrary

    @:value({ rootPath : null })staticloadFromBytes(bytes:ByteArray, ?rootPath:String):Future<AssetLibrary>

    @:value({ rootPath : null })staticloadFromFile(path:String, ?rootPath:String):Future<AssetLibrary>

    staticloadFromManifest(manifest:AssetManifest):Future<AssetLibrary>

    Constructor

    new()

    Methods

    @:value({ instance : null })bind(className:String, ?instance:Dynamic):Bool

    \ No newline at end of file +

    Static methods

    @:value({ rootPath : null })staticfromBytes(bytes:ByteArray, ?rootPath:String):AssetLibrary

    @:value({ rootPath : null })staticfromFile(path:String, ?rootPath:String):AssetLibrary

    staticfromManifest(manifest:AssetManifest):AssetLibrary

    @:value({ rootPath : null })staticloadFromBytes(bytes:ByteArray, ?rootPath:String):Future<AssetLibrary>

    @:value({ rootPath : null })staticloadFromFile(path:String, ?rootPath:String):Future<AssetLibrary>

    staticloadFromManifest(manifest:AssetManifest):Future<AssetLibrary>

    Constructor

    new()

    Methods

    @:value({ instance : null })bind(className:String, ?instance:Dynamic):Bool

    \ No newline at end of file diff --git a/openfl/utils/AssetManifest.html b/openfl/utils/AssetManifest.html index ff5ef80..f484b03 100644 --- a/openfl/utils/AssetManifest.html +++ b/openfl/utils/AssetManifest.html @@ -52,4 +52,4 @@ .navbar .container img { margin: 5px 0 0 4px; } -

    Static methods

    @:value({ rootPath : null })staticfromBytes(bytes:Bytes, ?rootPath:String):AssetManifest

    @:value({ rootPath : null })staticfromFile(path:String, ?rootPath:String):AssetManifest

    @:value({ rootPath : null })staticloadFromBytes(bytes:Bytes, ?rootPath:String):Future<AssetManifest>

    @:value({ rootPath : null })staticloadFromFile(path:String, ?rootPath:String):Future<AssetManifest>

    @:value({ rootPath : null })staticparse(data:String, ?rootPath:String):AssetManifest

    Constructor

    new()

    Methods

    @:value({ id : null })addBitmapData(path:String, ?id:String):Void

    @:value({ id : null })addBytes(path:String, ?id:String):Void

    @:value({ id : null })addFont(name:String, ?id:String):Void

    @:value({ id : null })addSound(paths:Array<String>, ?id:String):Void

    @:value({ id : null })addText(path:String, ?id:String):Void

    \ No newline at end of file +

    Static methods

    @:value({ rootPath : null })staticfromBytes(bytes:Bytes, ?rootPath:String):AssetManifest

    @:value({ rootPath : null })staticfromFile(path:String, ?rootPath:String):AssetManifest

    @:value({ rootPath : null })staticloadFromBytes(bytes:Bytes, ?rootPath:String):Future<AssetManifest>

    @:value({ rootPath : null })staticloadFromFile(path:String, ?rootPath:String):Future<AssetManifest>

    @:value({ rootPath : null })staticparse(data:String, ?rootPath:String):AssetManifest

    Constructor

    new()

    Methods

    @:value({ id : null })addBitmapData(path:String, ?id:String):Void

    @:value({ id : null })addBytes(path:String, ?id:String):Void

    @:value({ id : null })addFont(name:String, ?id:String):Void

    @:value({ id : null })addSound(paths:Array<String>, ?id:String):Void

    @:value({ id : null })addText(path:String, ?id:String):Void

    \ No newline at end of file diff --git a/openfl/utils/AssetType.html b/openfl/utils/AssetType.html index 60658c6..0a8cbe1 100644 --- a/openfl/utils/AssetType.html +++ b/openfl/utils/AssetType.html @@ -64,4 +64,4 @@ for short or repetitively used sounds, but in current versions, both AssetType.MUSIC and AssetType.SOUND behave similarly.

    A future version may implement optimizations specific to each audio type -again.

    @:value(cast "TEXT")@:impl@:enuminlineread onlyTEXT:AssetType = "TEXT"

    Text assets

    \ No newline at end of file +again.

    @:value(cast "TEXT")@:impl@:enuminlineread onlyTEXT:AssetType = "TEXT"

    Text assets

    \ No newline at end of file diff --git a/openfl/utils/Assets.html b/openfl/utils/Assets.html index 7e8f5cd..2fcb8e0 100644 --- a/openfl/utils/Assets.html +++ b/openfl/utils/Assets.html @@ -81,4 +81,4 @@ @usage Assets.loadMovieClip ("library:BouncingBall").onComplete (handleMovieClip);

    Parameters:

    id

    The ID for the asset

    useCache

    (Optional) Whether to allow use of the asset cache (Default: true)

    Returns:

    Returns a Future

    @:value({ useCache : true })staticloadMusic(id:String, useCache:Bool = true):Future<Sound>

    Loads an included music asset asynchronously @usage Assets.loadMusic ("music.ogg").onComplete (handleMusic);

    Parameters:

    id

    The ID or asset path for the asset

    useCache

    (Optional) Whether to allow use of the asset cache (Default: true)

    Returns:

    Returns a Future

    @:value({ useCache : true })staticloadSound(id:String, useCache:Bool = true):Future<Sound>

    Loads an included sound asset asynchronously @usage Assets.loadSound ("sound.wav").onComplete (handleSound);

    Parameters:

    id

    The ID or asset path for the asset

    useCache

    (Optional) Whether to allow use of the asset cache (Default: true)

    Returns:

    Returns a Future

    staticloadText(id:String):Future<String>

    Loads an included text asset asynchronously -@usage Assets.loadText ("text.txt").onComplete (handleString);

    Parameters:

    id

    The ID or asset path for the asset

    useCache

    (Optional) Whether to allow use of the asset cache (Default: true)

    Returns:

    Returns a Future

    staticregisterBinding(className:String, library:AssetLibrary):Void

    Registers an AssetLibrary binding for use with @:bind or Assets.bind

    Parameters:

    className

    The class name to use for the binding

    method

    The AssetLibrary responsible for the binding

    staticregisterLibrary(name:String, library:AssetLibrary):Void

    Registers a new AssetLibrary with the Assets class

    Parameters:

    name

    The name (prefix) to use for the library

    library

    An AssetLibrary instance to register

    @:value({ capture : false })staticremoveEventListener(type:String, listener:Dynamic, capture:Bool = false):Void

    staticunloadLibrary(name:String):Void

    staticunregisterBinding(className:String, library:AssetLibrary):Void

    Unregisters an AssetLibrary binding for use with @:bind or Assets.bind

    Parameters:

    className

    The class name to use for the binding

    method

    The AssetLibrary responsible for the binding

    \ No newline at end of file +@usage Assets.loadText ("text.txt").onComplete (handleString);

    Parameters:

    id

    The ID or asset path for the asset

    useCache

    (Optional) Whether to allow use of the asset cache (Default: true)

    Returns:

    Returns a Future

    staticregisterBinding(className:String, library:AssetLibrary):Void

    Registers an AssetLibrary binding for use with @:bind or Assets.bind

    Parameters:

    className

    The class name to use for the binding

    method

    The AssetLibrary responsible for the binding

    staticregisterLibrary(name:String, library:AssetLibrary):Void

    Registers a new AssetLibrary with the Assets class

    Parameters:

    name

    The name (prefix) to use for the library

    library

    An AssetLibrary instance to register

    @:value({ capture : false })staticremoveEventListener(type:String, listener:Dynamic, capture:Bool = false):Void

    staticunloadLibrary(name:String):Void

    staticunregisterBinding(className:String, library:AssetLibrary):Void

    Unregisters an AssetLibrary binding for use with @:bind or Assets.bind

    Parameters:

    className

    The class name to use for the binding

    method

    The AssetLibrary responsible for the binding

    \ No newline at end of file diff --git a/openfl/utils/ByteArray.html b/openfl/utils/ByteArray.html index 792f3b6..813fafb 100644 --- a/openfl/utils/ByteArray.html +++ b/openfl/utils/ByteArray.html @@ -284,4 +284,4 @@ in bytes is written first, as a 16-bit integer, followed by the bytes representing the characters of the string.

    Parameters:

    value

    The string value to be written.

    Throws:

    RangeError

    If the length is larger than 65535.

    staticinlinewriteUTFBytes(this:ByteArrayData, value:String):Void

    Writes a UTF-8 string to the byte stream. Similar to the writeUTF() method, but writeUTFBytes() does not -prefix the string with a 16-bit length word.

    Parameters:

    value

    The string value to be written.

    staticinlinewriteUnsignedInt(this:ByteArrayData, value:UInt):Void

    Writes a 32-bit unsigned integer to the byte stream.

    Parameters:

    value

    An unsigned integer to write to the byte stream.

    \ No newline at end of file +prefix the string with a 16-bit length word.

    Parameters:

    value

    The string value to be written.

    staticinlinewriteUnsignedInt(this:ByteArrayData, value:UInt):Void

    Writes a 32-bit unsigned integer to the byte stream.

    Parameters:

    value

    An unsigned integer to write to the byte stream.

    \ No newline at end of file diff --git a/openfl/utils/CompressionAlgorithm.html b/openfl/utils/CompressionAlgorithm.html index c3997cd..4e001b9 100644 --- a/openfl/utils/CompressionAlgorithm.html +++ b/openfl/utils/CompressionAlgorithm.html @@ -58,4 +58,4 @@

    The CompressionAlgorithm class defines string constants for the names of compress and uncompress options. These constants are used as values of the algorithm parameter of the ByteArray.compress() and -ByteArray.uncompress() methods.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyDEFLATE:CompressionAlgorithm = 0

    Defines the string to use for the deflate compression algorithm.

    @:value(cast 1)@:impl@:enuminlineread onlyLZMA:CompressionAlgorithm = 1

    @:value(cast 2)@:impl@:enuminlineread onlyZLIB:CompressionAlgorithm = 2

    Defines the string to use for the zlib compression algorithm.

    \ No newline at end of file +ByteArray.uncompress() methods.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyDEFLATE:CompressionAlgorithm = 0

    Defines the string to use for the deflate compression algorithm.

    @:value(cast 1)@:impl@:enuminlineread onlyLZMA:CompressionAlgorithm = 1

    @:value(cast 2)@:impl@:enuminlineread onlyZLIB:CompressionAlgorithm = 2

    Defines the string to use for the zlib compression algorithm.

    \ No newline at end of file diff --git a/openfl/utils/Dictionary.html b/openfl/utils/Dictionary.html index c12a25d..091c924 100644 --- a/openfl/utils/Dictionary.html +++ b/openfl/utils/Dictionary.html @@ -86,4 +86,4 @@

    The order of values is undefined.

    staticinlineremove(this:IMap<K, V>, key:K):Bool

    Removes the mapping of key and returns true if such a mapping existed, false otherwise.

    If key is null, the result is unspecified.

    @:arrayAccessstaticinlineset(this:IMap<K, V>, key:K, value:V):V

    Maps key to value.

    If key already has a mapping, the previous value disappears.

    -

    If key is null, the result is unspecified.

    \ No newline at end of file +

    If key is null, the result is unspecified.

    \ No newline at end of file diff --git a/openfl/utils/Endian.html b/openfl/utils/Endian.html index fe916be..1c04665 100644 --- a/openfl/utils/Endian.html +++ b/openfl/utils/Endian.html @@ -81,4 +81,4 @@ least significant digit is 6).

    A stream using the littleEndian byte order (the most significant byte first) writes:

    -
    78 56 34 12
    \ No newline at end of file +
    78 56 34 12
    \ No newline at end of file diff --git a/openfl/utils/Function.html b/openfl/utils/Function.html index 3750bd5..5e69fe5 100644 --- a/openfl/utils/Function.html +++ b/openfl/utils/Function.html @@ -52,4 +52,4 @@ .navbar .container img { margin: 5px 0 0 4px; } -

    Alias

    alias for Function
    \ No newline at end of file +

    Alias

    alias for Function
    \ No newline at end of file diff --git a/openfl/utils/Future.html b/openfl/utils/Future.html index 751b948..1139ae0 100644 --- a/openfl/utils/Future.html +++ b/openfl/utils/Future.html @@ -52,4 +52,4 @@ .navbar .container img { margin: 5px 0 0 4px; } -

    Alias

    alias for Future<T>
    \ No newline at end of file +

    Alias

    alias for Future<T>
    \ No newline at end of file diff --git a/openfl/utils/IAssetCache.html b/openfl/utils/IAssetCache.html index 2403d30..1e82d47 100644 --- a/openfl/utils/IAssetCache.html +++ b/openfl/utils/IAssetCache.html @@ -63,4 +63,4 @@ Assets.setBitmapData("assets/image2", image2); Assets.clear("assets"); // will clear image2 -Assets.clear("image"); // will clear image1

    Parameters:

    prefix

    A ID prefix

    getBitmapData(id:String):BitmapData

    Retrieves a cached BitmapData.

    Parameters:

    id

    The ID of the cached BitmapData

    Returns:

    The cached BitmapData instance

    getFont(id:String):Font

    Retrieves a cached Font.

    Parameters:

    id

    The ID of the cached Font

    Returns:

    The cached Font instance

    getSound(id:String):Sound

    Retrieves a cached Sound.

    Parameters:

    id

    The ID of the cached Sound

    Returns:

    The cached Sound instance

    hasBitmapData(id:String):Bool

    Checks whether a BitmapData asset is cached.

    Parameters:

    id

    The ID of a BitmapData asset

    Returns:

    Whether the object has been cached

    hasFont(id:String):Bool

    Checks whether a Font asset is cached.

    Parameters:

    id

    The ID of a Font asset

    Returns:

    Whether the object has been cached

    hasSound(id:String):Bool

    Checks whether a Sound asset is cached.

    Parameters:

    id

    The ID of a Sound asset

    Returns:

    Whether the object has been cached

    removeBitmapData(id:String):Bool

    Removes a BitmapData from the cache.

    Parameters:

    id

    The ID of a BitmapData asset

    Returns:

    true if the asset was removed, false if it was not in the cache

    removeFont(id:String):Bool

    Removes a Font from the cache.

    Parameters:

    id

    The ID of a Font asset

    Returns:

    true if the asset was removed, false if it was not in the cache

    removeSound(id:String):Bool

    Removes a Sound from the cache.

    Parameters:

    id

    The ID of a Sound asset

    Returns:

    true if the asset was removed, false if it was not in the cache

    setBitmapData(id:String, bitmapData:BitmapData):Void

    Adds or replaces a BitmapData asset in the cache.

    Parameters:

    id

    The ID of a BitmapData asset

    bitmapData

    The matching BitmapData instance

    setFont(id:String, font:Font):Void

    Adds or replaces a Font asset in the cache.

    Parameters:

    id

    The ID of a Font asset

    bitmapData

    The matching Font instance

    setSound(id:String, sound:Sound):Void

    Adds or replaces a Sound asset in the cache.

    Parameters:

    id

    The ID of a Sound asset

    bitmapData

    The matching Sound instance

    \ No newline at end of file +Assets.clear("image"); // will clear image1

    Parameters:

    prefix

    A ID prefix

    getBitmapData(id:String):BitmapData

    Retrieves a cached BitmapData.

    Parameters:

    id

    The ID of the cached BitmapData

    Returns:

    The cached BitmapData instance

    getFont(id:String):Font

    Retrieves a cached Font.

    Parameters:

    id

    The ID of the cached Font

    Returns:

    The cached Font instance

    getSound(id:String):Sound

    Retrieves a cached Sound.

    Parameters:

    id

    The ID of the cached Sound

    Returns:

    The cached Sound instance

    hasBitmapData(id:String):Bool

    Checks whether a BitmapData asset is cached.

    Parameters:

    id

    The ID of a BitmapData asset

    Returns:

    Whether the object has been cached

    hasFont(id:String):Bool

    Checks whether a Font asset is cached.

    Parameters:

    id

    The ID of a Font asset

    Returns:

    Whether the object has been cached

    hasSound(id:String):Bool

    Checks whether a Sound asset is cached.

    Parameters:

    id

    The ID of a Sound asset

    Returns:

    Whether the object has been cached

    removeBitmapData(id:String):Bool

    Removes a BitmapData from the cache.

    Parameters:

    id

    The ID of a BitmapData asset

    Returns:

    true if the asset was removed, false if it was not in the cache

    removeFont(id:String):Bool

    Removes a Font from the cache.

    Parameters:

    id

    The ID of a Font asset

    Returns:

    true if the asset was removed, false if it was not in the cache

    removeSound(id:String):Bool

    Removes a Sound from the cache.

    Parameters:

    id

    The ID of a Sound asset

    Returns:

    true if the asset was removed, false if it was not in the cache

    setBitmapData(id:String, bitmapData:BitmapData):Void

    Adds or replaces a BitmapData asset in the cache.

    Parameters:

    id

    The ID of a BitmapData asset

    bitmapData

    The matching BitmapData instance

    setFont(id:String, font:Font):Void

    Adds or replaces a Font asset in the cache.

    Parameters:

    id

    The ID of a Font asset

    bitmapData

    The matching Font instance

    setSound(id:String, sound:Sound):Void

    Adds or replaces a Sound asset in the cache.

    Parameters:

    id

    The ID of a Sound asset

    bitmapData

    The matching Sound instance

    \ No newline at end of file diff --git a/openfl/utils/IDataInput.html b/openfl/utils/IDataInput.html index 7b94baa..a45430f 100644 --- a/openfl/utils/IDataInput.html +++ b/openfl/utils/IDataInput.html @@ -91,4 +91,4 @@ is assumed to be prefixed with an unsigned short indicating the length in bytes.

    This method is similar to the readUTF() method in the Java® IDataInput interface.

    Returns:

    A UTF-8 string produced by the byte representation of characters.

    Throws:

    EOFError

    There is not sufficient data available to read.

    readUTFBytes(length:Int):String

    Reads a sequence of UTF-8 bytes from the byte stream or byte array and returns a string.

    Parameters:

    length

    The number of bytes to read.

    Returns:

    A UTF-8 string produced by the byte representation of characters of -the specified length.

    Throws:

    EOFError

    There is not sufficient data available to read.

    readUnsignedByte():Int

    Reads an unsigned byte from the file stream, byte stream, or byte array.

    Returns:

    The returned value is in the range 0 to 255.

    Throws:

    EOFError

    There is not sufficient data available to read.

    readUnsignedInt():Int

    Reads an unsigned 32-bit integer from the file stream, byte stream, or byte array.

    Returns:

    The returned value is in the range 0 to 4294967295.

    Throws:

    EOFError

    There is not sufficient data available to read.

    readUnsignedShort():Int

    Reads an unsigned 16-bit integer from the file stream, byte stream, or byte array.

    Returns:

    The returned value is in the range 0 to 65535.

    Throws:

    EOFError

    There is not sufficient data available to read.

    \ No newline at end of file +the specified length.

    Throws:

    EOFError

    There is not sufficient data available to read.

    readUnsignedByte():Int

    Reads an unsigned byte from the file stream, byte stream, or byte array.

    Returns:

    The returned value is in the range 0 to 255.

    Throws:

    EOFError

    There is not sufficient data available to read.

    readUnsignedInt():Int

    Reads an unsigned 32-bit integer from the file stream, byte stream, or byte array.

    Returns:

    The returned value is in the range 0 to 4294967295.

    Throws:

    EOFError

    There is not sufficient data available to read.

    readUnsignedShort():Int

    Reads an unsigned 16-bit integer from the file stream, byte stream, or byte array.

    Returns:

    The returned value is in the range 0 to 65535.

    Throws:

    EOFError

    There is not sufficient data available to read.

    \ No newline at end of file diff --git a/openfl/utils/IDataOutput.html b/openfl/utils/IDataOutput.html index 3e9aaf8..f30eaba 100644 --- a/openfl/utils/IDataOutput.html +++ b/openfl/utils/IDataOutput.html @@ -85,4 +85,4 @@ bits are ignored.

    Parameters:

    value

    A byte value as an integer.

    writeUTF(value:String):Void

    Writes a UTF-8 string to the file stream, byte stream, or byte array. The length of the UTF-8 string in bytes is written first, as a 16-bit integer, followed by the bytes representing the characters of the string.

    Parameters:

    value

    The string value to be written.

    Throws:

    RangeError

    If the length is larger than 65535.

    writeUTFBytes(value:String):Void

    Writes a UTF-8 string. Similar to writeUTF(), but does not prefix the string with -a 16-bit length word.

    Parameters:

    value

    The string value to be written.

    writeUnsignedInt(value:Int):Void

    Writes a 32-bit unsigned integer.

    Parameters:

    value

    A byte value as an unsigned integer.

    \ No newline at end of file +a 16-bit length word.

    Parameters:

    value

    The string value to be written.

    writeUnsignedInt(value:Int):Void

    Writes a 32-bit unsigned integer.

    Parameters:

    value

    A byte value as an unsigned integer.

    \ No newline at end of file diff --git a/openfl/utils/IExternalizable.html b/openfl/utils/IExternalizable.html index 805696a..73e4d3c 100644 --- a/openfl/utils/IExternalizable.html +++ b/openfl/utils/IExternalizable.html @@ -72,28 +72,28 @@

    To serialize private members, a class must use the IExternalizable interface. For example, the following class will not serialize any of its members because they are private:

    -
    class Example {
    +
    class Example {
     
    -	private var one:int;
    -	private var two:int;
    +	private var one:Int;
    +	private var two:Int;
     }

    However, if you implement the IExternalizable interface, you can write to, and read from, the data stream the private members of the class as follows:

    -
    class Example implement IExternalizable {
    +
    class Example implement IExternalizable {
     
    -	private var one:int;
    -	private var two:int;
    +	private var one:Int;
    +	private var two:Int;
     
    -	public function writeExternal(output:IDataOutput) {
    +	public function writeExternal(output:IDataOutput):Void {
     
    -			output.writeInt(one);
    -			output.writeInt(two);
    +		output.writeInt(one);
    +		output.writeInt(two);
     	}
     
    -	public function readExternal(input:IDataInput) {
    +	public function readExternal(input:IDataInput):Void {
     
    -			one = input.readInt();
    -			two = input.readInt();
    +		one = input.readInt();
    +		two = input.readInt();
     	}
     }

    Note: If a class implements IExternalizable the default serialization no longer @@ -101,33 +101,33 @@ class, you must carefully manage those members as well.

    When a subclass of a class implementing IExternalizable has private members of its own, the subclass must override the methods of IExternalizable, as follows:

    -
    public class Base implements IExternalizable {
    +
    class Base implements IExternalizable {
     
     	private var one:Boolean;
     
    -	public function writeExternal(output:IDataOutput):void {
    +	public function writeExternal(output:IDataOutput):Void {
     
     		output.writeBoolean(one);
     	}
     
    -	public function readExternal(input:IDataInput):void {
    +	public function readExternal(input:IDataInput):Void {
     
     		one = input.readBoolean();
     	}
     }
     
    -public class Example extends Base {
    +class Example extends Base {
     
     	private var one:String;
     
     
    -	public override function writeExternal(output:IDataOutput):void {
    +	public override function writeExternal(output:IDataOutput):Void {
     
     		super.writeExternal(output);
     		output.writeUTF(one);
     	}
     
    -	public override function readExternal(input:IDataInput):void {
    +	public override function readExternal(input:IDataInput):Void {
     
     		super.readExternal(input);
     		one = input.readUTF();
    @@ -135,20 +135,20 @@
     }

    The IExternalizable interface can also be used to compress data before writing it to a data stream. For example:

    -
    class Example implements IExternalizable {
    +
    class Example implements IExternalizable {
     
    -	public var one:Boolean;
    -	public var two:Boolean;
    -	public var three:Boolean;
    -	public var four:Boolean;
    -	public var five:Boolean;
    -	public var six:Boolean;
    -	public var seven:Boolean;
    -	public var eight:Boolean;
    +	public var one:Bool;
    +	public var two:Bool;
    +	public var three:Bool;
    +	public var four:Bool;
    +	public var five:Bool;
    +	public var six:Bool;
    +	public var seven:Bool;
    +	public var eight:Bool;
     
    -	public function writeExternal(output:IDataOutput) {
    +	public function writeExternal(output:IDataOutput):Void {
     
    -		var flag:int = 0;
    +		var flag:Int = 0;
     
     		if (one) flag |= 1;
     		if (two) flag |= 2;
    @@ -162,9 +162,9 @@
     		output.writeByte(flag);
     	}
     
    -	public function readExternal(input:IDataInput) {
    +	public function readExternal(input:IDataInput):Void {
     
    -		var flag:int = input.readByte();
    +		var flag:Int = input.readByte();
     
     		one = (flag & 1) != 0;
     		two = (flag & 2) != 0;
    @@ -178,4 +178,4 @@
     }

    Methods

    readExternal(input:IDataInput):Void

    A class implements this method to decode itself from a data stream by calling the methods of the IDataInput interface. This method must read the values in the same sequence and with the same types as were written by the writeExternal() method.

    Parameters:

    input

    The name of the class that implements the IDataInput interface.

    writeExternal(output:IDataOutput):Void

    A class implements this method to encode itself for a data stream by calling the -methods of the IDataOutput interface.

    Parameters:

    output

    The name of the class that implements the IDataOutput interface.

    \ No newline at end of file +methods of the IDataOutput interface.

    Parameters:

    output

    The name of the class that implements the IDataOutput interface.

    \ No newline at end of file diff --git a/openfl/utils/Namespace.html b/openfl/utils/Namespace.html index 8a4886d..cc2d29a 100644 --- a/openfl/utils/Namespace.html +++ b/openfl/utils/Namespace.html @@ -95,4 +95,4 @@ prefix properties of the new Namespace object depending on the type of the value:

    • If no value is passed, the prefix and uri properties are set to an empty string.
    • If the value is a Namespace object, a copy of the object is created.
    • If the value is a QName object, the uri property is set to the uri -property of the QName object.

    Variables

    read onlyprefix:String

    The prefix of the namespace.

    read onlyuri:String

    The Uniform Resource Identifier (URI) of the namespace.

    \ No newline at end of file +property of the QName object.

    Variables

    read onlyprefix:String

    The prefix of the namespace.

    read onlyuri:String

    The Uniform Resource Identifier (URI) of the namespace.

    \ No newline at end of file diff --git a/openfl/utils/Object.html b/openfl/utils/Object.html index 7d12968..e9f3f73 100644 --- a/openfl/utils/Object.html +++ b/openfl/utils/Object.html @@ -52,4 +52,4 @@ .navbar .container img { margin: 5px 0 0 4px; } -

    Static methods

    staticinlinehasOwnProperty(this:ObjectType, name:String):Bool

    staticisPrototypeOf(this:ObjectType, theClass:Class<Dynamic>):Bool

    staticinlinepropertyIsEnumerable(this:ObjectType, name:String):Bool

    staticinlinetoLocaleString(this:ObjectType):String

    @:tostaticinlinetoString(this:ObjectType):String

    staticinlinevalueOf(this:ObjectType):Object

    \ No newline at end of file +

    Static methods

    staticinlinehasOwnProperty(this:ObjectType, name:String):Bool

    staticisPrototypeOf(this:ObjectType, theClass:Class<Dynamic>):Bool

    staticinlinepropertyIsEnumerable(this:ObjectType, name:String):Bool

    staticinlinetoLocaleString(this:ObjectType):String

    @:tostaticinlinetoString(this:ObjectType):String

    staticinlinevalueOf(this:ObjectType):Object

    \ No newline at end of file diff --git a/openfl/utils/ObjectPool.html b/openfl/utils/ObjectPool.html index 1f6c997..de7bced 100644 --- a/openfl/utils/ObjectPool.html +++ b/openfl/utils/ObjectPool.html @@ -52,4 +52,4 @@ .navbar .container img { margin: 5px 0 0 4px; } -

    Alias

    alias for ObjectPool<T>
    \ No newline at end of file +

    Alias

    alias for ObjectPool<T>
    \ No newline at end of file diff --git a/openfl/utils/PerspectiveMatrix3D.html b/openfl/utils/PerspectiveMatrix3D.html index cd45efe..6f147f9 100644 --- a/openfl/utils/PerspectiveMatrix3D.html +++ b/openfl/utils/PerspectiveMatrix3D.html @@ -399,4 +399,4 @@ If you want to transpose a matrix without altering the current matrix, first copy the current matrix by using the clone() method and then apply the transpose() method to the copy.

    -

    An orthogonal matrix is a square matrix whose transpose is equal to its inverse.

    \ No newline at end of file +

    An orthogonal matrix is a square matrix whose transpose is equal to its inverse.

    \ No newline at end of file diff --git a/openfl/utils/Promise.html b/openfl/utils/Promise.html index 1163b91..9db9202 100644 --- a/openfl/utils/Promise.html +++ b/openfl/utils/Promise.html @@ -52,4 +52,4 @@ .navbar .container img { margin: 5px 0 0 4px; } -

    Alias

    alias for Promise<T>
    \ No newline at end of file +

    Alias

    alias for Promise<T>
    \ No newline at end of file diff --git a/openfl/utils/QName.html b/openfl/utils/QName.html index 5dcab76..6bf3034 100644 --- a/openfl/utils/QName.html +++ b/openfl/utils/QName.html @@ -84,4 +84,4 @@ not a QName object, the parameter is converted to a string and assigned to the localName property of the new QName instance. If the parameter is undefined or unspecified, a new QName object is created with the -localName property set to the empty string.

    Variables

    read onlylocalName:String

    The local name of the QName object.

    read onlyuri:String

    The Uniform Resource Identifier (URI) of the QName object.

    \ No newline at end of file +localName property set to the empty string.

    Variables

    read onlylocalName:String

    The local name of the QName object.

    read onlyuri:String

    The Uniform Resource Identifier (URI) of the QName object.

    \ No newline at end of file diff --git a/openfl/utils/Timer.html b/openfl/utils/Timer.html index ffcc100..82f5ef8 100644 --- a/openfl/utils/Timer.html +++ b/openfl/utils/Timer.html @@ -217,4 +217,4 @@ event specified by the type parameter.

    When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

    Parameters:

    type

    The type of event.

    Returns:

    A value of true if a listener of the specified type -will be triggered; false otherwise.

    \ No newline at end of file +will be triggered; false otherwise.

    \ No newline at end of file diff --git a/openfl/utils/index.html b/openfl/utils/index.html index 90a4e35..b9b5de2 100644 --- a/openfl/utils/index.html +++ b/openfl/utils/index.html @@ -136,4 +136,4 @@

    package ::full::

    object.

    Timer

    The Timer class is the interface to timers, which let you run code on a specified time sequence. Use the start() method to start a timer. Add an event listener for the timer event to set up -code to be run on the timer interval.

    \ No newline at end of file +code to be run on the timer interval.

    \ No newline at end of file