frame summary

Availability

Flash MX 2004.

Description

The Frame object represents frames in the layer.

Method summary

The following methods can be used with the Frame object:

Method

Description

frame.convertMotionObjectTo2D()

Converts the selected motion object to a 2D motion object.

frame.convertMotionObjectTo3D()

Converts the selected motion object to a 3D motion object.

frame.convertToFrameByFrameAnimation()

Converts the current frame to Frame-by-Frame Animation.

frame.getCustomEase()

Returns an array of JavaScript objects, each of which has an x and y property.

frame.getMotionObjectXML()

Returns the motion XML from the selected motion object.

frame.getSoundEnvelope()

Gets the sound envelope data of any frame.

frame.getSoundEnvelopeLimits()

Gets the limits (start, end) for a custom Sound envelope that is applied to the frame sound.

frame.hasMotionPath()

Informs you whether or not the currrent selection has a motion tween.

frame.is3DMotionObject()

Informs you whether or not the currrent selection is a 3D motion object.

frame.isEmpty()

Informs you whether the frame contains any elements.

frame.isMotionObject()

Informs you whether or not the currrent selection is a motion object.

frame.selectMotionPath()

Selects or deselects the motion path of the current motion object.

frame.setCustomEase()

Specifies a cubic Bézier curve to be used as a custom ease curve.

frame.setMotionObjectDuration()

Specifies the duration (the tween span length) of the currently selected motion object.

frame.setMotionObjectXML()

Applies the specified motion XML to the selected motion object.

frame.setSoundEnvelope()

Sets the sound envelope data of a frame.

frame.setSoundEnvelopeLimits()

Sets the sound envelope limits of any frame with a sound file.

Property summary

The following properties can be used with the Frame object:

Property

Description

frame.actionScript

A string representing ActionScript code.

frame.duration

Read-only; an integer that represents the number of frames in a frame sequence.

frame.elements

Read-only; an array of Element objects (see Element object).

frame.hasCustomEase

A Boolean value that specifies whether the frame gets its ease information from the custom ease curve.

frame.labelType

A string that specifies the type of Frame name.

frame.motionTweenOrientToPath

A Boolean value that specifies whether or not the tweened element rotates the element as it moves along a path to maintain its angle with respect to each point on the path.

frame.motionTweenRotate

A string that specifies how the tweened element rotates.

frame.motionTweenRotateTimes

An integer that specifies the number of times the tweened element rotates between the starting keyframe and the next keyframe.

frame.motionTweenScale

A Boolean value that specifies whether the tweened element scales to the size of the object in the following keyframe, increasing its size with each frame in the tween (true), or doesn’t scale (false).

frame.motionTweenSnap

A Boolean value that specifies whether the tweened element automatically snaps to the nearest point on the motion guide layer associated with this frame’s layer (true) or not (false).

frame.motionTweenSync

A Boolean value that if set to true, synchronizes the animation of the tweened object with the main timeline.

frame.name

A string that specifies the name of the frame.

frame.shapeTweenBlend

A string that specifies how a shape tween is blended between the shape in the keyframe at the start of the tween and the shape in the following keyframe.

frame.soundEffect

A string that specifies effects for a sound that is attached directly to a frame (frame.soundLibraryItem).

frame.soundLibraryItem

A library item (see SoundItem object) used to create a sound.

frame.soundLoop

An integer value that specifies the number of times a sound that is attached directly to a frame (frame.soundLibraryItem) plays.

frame.soundLoopMode

A string that specifies whether a sound that is attached directly to a frame (frame.soundLibraryItem) should play a specific number of times or loop indefinitely.

frame.soundName

A string that specifies the name of a sound that is attached directly to a frame (frame.soundLibraryItem), as stored in the library.

frame.soundSync

A string that specifies the sync behavior of a sound that is attached directly to a frame (frame.soundLibraryItem).

frame.startFrame

Read-only; the index of the first frame in a sequence.

frame.tweenEasing

An integer that specifies the amount of easing that should be applied to the tweened object.

frame.tweenInstanceName

Assings an instance name to the specified motion object.

frame.tweenType

A string that specifies the type of tween.

frame.useSingleEaseCurve

A Boolean value that specifies whether a single custom ease curve is used for easing information for all properties.