FlxG.as line 738,743 undefined property bitmapData

[FlixelCommunityBot]

Issue #217 by: kreso22

My editor caught it (Access of undefined property bitmapData)

        _cache[Key] = (new Graphic).bitmapData;
            if(Reverse)
                needReverse = true;
        }
        var pixels:BitmapData = _cache[Key];
        if(!needReverse && Reverse && (pixels.width == (new Graphic).bitmapData.width))

[FlixelCommunityBot]

Comment by: IQAndreas

The "Graphic" you pass in should be a Class that extends Bitmap (NOT ByteArray or BitmapData).

What does your code look like?

[moly]

There should be a more descriptive error message if the user passes in an invalid class. It might also be better to have the function return the default graphic rather than throwing an exception. I'm thinking something like:

if(!checkBitmapCache(Key))
{
    var bitmap:Bitmap = new Graphic() as Bitmap;
    if(bitmap == null)
    {
        FlxG.log("Error: " + Graphic + " must extend flash.display.Bitmap.");
        return FlxG.addBitmap(FlxSprite.ImgDefault);
    }
    _cache[key] = bitmap.bitmapData;
}

[IQAndreas]

There should be a more descriptive error message if the user passes in an invalid class.

Good idea!

"Error: " + Graphic + " must extend flash.display.Bitmap."

Of course, with the old code, you could pass in any class as long as it has a bitmapData property. It didn't have to be a Bitmap. There could be cases where this could come in handy, such as if the BitmapData is generated rather than loaded through a Loader.

Though, in such a case, it may be better adding another method named addBitmapData where you can explicitly pass in the BitmapData instance rather than a class.

[Dovyski]

I liked the warning message @moly suggested. About the the bitmapData property @IQAndreas said, I agree it might be better idea to create a method named addBitmapData() to explicity pass in the BitmapData rather than a class.

[IQAndreas]

@Dovyski I noticed you were assigned to this issue. Do you already have the code ready for this fix, or shall I write some up and add the pull request?

I think we should separate off adding the error message in this release, and adding the addBitmapData() function to the next release.

[Dovyski]

I am sorry, I assigned this issue to me but stopped working when I noticed there would be some conflicts during the merge. I did nothing so far, @IQAndreas , so feel free to implement what was discussed. Bare in mind there are some pending pull requests that affect that very area of the code.

I agree with you about the error message and the new method. Leave addBitmapData() for the next release.

[IQAndreas]

I assigned this issue to me but stopped working when I noticed there would be some conflicts during the merge.

It seems that all pull requests that modify FlxG have been merged by now, so I'll go ahead and add a pull request for this one.

[IQAndreas]

I made two additional tweaks in the pull requst:

• Added getClassName to make the log ouput clearer
• Passed along the "reverse" parameter to the "default image" sprite. I think it might make a difference?

[Dovyski]

The getClassName() will be really useful.

About the "reverse", I can't tell if that makes any difference. In the context of the fix, the default image is just a "placeholder", so it's not that important to reverse it or not.

[IQAndreas]

Resolved by 58f1e1f