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

[Enhancement]: Update to use the new ChangeHistoryService API #32

Open
1 task done
RyanLua opened this issue Aug 7, 2023 · 0 comments
Open
1 task done

[Enhancement]: Update to use the new ChangeHistoryService API #32

RyanLua opened this issue Aug 7, 2023 · 0 comments
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@RyanLua
Copy link
Owner

RyanLua commented Aug 7, 2023

Contact Details

No response

Is your feature request related to a problem?

ChangeHistoryService:SetWaypoint will get deprecated soon according to https://devforum.roblox.com/t/2512500. Soon problems will arise from using the deprecated API.

Timeline

It will take time for both your plugins and our internal Studio code to migrate towards this new Recording API, and there will be a transitional period where both APIs are in use. Here’s our planned timeline for the migration:

  • Now
    • You can update your plugins to use the Recording API.
    • We will begin updating Studio to internally use the Recording API.
  • In the coming months
    • SetWaypoint will be deprecated assuming a smooth migration.
    • Calls to SetWaypoint will warn that you should migrate to the new API.
    • Studio systems such as the Package system will begin relying on the new API and possibly have degraded interactions with plugins that haven’t migrated.
  • Long term:
    • We want to internally replace the Waypoint system entirely with the Recording system. We’ll evaluate how to proceed on an ongoing basis depending on developer feedback and how the migration is progressing.

Describe the solution you'd like

Usage of the new ChangeHistoryService API with a migration to use ChangeHistoryService:TryBeginRecording and ChangeHistoryService:FinishRecording.

Describe alternatives you've considered

No response

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct
@RyanLua RyanLua added the enhancement New feature or request label Aug 7, 2023
@RyanLua RyanLua self-assigned this Aug 7, 2023
@RyanLua RyanLua added this to the v3.2.0 milestone Aug 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: In Progress
Development

No branches or pull requests

1 participant