| Package | org.flixel.data |
| Class | public class FlxFlash |
| Inheritance | FlxFlash  FlxSprite FlxObject FlxRect FlxPoint Object |
| 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. | FlxFlash | ||
| _ct : ColorTransform | FlxSprite | |
| _curAnim : FlxAnim | FlxSprite | |
| _curFrame : uint | FlxSprite | |
| _delay : Number
How long the effect should last. | FlxFlash | ||
| _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 | |
| Method | Defined By | ||
|---|---|---|---|
FlxFlash()
Constructor for this special effect
| FlxFlash | ||
| 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 | |
| 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 | |
|
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 | |
| [override]
Call this function to figure out the on-screen position of the object. | FlxSprite | |
|
Called when this object's bottom edge collides with the top of another FlxObject. | FlxObject | |
|
Called when this object's left side collides with another FlxObject's right. | FlxObject | |
|
Called when this object's right side collides with another FlxObject's left. | FlxObject | |
|
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 | |
|
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 = 0xffffffff, Duration:Number = 1, FlashComplete:Function = null, Force:Boolean = false):void
Reset and trigger this special effect
| FlxFlash | ||
stop():void
Stops and hides this screen effect. | FlxFlash | ||
| 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
| FlxFlash | ||
| updateAnimation():void
Internal function for updating the sprite's animation. | FlxSprite | |
| _complete | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesprotected var _complete:FunctionCallback for when the effect is finished.
| _delay | property |
protected var _delay:NumberHow long the effect should last.
| FlxFlash | () | Constructor |
public function FlxFlash()Constructor for this special effect
| start | () | method |
public function start(Color:uint = 0xffffffff, Duration:Number = 1, FlashComplete:Function = null, Force:Boolean = false):voidReset and trigger this special effect
Parameters
Color:uint (default = 0xffffffff) | |
Duration:Number (default = 1) | |
FlashComplete:Function (default = null) | |
Force:Boolean (default = false) |
| stop | () | method |
public function stop():voidStops and hides this screen effect.
| update | () | method |
override public function update():voidUpdates and/or animates this special effect