Implement wasDestroyed check on FlxGraphic
#2968
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Geokureli
requested changes
Nov 18, 2023
There was a problem hiding this comment.
see comments below also:
I'm wondering if we should do something even sooner, perhaps we should check in draw(), check whether the sprite was destroyed or the graphic, use FlxG.log.error, and then set the sprite's visible to false to prevent repeating errors?
| @@ -635,6 +635,11 @@ class FlxCamera extends FlxBasic | |||
| itemToReturn = new FlxDrawItem(); | |||
| } | |||
|
|
|||
| if (graphic.wasDestroyed) { | |||
| // Throw an exception here, because throwing in `FlxDrawQuadsItem.render()` is not helpful. | |||
| throw 'Attempted to queue invalid FlxDrawItem, did you dispose of a cached sprite?'; | |||
There was a problem hiding this comment.
i want to avoid the word dispose, and just use the word "destroy" consistently. since that's the function they are likely calling
| @@ -635,6 +635,11 @@ class FlxCamera extends FlxBasic | |||
| itemToReturn = new FlxDrawItem(); | |||
| } | |||
|
|
|||
| if (graphic.wasDestroyed) { | |||
| */ | ||
| public var wasDestroyed(get, never):Bool; | ||
|
|
||
| function get_wasDestroyed():Bool { |
| @@ -115,6 +115,12 @@ class FlxDrawQuadsItem extends FlxDrawBaseItem<FlxDrawQuadsItem> | |||
| return; | |||
|
|
|||
| var shader = shader != null ? shader : graphics.shader; | |||
|
|
|||
| if (shader == null) { | |||
|
|
||
| if (shader == null) { | ||
| // If this gets called, the check for `graphic.wasDestroyed` in FlxCamera failed. | ||
| throw 'Attempted to render invalid FlxDrawItem, did you dispose of a cached sprite?'; |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When attempting to render a destroyed graphic (which is wrong and the library user needs to diagnose the issue), determining which sprite was the cause of the issue is difficult, due to the error taking place long after the draw is queued. This change ensures that the error is thrown WHEN the sprite's
draw()call is performed rather than after; this allows developers to step up toFlxSprite.draw()when debugging and view the affected sprite in the local variable scope.