feat: Add a hitboxFilter argument to raycast() #2968
Merged
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
Adds a new argument callback to all `raycast*` methods that lets the user ignore hitboxes dynamically. The callback is called with every prospective hitbox, and the hitbox is only considered when the callback returns `true`. This is faster, in the general case, than the current `ignoreHitboxes` aproach. And it lets the developer have dynamic rules about what the rays collide with. (For example, a line-of-fire raycast should take friendlies into account, but could easily ignore other enemies that get in the way.) Fixes flame-engine#2966.
|
Thanks! Just a reminder that I don't have commit rights here so you'll have to land this yourself when you're happy. |
Yep, only Blue Fire has merging rights here. |
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.
Description
Adds a new argument callback to all
raycast*methods that lets the user ignore hitboxes dynamically. The callback is called with every prospective hitbox, and the hitbox is only considered when the callback returnstrue.This is faster, in the general case, than the current
ignoreHitboxesaproach. And it lets the developer have dynamic rules about what the rays collide with. (For example, a line-of-fire raycast should take friendlies into account, but could easily ignore other enemies that get in the way.)Checklist
docsand added dartdoc comments with///.examplesordocs.Breaking Change?
For people who just use raycasts, this is not a breaking change.
People who extend
CollisionDetectionwill need to support the new argument. I'd say this is pretty rare but not unheard of.If you have your own custom collision detection logic (a class implementing or extending Flame's
CollisionDetection), you'll have to update its threeray*methods. Add the new argument to the baseraycast()method and make sure that the ray actually only collides with hitboxes that returntruefromhitboxFilter(). The other two methods (raycastAll()andraytrace()) will, in most cases, just callraycast(), so just make sure you pass the argument.Related Issues
Closes #2966