Make PhysicsLayer
require a #[default]
variant
#494
Merged
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.
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 requireDefault
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 deriveDefault
and specify a default layer using the#[default]
attribute.Before:
After:
The default layer always has the bit value
0b0001
regardless of its order relative to the other variants.