(Beta)
| Package | fl.events |
| Class | public class RSLErrorEvent |
| Inheritance | RSLErrorEvent  ErrorEvent TextEvent Event Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flash CS5 |
| Runtime Versions: | Flash Player 10.1, AIR 2 |
RSLPreloader. This event
indicates that the download of RSLs has failed, and provides information on the files that have failed
and the number of files, both attempted and failed. When a custom event preloading loop is used, and the
RSLPreloader code is generated automatically by Flash authoring, this event is
dispatched by the main timeline. In this case, use addEventListener without needing to
reference the RSLPreloader.
Related API Elements
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | bubbles : Boolean [read-only]
Indicates whether an event is a bubbling event. | Event | |
| cancelable : Boolean [read-only]
Indicates whether the behavior associated with the event can be prevented. | Event | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| currentTarget : Object [read-only]
The object that is actively processing the Event object with an event listener. | Event | |
| errorID : int [read-only]
Contains the reference number associated with the specific error. | ErrorEvent | |
| eventPhase : uint [read-only]
The current phase in the event flow. | Event | |
| failedURLs : Array [read-only]
Returns an array of files that have failed to download. | RSLErrorEvent | ||
| rslsFailed : int [read-only]
Returns the number of files that have failed to download. | RSLErrorEvent | ||
| rslsLoaded : int [read-only]
Returns the number of files that have downloaded successfully. | RSLErrorEvent | ||
| rslsTotal : int [read-only]
Returns the total number of files that have downloaded, successfully or not. | RSLErrorEvent | ||
| target : Object [read-only]
The event target. | Event | |
| text : String
For a textInput event, the character or sequence of characters
entered by the user. | TextEvent | |
| type : String [read-only]
The type of event. | Event | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
RSLErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, rslsLoaded:int = 0, rslsFailed:int = 0, rslsTotal:int = 0, failedURLs:Array = null)
Creates an RSLErrorEvent object that contains information about RSLError events. | RSLErrorEvent | ||
| [override]
Creates a copy of the ErrorEvent object and sets the value of each property to match that of the original. | ErrorEvent | |
|
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Checks whether the preventDefault() method has been called on the event. | Event | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Cancels an event's default behavior if that behavior can be canceled. | Event | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
|
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
| [override]
Returns a string that contains all the properties of the ErrorEvent object. | ErrorEvent | |
|
Returns the primitive value of the specified object. | Object | |
Public Constants
| Constant | Defined By | ||
|---|---|---|---|
| RSL_LOAD_FAILED : String = "rslLoadFailed" [static]
Error dispatched by RSLPreloader when all RSLs have finished
downloading and one or more have failed. | RSLErrorEvent | ||
Property Detail
failedURLs | property |
rslsFailed | property |
rslsLoaded | property |
rslsTotal | property |
Constructor Detail
RSLErrorEvent | () | Constructor |
public function RSLErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, rslsLoaded:int = 0, rslsFailed:int = 0, rslsTotal:int = 0, failedURLs:Array = null)| Language Version: | ActionScript 3.0 |
| Product Version: | Flash CS5 |
| Runtime Versions: | Flash Player 10.1, AIR 2 |
Creates an RSLErrorEvent object that contains information about RSLError events. RSLErrorEvent objects are passed as parameters to event listeners.
Parameterstype:String — The type of the event. Possible values are: RSLEvent.RSL_LOAD_COMPLETE and RSLEvent.RSL_PROGRESS.
| |
bubbles:Boolean (default = false) | |
cancelable:Boolean (default = false) | |
rslsLoaded:int (default = 0) | |
rslsFailed:int (default = 0) | |
rslsTotal:int (default = 0) | |
failedURLs:Array (default = null) |
Constant Detail
RSL_LOAD_FAILED | Constant |
public static const RSL_LOAD_FAILED:String = "rslLoadFailed"| Language Version: | ActionScript 3.0 |
| Product Version: | Flash CS5 |
| Runtime Versions: | Flash Player 10.1, AIR 2 |
Error dispatched by RSLPreloader when all RSLs have finished
downloading and one or more have failed. When preloading with a custom event loop, user
content MUST listen for this event to determine when to exit the loading animation loop.
This event has the following properties:
| Property | Value |
|---|---|
bubbles | true |
cancelable | false; there is no default behavior to cancel. |
currentTarget | The object that is actively processing the Event object with an event listener. |
target | The DisplayObject instance being added to the display list.
The target is not always the object in the display list
that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event. |
rslsLoaded | The number of files that have downloaded successfully. |
rslsFailed | the number of files that have failed to download. |
rslsTotal | the total number of files that have downloaded, successfully or not. |
failedURLs | An array of files that have failed to download. |
import fl.events.RSLErrorEvent;
myPreloader.addEventListener(RSLErrorEvent.RSL_LOAD_FAILED, rslLoadFailedHandler);
function rslLoadFailedHandler(e:RSLErrorEvent) {
gotoAndPlay('rslLoadFailure');
}
Related API Elements
Wed Nov 21 2018, 06:34 AM -08:00