MovieClip

Supported platforms:
Available since: Gideros 2011.6
Inherits from: Sprite

Description

The MovieClip class inherits from the following classes: Sprite > EventDispatcher.

The MovieClip class is used create static timedlined animations. The timeline parameters are given as an array.

Each array element specifies one timeline element and consists of the starting frame, ending frame, sprite and optional tweening parameters. Frame numbers start from 1.

When a MovieClip object finishes it playing (by reaching its final frame or a frame with stop action), it dispatches an Event.COMPLETE event.

The following properties can be tweened:

• x
• y
• rotation
• scale
• scaleX
• scaleY
• alpha

Additionally MovieClip uses set function to tween properties, so if you override provided object's set function by adding new parameters it can accept, then you can tween those new parameters too.

The following easing functions can be used:

• "inBack"
• "outBack"
• "inOutBack"
• "inBounce"
• "outBounce"
• "inOutBounce"
• "inCircular"
• "outCircular"
• "inOutCircular"'
• "inCubic"
• "outCubic"
• "inOutCubic"
• "inElastic"
• "outElastic"
• "inOutElastic"
• "inExponential"
• "outExponential"
• "inOutExponential"
• "linear"
• "inQuadratic"
• "outQuadratic"
• "inOutQuadratic"
• "inQuartic"
• "outQuartic"
• "inOutQuartic"
• "inQuintic"
• "outQuintic"
• "inOutQuintic"
• "inSine"
• "outSine"
• "inOutSine"

Following examples demonstrates the possible uses of MovieClip class.

Examples

Example

-- construct a 100 frame animation where x coordinate of sprite tweens from 0 to 200 linearly
local mc = MovieClip.new{
	{1, 100, sprite, {x = {0, 200, "linear"}}}
}

-- construct a 100 frame animation where x coordinate of sprite is 50 (constant) and 
-- y coordinate of sprite tweens from 50 to 150 by using inBounce function
local mc = MovieClip.new{
	{1, 100, sprite, {x = 50, y = {50, 150, "inBounce"}}}
}

-- construct a 200 frame animation where sprite1 and sprite2 tweens differently
-- here sprite1 is visible between frames [1, 150]
-- and sprite2 is visible between frames [100, 200]
local mc = MovieClip.new{
	{1, 100, sprite1, {x = {0, 200, "linear"}}},
	{50, 150, sprite1, {y = {0, 100, "linear"}, alpha = {0, 1, "easeOut"}}},
	{100, 200, sprite2, {x = {0, 200, "linear"}}},
}

-- construct a looping 6 frame animation where each frame is a different sprite
local mc = MovieClip.new{
	{1, 1, frame1},	
	{2, 2, frame2},	
	{3, 3, frame3},	
	{4, 4, frame4},	
	{5, 5, frame5},	
	{6, 6, frame6},
}
mc:setGotoAction(6, 1)	-- if the animation reaches frame 6 then go to frame 1
						
-- construct a looping 6 frame animation playing 5 times slower than the previous example
local mc = MovieClip.new{
	{1, 5, frame1},	
	{5, 10, frame2},	
	{11, 15, frame3},	
	{16, 20, frame4},	
	{21, 25, frame5},	
	{26, 30, frame6},
}
mc:setGotoAction(30, 1)	-- if the animation reaches frame 30 then go to frame 1

Methods MovieClip.new creates a new MovieClip object MovieClip:clearAction clears the action at the specified frame MovieClip:getFrame MovieClip:gotoAndPlay goes to the specified frame and starts playing MovieClip:gotoAndStop goes to the specified frame and stops MovieClip:play starts playing the movie clip MovieClip:setGotoAction sets a "go to" action to the specified frame MovieClip:setReverseAction sets a "reverse" action to the specified frame MovieClip:setStopAction sets a "stop" action to the specified frame MovieClip:stop stops playing the movie clip

Events Event.COMPLETE Constants

---

• MovieClip

• MovieClip.getTweenFunction
• MovieClip.new

• MovieClip:clearAction
• MovieClip:getFrame
• MovieClip:gotoAndPlay
• MovieClip:gotoAndStop
• MovieClip:isPlaying
• MovieClip:play
• MovieClip:setGotoAction
• MovieClip:setReverseAction
• MovieClip:setStopAction
• MovieClip:stop

• MovieClip Event.COMPLETE

---

---

• Main Page
• Lua API
• Main API
• Plugins