loadClip (MovieClipLoader.loadClip method)
public loadClip(url:String, target:Object) : Boolean
Loads a SWF or JPEG file into a movie clip in Flash Player while the original movie is playing. Using this method lets you display several SWF files at once and switch between SWF files without loading another HTML document.
Using the loadClip() method instead of loadMovie() or MovieClip.loadMovie() has a number of advantages. The following handlers are implemented by the use of a listener object. You activate the listener by using MovieClipLoader.addListener(listenerObject) to register it with the MovieClipLoader class.
- The MovieClipLoader.onLoadStart handler is invoked when loading begins.
- The MovieClipLoader.onLoadError handler is invoked if the clip cannot be loaded.
- The MovieClipLoader.onLoadProgress handler is invoked as the loading process progresses.
- The MovieClipLoader.onLoadComplete handler is invoked when a file completes downloading, but before the loaded movie clip's methods and properties are available. This handler is called before the onLoadInit handler.
- The MovieClipLoader.onLoadInit handler is invoked after the actions in the first frame of the clip are executed, so you can begin manipulating the loaded clip. This handler is called after the onLoadComplete handler. For most purposes, use the onLoadInit handler.
A SWF file or image loaded into a movie clip inherits the position, rotation, and scale properties of the movie clip. You can use the target path of the movie clip to target the loaded movie.
You can use the loadClip() method to load one or more files into a single movie clip or level; MovieClipLoader listener objects are passed to the loading target movie clip instance as a parameter. Alternatively, you can create a different MovieClipLoader object for each file that you load.
Use MovieClipLoader.unloadClip() to remove movies or images loaded with this method or to cancel a load operation that is in progress.
MovieClipLoader.getProgress() and MovieClipLoaderListener.onLoadProgress do not report the actual bytesLoaded and bytesTotal values in the Authoring player when the files are local. When you use the Bandwidth Profiler feature in the authoring environment, MovieClipLoader.getProgress() and MovieClipLoaderListener.onLoadProgress report the download at the actual download rate, not at the reduced bandwidth rate that the Bandwidth Profiler provides.
url:String - The absolute or relative URL of the SWF or JPEG file to be loaded. A relative path must be relative to the SWF file at level 0. Absolute URLs must include the protocol reference, such as http:// or file:///. Filenames cannot include disk drive specifications.
target:Object - The target path of a movie clip, or an integer specifying the level in Flash Player into which the movie will be loaded. The target movie clip is replaced by the loaded SWF file or image.
Boolean - A Boolean value. The return value is true if the URL request was sent successfully; otherwise the return value is false.
The following example shows you how to use the MovieClipLoader.loadClip method by creating handler for the onLoadInit event and then making the request.
The following code should either be placed directly into a frame action on a timeline, or pasted into a class that extends MovieClip.
Create a handler method for the onLoadInit event.
public function onLoadInit(mc:MovieClip):Void {
trace("onLoadInit: " + mc);
}
Create an empty MovieClip and use the MovieClipLoader to load an image into it.
var container:MovieClip = createEmptyMovieClip("container", getNextHighestDepth());
var mcLoader:MovieClipLoader = new MovieClipLoader();
mcLoader.addListener(this);
mcLoader.loadClip("YourImage.jpg", container);
function onLoadInit(mc:MovieClip) {
trace("onLoadInit: " + mc);
}