MovieClipHistory Documentation
Author: senocular
Last Modified: 01/28/05 18:57:23
Summary
MovieClipHistory class:
MovieClipHistory Properties:
MovieClipHistory Methods:
version: 1.1
description:
Provides a way to record and replay many methods used in dynamically defining a MovieClip's visual appearance. Methods recorded can be replayed on the original MovieClip or another MovieClip which is to "inherit" the original MovieClip's dynamic appearance. Supported methods include:
When using MovieClipHistory, you don't don't create instances of the
class but, rather, use the class to initialize a pre-existing MovieClip
instance so that that MovieClip may be set up to record history for itself.
An instance of MovieClipHistory is then automatically assigned to that
MovieClip as the property history. This history is an array
of generic history objects that contain the properties:
(String) The name of the method recorded.(Array) Arguments used in the method.(String) Path from the MovieClip recording the method ("epoch") to the MovieClip using it.usage:
MovieClipHistory.initialize(movieClipToReceiveHistory [, epoch]);
if true history is recorded as normal. When set to false historic methods are not recorded in history. Default: true.
The MovieClip owning the MovieClipHistory instance.
The epoch MovieClip if _parent is not recording it's own history.
A string path to _parent from the epoch.
description:
(Static) Initializes a MovieClip in order for it's methods to be recorded.
When initialized, MovieClips recieve an instance of MovieClipHistory
as a history property. Set epoch to true if you want child clips to store
history in the MovieClip being initialized
usage:
MovieClipHistory.initialize(movieClipToReceiveHistory [, epoch]);
parameters:
(MovieClip) MovieClip to be set up to record history(MovieClip, Boolean) Optional, MovieClip to record history for mc. If null, mc is used and all child MovieClips created through historic events record methods independantly to their own history instances. If true, mc is used and all child MovieClips created through historic events use mc as their epoch recording their history to mc's history instance. Default: null.returns: Void.
description: Recalls one, a range of, or all historic events calling them on the passed epoch.
usage:
initializedMovieClip.history.recall(anyMovieClip [, start [,end]]);
parameters:
(MovieClip) Optional, specifies which MovieClip will recieve calls of historic events from this history instance. If null, the history owner recieves the events. Default: null.(Number) Optional, The position in history to start playback. Default: 0 (first event).(Number) Optional, The position in history to stop playback. If start is specified but end is not, only the history event at start is called. Default: length-1 (last event).returns: Void.