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

Refactor serialization and deserialization #21

Merged
merged 1 commit into from
Jul 10, 2024

Conversation

shomykohai
Copy link
Owner

@shomykohai shomykohai commented Jul 10, 2024

Summary

This PR aims to refactor the Serialization/Deserialization process.

  • Updated how serialize_quests() works -> Now the serialization process is done by the Quest itself, the manager just calls it and retrieve the serialized data. It's suggested to override this method for better control over the process.
  • Added deserialize_quests to the quest manager ->As for serialize_quests, it calls a method on the quest.
  • Added get_all_pools() to the quest manager.
  • Added get_pool to the quest manager.
  • Added get_all_quests() to BaseQuestPool

Documentation

  • Updated documentation to reflect the changes listed above
  • Added more documentation inside of the addon itself.

Closes #20

Checklist

  • This PR changes something in the code (e.g. for better performance).
    • If any code changes had taken place, I've tested them before committing.
    • I've properly updated the documentation to reflect the changes I've made.
  • This PR adds something new.
  • This PR fixes an issue.
  • This PR includes breaking changes.
  • This PR is not code related (e.g. README, Documentation)

@shomykohai shomykohai added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 10, 2024
@shomykohai shomykohai linked an issue Jul 10, 2024 that may be closed by this pull request
@shomykohai
Copy link
Owner Author

This does not change quests_as_dict and dict_to_quests method name as planned in #20 as it could lead to breaking changes.
The methods name will be changed in future versions.

@shomykohai shomykohai merged commit 6e38e78 into main Jul 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Refactor serialization and deserialization system
1 participant