PaperMC / PaperMC/Folia

API: Location Tick Times

Open
#31 1 comment 6 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

status: needs triage type: feature
Dominant language
Shell
Stars
4.4k
Forks
623
PR merge metrics
No merged PRs in 30d

Description

Is your feature request related to a problem?

As a regionised server software, we don't know what current API Bukkit#getTickTimes, Bukkit#getAverageTickTime and Bukkit#getTPS should return.
It might be great to get significative TPS info based on region tick times.

Describe the solution you'd like.

Deprecate Bukkit#getTickTimes and Server#getTickTimes
Deprecate Bukkit#getAverageTickTime and Server#getAverageTickTime
Deprecate Bukkit#getTPS and Server#getTPS
Add Bukkit.getTickTimes(@NotNull Location): Give Tick Times based on Location Region Tick Times

Describe alternatives you've considered.

Bukkit.getTickTimes(@NotNull Entity): Give Tick Times based on Entity Region Tick Times
Same with getTPS getAverageTickTimes.

Other

No response

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the existing Bukkit and Server declarations for getTickTimes, getAverageTickTime, and getTPS, then trace how region tick times are exposed. Define the Location-based behavior and deprecation scope before changing the API; done means the new contract is documented and its behavior is covered by appropriate tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.