feat!: Make Timer and TimerComponent APIs consistent - #4076
Merged
Merged
Conversation
Timer now takes a required named `period` (renamed from the positional `limit`), matching TimerComponent. TimerComponent.onTick is removed and the provided callback is set directly on the internal Timer. Fixes #2386 Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
spydon
approved these changes
Sep 30, 2026
spydon
left a comment
Member
There was a problem hiding this comment.
Lgtm, why did we build it that inconsistent to begin with... 😆
Timer and TimerComponent APIs consistent
This file contains hidden or 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
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.
Description
Makes the
TimerandTimerComponentAPIs consistent.Previously
TimerComponenttook a namedperiod, whileTimertook a positionallimit. Also,TimerComponentexposed a publiconTickmethod that wrapped the user callback, which could go out of sync withTimer.onTick.Changes:
Timernow takes a required namedperiod(was positionallimit), and theTimer.limitfield is renamed toTimer.period.TimerComponent.onTick()is removed. The callback passed to the constructor is set directly on the internaltimer, andtickWhenLoadedcallstimer.onTick.SpawnComponent,HasBehaviorTree, docs, examples and tests accordingly.Checklist
docsand added dartdoc comments with///.examplesordocs.Breaking Change?
Migration instructions
If the PR is breaking, uncomment this header and add instructions for how to migrate from the
currently released version in-between the two following tags:
Before:
After:
Related Issues
Closes #2386