org.flixel.data.FlxFade

Public Properties

	Property		Defined By
		acceleration : FlxPoint How fast the speed of this object is changing.	FlxObject
		active : Boolean If an object is not alive, the game loop will not automatically call update() on it.	FlxObject
		alpha : Number Set alpha to a number between 0 and 1 to change the opacity of the sprite.	FlxSprite
		angle : Number Set the angle of a sprite to rotate it.	FlxObject
		angularAcceleration : Number How fast the spin speed should change.	FlxObject
		angularDrag : Number Like drag but for spinning.	FlxObject
		angularVelocity : Number This is how fast you want this sprite to spin.	FlxObject
		_animations : Array	FlxSprite
		antialiasing : Boolean Controls whether the object is smoothed when rotated, affects performance.	FlxSprite
		blend : String Blending modes, just like Photoshop! E.g.	FlxSprite
		bottom : Number [read-only] The Y coordinate of the bottom of the rectangle.	FlxRect
		colHullX : FlxRect These store a couple of useful numbers for speeding up collision resolution.	FlxObject
		colHullY : FlxRect These store a couple of useful numbers for speeding up collision resolution.	FlxObject
		collideBottom : Boolean Flag for direction collision resolution.	FlxObject
		collideLeft : Boolean Flag for direction collision resolution.	FlxObject
		collideRight : Boolean Flag for direction collision resolution.	FlxObject
		collideTop : Boolean Flag for direction collision resolution.	FlxObject
		colOffsets : Array An array of FlxPoint objects.	FlxObject
		color : uint Set color to a number in this format: 0xRRGGBB.	FlxSprite
		colVector : FlxPoint These store a couple of useful numbers for speeding up collision resolution.	FlxObject
		dead : Boolean Handy for tracking gameplay or animations.	FlxObject
		drag : FlxPoint This isn't drag exactly, more like deceleration that is only applied when acceleration is not affecting the sprite.	FlxObject
		exists : Boolean Kind of a global on/off switch for any objects descended from FlxObject.	FlxObject
		facing : uint Set facing using FlxSprite.LEFT,RIGHT, UP, and DOWN to take advantage of flipped sprites and/or just track player orientation more easily.	FlxSprite
		filter : *	FlxSprite
		finished : Boolean Whether the current animation has finished its first (or only) loop.	FlxSprite
		fixed : Boolean If an object is 'fixed' in space, it will not budge when it collides with a not-fixed object.	FlxObject
		frame : uint Tell the sprite to change to a specific frame of animation.	FlxSprite
		frameHeight : uint The height of the actual graphic or image being displayed (not necessarily the game object/bounding box).	FlxSprite
		_framePixels : BitmapData	FlxSprite
		frameWidth : uint The width of the actual graphic or image being displayed (not necessarily the game object/bounding box).	FlxSprite
		_group : Boolean Dedicated internal flag for whether or not this class is a FlxGroup.	FlxObject
		health : Number Handy for storing health percentage or armor points or whatever.	FlxObject
		height : Number	FlxRect
		left : Number [read-only] The X coordinate of the left side of the rectangle.	FlxRect
		maxAngular : Number Use in conjunction with angularAcceleration for fluid spin speed control.	FlxObject
		maxThrust : Number Used to cap thrust, helpful and easy!	FlxObject
		maxVelocity : FlxPoint If you are using acceleration, you can use maxVelocity with it to cap the speed automatically (very useful!).	FlxObject
		moves : Boolean Set this to false if you want to skip the automatic motion/movement stuff (see updateMotion()).	FlxObject
		offset : FlxPoint If you changed the size of your sprite object to shrink the bounding box, you might need to offset the new bounding box from the top-left corner of the sprite.	FlxSprite
		onFloor : Boolean Flag that indicates whether or not you just hit the floor.	FlxObject
		origin : FlxPoint WARNING: The origin of the sprite will default to its center.	FlxObject
		pixels : BitmapData Set pixels to any BitmapData object.	FlxSprite
		realFrameCount : int	FlxSprite
		right : Number [read-only] The X coordinate of the right side of the rectangle.	FlxRect
		scale : FlxPoint Change the size of your sprite's graphic.	FlxSprite
		scrollFactor : FlxPoint A point that can store numbers from 0 to 1 (for X and Y independently) that governs how much this object is affected by the camera subsystem.	FlxObject
		solid : Boolean If an object is dead, the functions that automate collisions will skip it (see FlxG.overlapArrays() and FlxG.collideArrays()).	FlxObject
		thrust : Number If you want to do Asteroids style stuff, check out thrust, instead of directly accessing the object's velocity or acceleration.	FlxObject
		top : Number [read-only] The Y coordinate of the top of the rectangle.	FlxRect
		velocity : FlxPoint The basic speed of this object.	FlxObject
		visible : Boolean If an object is not visible, the game loop will not automatically call render() on it.	FlxObject
		width : Number	FlxRect
		x : Number	FlxPoint
		y : Number	FlxPoint

