Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Undocumented DefaultRaycastingPlugin vs. DeferredRaycastingPlugin #105

Closed
djeedai opened this issue Dec 14, 2023 · 3 comments
Closed

Undocumented DefaultRaycastingPlugin vs. DeferredRaycastingPlugin #105

djeedai opened this issue Dec 14, 2023 · 3 comments

Comments

@djeedai
Copy link

djeedai commented Dec 14, 2023

Hi,

I upgraded to 0.16 from an earlier version where I was using DefaultRaycastingPlugin, and nothing worked, the RaycastSource ray was always None. Turns out build_rays() was not called because I needed instead DeferredRaycastingPlugin::<T>. But this doesn't seem to be explained anywhere, and DefaultRaycastingPlugin is not documented either.

Switching to DeferredRaycastingPlugin::<T> instead solved everything. Maybe there should be some mention in the docs?

@aevyrie
Copy link
Owner

aevyrie commented Dec 16, 2023

This was mentioned in the changelog for 0.15. There is also extensive documentation at the root of the crate explaining the two APIs and how to choose them: https://docs.rs/bevy_mod_raycast/latest/bevy_mod_raycast/

@djeedai
Copy link
Author

djeedai commented Dec 16, 2023

I understand the difference between the two APIs, but I don't see any mention of DefaultRaycastingPlugin at the crate root, and I don't understand how that plugin is related to the choice of an API (since it's called "default").

@aevyrie
Copy link
Owner

aevyrie commented Jun 11, 2024

Addressed with a rename and docs in 0.18.0-rc.0

@aevyrie aevyrie closed this as completed Jun 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants