KinsonDigital / Velaptor

2D game development framework
https://docs.velaptor.io
MIT License
70 stars 16 forks source link

🚧Add scene navigation behavior #955

Closed CalvinWilkinson closed 5 days ago

CalvinWilkinson commented 4 months ago

Complete The Item Below

Description

Add the following navigation behaviors to the scene system.

  1. Add a bool property with a default value of true and the name UsesNavigationWrapping
    • This property if set to true will automatically navigate to the beginning or last scene when calling the ISceneManager.NextScene() or ISceneManager.PreviousScene() methods. If false, clicking the next scene on the last scene will not navigate to the first scene, but stay on the last scene
  2. Add an int readonly property with the name CurrentSceneIndex which represents the index of the current scene

Reason: This is to help give users more control over managing scenes.

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 property `UsesNavigationWrapping` has been added to the scene manager
- [x] The property `CurrentSceneIndex` has been added to the scene manager

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