Use a single layer as the default membership instead of all. #476
Conversation
There was a problem hiding this comment.
Bit of a footgun regarding implicitness, but then again Bevy does the exact same thing with RenderLayers, so we are at least consistent.
In any case, this is way better then the current behavior, as I can just tell my Sensors to filter out CollisionLayers::DEFAULT.
It's a footgun the current way too since you cannot actually ignore the default objects ever. E.g. you shape cast for a dumpster or interactable infront of the player, but it'll just return any physics object it touches aside from custom ones. |
|
@Aceeri yes, I definitely agree |
There was a problem hiding this comment.
I've let this sit for a while (sorry about that!) but I'm largely in favor of this. I pushed a quick commit to fix some docs, and to add a Default variant to the enums, since imo it doesn't make sense for the Ground layer to be the default layer that everything belongs to. I hope that's fine; if you disagree on something, we can revert.
One thing I don't really like is how implicit the default is with the enum-based approach. For a follow-up, I think it could be interesting to require users to explicitly derive Default and specify the default layer with the #[default] attribute. I have this implemented already, so I'll put up a PR for consideration after this is merged.
Yeah I was considering that might be better and initially just changed the derive macro start at 2 instead of 1, but I agree with all those changes. |
# Objective #476 changed collision layers to reserve the first bit for a default layer. However, for enums implementing `PhysicsLayer`, the default layer is rather implicit and potentially footgunny. The default layer should ideally be more explicit. ## Solution Change `PhysicsLayer` to require `Default` to be implemented. The proc macro orders the variants such that the layer set as the default is always the first bit. Note that `Default` *must* currently be derived instead of implemented manually, as the macro can only access the default variant if the `#[default]` attribute exists. An error is emitted if `#[default]` does not exist. If someone knows a way to make it work with the manual impl, let me know or consider opening a PR! I also added documentation for the `PhysicsLayer` macro, and improved error handling. --- ## Migration Guide Enums that derive `PhysicsLayer` must now also derive `Default` and specify a default layer using the `#[default]` attribute. Before: ```rust #[derive(PhysicsLayer)] enum GameLayer { Player, Enemy, Ground, } ``` After: ```rust #[derive(PhysicsLayer, Default)] enum GameLayer { #[default] Default, // The name doesn't matter, but Default is used here for clarity Player, Enemy, Ground, } ``` The default layer always has the bit value `0b0001` regardless of its order relative to the other variants. --------- Co-authored-by: Jan Hohenheim <jan@hohenheim.ch>
Objective
Using
ALLmemberships requires a lot more effort to correctly use the layer system in gameplay, since interactions you wanted exclusive to one object now trigger on all defaulted objects as well.This system is similar to those used in Box2d (one memberships, all filters) and Godot (one memberships, one filters),
however the current system is the same as Rapier and Unity (all memberships, all filters).Unity is actually exclusively one membership, all filters with configurable filters in your project.Solution
1 << 0for a default layer.- Adjustkeep it the same, just document the change, this shouldn't actually change any behavior aside from other special interactions relying on the default being all membership (which should be few and might indicate a bug)PhysicsLayerderive to start at1 << 1.Additional Questions
- Should we use the default layer for filters as well?No, this doesn't make sense unless we swap to using || for the calculation and/or allow default configuration as it forbids some valid usecases like a default member not interacting with default.
Changelog
1 << 0as a defaultLayerMask, defaultCollisionLayersnow only includes a single bit for membership, while including all bits for filters.Migration Guide
1 << 0/1collision layer is fine with being a default membership, you may need to add aCollisionLayerscomponent to entities that have did not have one before to allow interactions to happen again. However this may also indicate a bug in logic.