Introduce sceneOnly flag for components #5465
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.
Description:
There are a couple of components intended to be used on
<a-scene>
exclusively. These reside insrc/components/scene
, but little prevents people from (accidentally) using them on other entities. Only thefog
component performed a check that it was applied to the scene.Instead of adding similar checks to all these components, this PR introduces a
sceneOnly
flag that components can set in their definition. Similar to themultiple
flag this will throw when asceneOnly
component is being added to an entity that isn't the scene.Changes proposed:
sceneOnly
flag in property definitionsceneOnly
components are only added to<a-scene>
otherwise throw an Error