[X] I have updated the title without removing the 🚧 emoji.
Description
Update the content API by removing various areas of the API to force the user to use the content loading system.
Benefits:
Less public API to maintain
Reduced change of breaking changes due to the minimization of the public API
Less confusion on how to load content for the user.
Remove the following:
Change the single public constructor in the AtlasData class to internal - BREAKING CHANGE
Remove the public constructor in the AudioLoader class.
Remove the public constructor in the FontLoader class.
Remove the public constructor in the AtlasLoader class.
Remove the public constructor in the TextureLoader class.
Acceptance Criteria
### The items to complete to satisfy the Definition of Done.
- [x] All unit tests executed and passed locally after PR work is complete. _(Why? Refer to 'Additional Information' below.)_
- [x] The single `public` constructor in the `AtlasData` class has been set to `internal` - BREAKING CHANGE
- [x] The `public` constructor in the `AudioLoader` class has been removed. - BREAKING CHANGE
- [x] The `public` constructor in the `FontLoader` class has been removed. - BREAKING CHANGE
- [x] The `public` constructor in the `AtlasLoader` class has been removed. - BREAKING CHANGE
- [x] The `public` constructor in the `TextureLoader` class has been removed. - BREAKING CHANGE
- [x] `AudioLoader` class set to `internal` - BREAKING CHANGE
- [x] `FontLoader` class set to `internal` - BREAKING CHANGE
- [x] `AtlasLoader` class set to `internal` - BREAKING CHANGE
- [x] `TextureLoader` class set to `internal` - BREAKING CHANGE
ToDo Items
### The items to complete to satisfy the Definition of Done.
- [x] Change type labels added to this issue. Refer to the _**Change Type Labels**_ section below.
- [x] Priority label added to this issue. Refer to the _**Priority Type Labels**_ section below.
- [x] Issue linked to the correct milestone _(if applicable)_.
Issue Dependencies
No response
Related Work
No response
Additional Information:
Unit Tests
Reasons for local unit test execution:
Unit tests might pass locally but not in the CI environment during the status check process or vice-versa.
Tests might pass on the developer's machine but not necessarily on the code reviewer's machine.
If you notice that the test status check has passed but the test failed locally, please notify a project maintainer!
💡Warning💡
If the unit tests pass remotely and are not executed locally, this means we could be letting a bug slip into production.
Though bugs will always exist in some capacity, we should all do our part to help prevent them from happening.
Change Type Labels
Change Type
Label
Bug Fixes
🐛bug
Breaking Changes
🧨breaking changes
New Feature
✨new feature
CICD Changes
♻️cicd
Config Changes
⚙️config
Performance Improvements
🏎️performance
Code Doc Changes
🗒️documentation/code
Product Doc Changes
📝documentation/product
Priority Type Labels
Priority Type
Label
Low Priority
low priority
Medium Priority
medium priority
High Priority
high priority
Code of Conduct
[X] I agree to follow this project's Code of Conduct.
Complete The Item Below
Description
Update the content API by removing various areas of the API to force the user to use the content loading system.
Benefits:
Remove the following:
public
constructor in theAtlasData
class tointernal
- BREAKING CHANGEpublic
constructor in theAudioLoader
class.public
constructor in theFontLoader
class.public
constructor in theAtlasLoader
class.public
constructor in theTextureLoader
class.Acceptance Criteria
ToDo Items
Issue Dependencies
No response
Related Work
No response
Additional Information:
Unit Tests
Reasons for local unit test execution:
💡Warning💡 If the unit tests pass remotely and are not executed locally, this means we could be letting a bug slip into production. Though bugs will always exist in some capacity, we should all do our part to help prevent them from happening.
Change Type Labels
🐛bug
🧨breaking changes
✨new feature
♻️cicd
⚙️config
🏎️performance
🗒️documentation/code
📝documentation/product
Priority Type Labels
low priority
medium priority
high priority
Code of Conduct