feat: create tick-based task system #382
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
feat: don't add task if already active refactor: rename addTask to enqueue feat: handle stacking/overriding of tasks feat: add a BreakType property to tasks feat: add a clear() method to the scheduler feat: create TaskStackGroup enum feat: add onStop callback to Task refactor: create TaskConfig container type feat: create ActorTask and WalkToTask feat: make breakType an array feat: allow `execute` to return a bool indicating task termination feat: create Task subclasses for Actor
This also refactors the `Player.loggedIn` property into an `Actor.active` property so that I can use it in the generic `Actor`-level task processing refactor: move active to base Actor class, create init/destroy methods feat: add a scheduler to Actor feat: add a scheduler to World
docs: fix Task docs docs: update task README with impl plan docs: update @engine/task progress
fix: fix enqueueTask for only 1 arg fix: support enqueueTask for a task with 0 params (besides Actor)
fix: export ActorLandscapeObjectInteractionTask to index
docs: add docs around Task configuration docs: add docs on task subtypes docs: update progress tracker docs: update documentation
SchauweM
added
documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR implements a tick-based task system for
Actors(Player/Npc) and theWorld.The main practical difference between this implementation and the previous
Behavioursystem is that the tasks here are synchronized for all entities in the world, and delays are handled by tick count rather than by milliseconds.There are a number of configuration options for a
Taskas well as some useful subtasks. You can read more about these in the attachedREADME.mdfile. The current set of subtasks is a starting point, and we will surely want to create more for more interaction types.If you'd like to see how content is written in this new task system, there are some PRs on my fork that you can view: https://github.com/Jameskmonger/runejs-server/pulls
There are a number of
TODOsaround adding unit tests, I would like to propose that we keep these included for now - currently the areas are difficult to test due to complications with mocking the player class, but I have been working on other PRs to improve this.