Protected Properties

Hide Inherited Protected Properties

Show Inherited Protected Properties

	Property		Defined By
		_alpha : Number	FlxSprite
		_bakedRotation : Number	FlxSprite
		_caf : uint	FlxSprite
		_callback : Function	FlxSprite
		_color : uint	FlxSprite
		_complete : Function Callback for when the effect is finished.	FlxFade
		_ct : ColorTransform	FlxSprite
		_curAnim : FlxAnim	FlxSprite
		_curFrame : uint	FlxSprite
		_delay : Number How long the effect should last.	FlxFade
		_facing : uint	FlxSprite
		_flashPoint : Point This is a pre-allocated Flash Point object, which is useful for certain Flash graphics API calls	FlxObject
		_flashPointZero : Point	FlxSprite
		_flashRect : Rectangle	FlxSprite
		_flashRect2 : Rectangle	FlxSprite
		_flicker : Boolean Internal helper used for retro-style flickering.	FlxObject
		_flickerTimer : Number Internal helper used for retro-style flickering.	FlxObject
		_flipped : uint	FlxSprite
		_frameTimer : Number	FlxSprite
		_mtx : Matrix	FlxSprite
		_pixels : BitmapData	FlxSprite
		_point : FlxPoint This is just a pre-allocated x-y point container to be used however you like	FlxObject
		_rect : FlxRect This is just a pre-allocated rectangle container to be used however you like	FlxObject

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		FlxFade() Constructor initializes the fade object	FlxFade
		addAnimation(Name:String, Frames:Array, FrameRate:Number = 0, Looped:Boolean = true):void Adds a new animation to the sprite.	FlxSprite
		addAnimationCallback(AnimationCallback:Function):void Pass in a function to be called whenever this sprite's animation changes.	FlxSprite
		applyFilter(filter:*):void	FlxSprite
		collide(Object:FlxObject = null):Boolean	FlxObject
		createGraphic(Width:uint, Height:uint, Color:uint = 0xffffffff, Unique:Boolean = false, Key:String = null):FlxSprite This function creates a flat colored square image dynamically.	FlxSprite
		destroy():void Called by FlxGroup, commonly when game states are changed.	FlxObject
		draw(Brush:FlxSprite, X:int = 0, Y:int = 0):void This function draws or stamps one FlxSprite onto another.	FlxSprite
		fill(Color:uint):void Fills this sprite's graphic with a specific color.	FlxSprite
		flicker(Duration:Number = 1):void Tells this object to flicker, retro-style.	FlxObject
		flickering():Boolean Check to see if the object is still flickering.	FlxObject
		getScreenXY(Point:FlxPoint = null):FlxPoint [override] Call this function to figure out the on-screen position of the object.	FlxSprite
		hitBottom(Contact:FlxObject, Velocity:Number):void Called when this object's bottom edge collides with the top of another FlxObject.	FlxObject
		hitLeft(Contact:FlxObject, Velocity:Number):void Called when this object's left side collides with another FlxObject's right.	FlxObject
		hitRight(Contact:FlxObject, Velocity:Number):void Called when this object's right side collides with another FlxObject's left.	FlxObject
		hitTop(Contact:FlxObject, Velocity:Number):void Called when this object's top collides with the bottom of another FlxObject.	FlxObject
		hurt(Damage:Number):void Call this function to "damage" (or give health bonus) to this sprite.	FlxObject
		kill():void Call this function to "kill" a sprite so that it no longer 'exists'.	FlxObject
		loadExtGraphic(Graphic:Bitmap, Animated:Boolean = false, Reverse:Boolean = false, Width:uint = 0, Height:uint = 0, Unique:Boolean = false, Key:String = null):FlxSprite	FlxSprite
		loadGraphic(Graphic:Class, Animated:Boolean = false, Reverse:Boolean = false, Width:uint = 0, Height:uint = 0, Unique:Boolean = false):FlxSprite Load an image from an embedded graphic file.	FlxSprite
		loadRotatedGraphic(Graphic:Class, Rotations:uint = 16, Frame:int = -1, AntiAliasing:Boolean = false, AutoBuffer:Boolean = false):FlxSprite Create a pre-rotated sprite sheet from a simple sprite.	FlxSprite
		onEmit():void Triggered whenever this sprite is launched by a FlxEmitter.	FlxSprite
		onScreen():Boolean Check and see if this object is currently on screen.	FlxObject
		overlaps(Object:FlxObject):Boolean Checks to see if some FlxObject object overlaps this FlxObject object.	FlxObject
		overlapsPoint(X:Number, Y:Number, PerPixel:Boolean = false):Boolean [override] Checks to see if a point in 2D space overlaps this FlxCore object.	FlxSprite
		play(AnimName:String, Force:Boolean = false):void Plays an existing animation (e.g.	FlxSprite
		playFromFrame(StartFrame:int = 0):void Plays the current Animation from a specific frame	FlxSprite
		preCollide(Object:FlxObject):void FlxU.collide() (and thus FlxObject.collide()) call this function each time two objects are compared to see if they collide.	FlxObject
		randomFrame():void Tell the sprite to change to a random frame of animation Useful for instantiating particles or other weird things.	FlxSprite
		refreshHulls():void Called by FlxObject.updateMotion() and some constructors to rebuild the basic collision data for this object.	FlxObject
		removeFilter(filter:*):void Call this function to remove one (or more) filters from the sprite	FlxSprite
		removeFirstFilter():void Call this function to remove the last filter that was applied	FlxSprite
		removeLastFilter():void Call this function to remove the last filter that was applied	FlxSprite
		render():void [override] Called by game loop, updates then blits or renders current frame of animation to the screen	FlxSprite
		reset(X:Number, Y:Number):void Handy function for reviving game objects.	FlxObject
		setFilter(filter:*):void Call this function to add a filter to the sprite	FlxSprite
		start(Color:uint = 0xff000000, Duration:Number = 1, FadeComplete:Function = null, Force:Boolean = false):void Reset and trigger this special effect	FlxFade
		stop():void Stops and hides this screen effect.	FlxFade
		toString():String Convert object to readable string name.	FlxPoint
		unsafeBind(Pixels:BitmapData):void Internal function, currently only used to quickly update FlxState.screen for post-processing.	FlxSprite
		update():void [override] Updates and/or animates this special effect	FlxFade
		updateAnimation():void Internal function for updating the sprite's animation.	FlxSprite

Protected Methods

Show Inherited Protected Methods

	Method		Defined By
		calcFrame():void Internal function to update the current animation frame.	FlxSprite
		renderSprite():void Internal function that performs the actual sprite rendering, called by render().	FlxSprite
		resetHelpers():void Resets some important variables for sprite optimization and rendering.	FlxSprite
		updateFlickering():void Just updates the retro-style flickering.	FlxObject
		updateMotion():void Internal function for updating the position and speed of this object.	FlxObject

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined By
		DOWN : uint = 3 [static] Useful for checking player orientation.	FlxSprite
		LEFT : uint = 0 [static] Useful for controlling flipped animations and checking player orientation.	FlxSprite
		RIGHT : uint = 1 [static] Useful for controlling flipped animations and checking player orientation.	FlxSprite
		UP : uint = 2 [static] Useful for checking player orientation.	FlxSprite

Protected Constants

Hide Inherited Protected Constants

Show Inherited Protected Constants

	Constant		Defined By
		_pZero : FlxPoint [static] A handy "empty point" object	FlxObject

Property Detail

_complete

property

protected var _complete:Function

Callback for when the effect is finished.

_delay

property

protected var _delay:Number

How long the effect should last.

Constructor Detail

FlxFade

()

Constructor

public function FlxFade()

Constructor initializes the fade object

Method Detail

start

()

method

 public function start(Color:uint = 0xff000000, Duration:Number = 1, FadeComplete:Function = null, Force:Boolean = false):void

Reset and trigger this special effect

Parameters

	`Color:uint` (default = `0xff000000`) — The color you want to use

	`Duration:Number` (default = `1`) — How long it should take to fade the screen out

	`FadeComplete:Function` (default = `null`) — A function you want to run when the fade finishes

	`Force:Boolean` (default = `false`) — Force the effect to reset

stop

()

method

public function stop():void

Stops and hides this screen effect.

update

()

method

override public function update():void

Updates and/or animates this special effect

Sun Apr 17 2011, 12:17 AM -07:00

API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
FlxFade	Properties \| Methods \| Constants

Package	org.flixel.data
Class	public class FlxFade
Inheritance	FlxFade FlxSprite FlxObject FlxRect FlxPoint Object