Add Scheduler by Nacioszeczek · Pull Request #143 · PaperMC/docs

Nacioszeczek · 2023-03-17T15:42:14Z

Resolves #102

olijeffers0n

I’m assuming this is still a WIP due to it ending abruptly and it being a draft PR, but here are a couple comments.

…le` and `Consumer<BukkitTask>`

Machine-Maker · 2023-03-17T17:03:24Z

A large part of the scheduler is being able to do things off the main thread. But this is barely explained in the PR. Is that intentional? Cause I feel like talking about "async" here makes a lot of sense.

Nacioszeczek · 2023-03-17T17:09:11Z

@Machine-Maker do you mean sth like explain the definition of sync and async in the scheduler's case? atm the plan would be to add quite a few different sections with different examples for delayed, repeating, both sync and async, stuff like cancelling a repeating task some time later

and the PR is WIP like Ollie said

Machine-Maker · 2023-03-17T17:10:23Z

Yeah, I think the concept of "async" isn't very well understood, along with its limitations when interacting with "world state". But sounds like you have plans, I just think in addition to example sections, there should be a blurb on what "async" means in this context. You have async to the main thread, but also async in a general context, means smth like on a different thread than where this code is currently running.

olijeffers0n · 2023-03-17T20:47:42Z

Yep, as MM says explaining the concept behind the event loop and the pros/cons async is vital.

I think the page name could be better in the sidebar. Even if it is just “The Scheduler” it would be better as just “Scheduler” looks weird IMO.

Nacioszeczek · 2023-03-19T09:44:47Z

@Machine-Maker I assume the BukkitScheduler executes the async tasks at the start/end of a tick (on separate threads) therefore is still somewhat affected if mspt exceeds 50ms, and your own ScheduledExService wouldn't care at all?
I just think ScheduledExecutorService is worth mentioning somewhere in this doc as an alternative

Nacioszeczek · 2023-03-19T09:45:17Z

@olijeffers0n wanna elaborate? Not sure I understood what you mean

the concept behind the event loop

Nacioszeczek · 2023-05-13T10:57:48Z

Waiting for any suggestions, some criticism, etc. since I'm somewhat out of ideas for this;

also making ready to review since IMHO asynchronous tasks examples are not really needed since that would be just repeating the synchronous examples with different method names

olijeffers0n · 2023-05-13T11:07:59Z

Looks good, is it worth mentioning bukkit runnables?

Nacioszeczek · 2023-05-13T11:43:23Z

All scheduler methods that take BukkitRunnable are deprecated and the methods on BukkitRunnable itself I'm not a fan of because calling static stuff

Maybe could add it to the part about actually implementing Runnable in a separate class? So that people don't make anonymous classes which I'm also not a fan of

kennytv · 2023-06-05T17:17:41Z

+	server.broadcast(Component.text("Hello, World!"));
+}, 10 * 20, 5 * 20);
+
+scheduler.runTaskLater(plugin, () -> task.cancel(), TimeUnit.MINUTES.toSeconds(10) * 20);


This is kind of dank, it should refer back to using the consumer or extending bukkitrunnable and deciding in the task when to cancel itself

Not sure that's what you meant but changed

Nacioszeczek · 2023-06-27T03:14:16Z

Gonna get to it soon

olijeffers0n

Looks like its pretty much there, just a few suggestions really.

olijeffers0n · 2023-07-16T13:32:45Z

+slug: /dev/scheduler
+---
+
+# Task Scheduler


Why is the page called task scheduler if you immediately refer to it with the BukkitScheduler name. Maybe just name the page "The Bukkit Scheduler" or something along those lines?

I'd prefer something like Scheduling tasks over including Bukkit in the name

olijeffers0n · 2023-07-16T13:33:16Z

+
+# Task Scheduler
+
+The `BukkitScheduler` can be used to schedule your code to be run later or run it repeatedly.


Suggested change

The `BukkitScheduler` can be used to schedule your code to be run later or run it repeatedly.

The `BukkitScheduler` can be used to schedule your code to be run later or repeatedly.

Will change

olijeffers0n · 2023-07-16T13:36:08Z

+- your plugin's instance,
+- the code to run, either with a `Runnable` or `Consumer<BukkitTask>`,
+- the delay in ticks before the task should run,
+- if you're scheduling a repeating task - the period in ticks between each execution of the task.


Suggested change

- your plugin's instance,

- the code to run, either with a `Runnable` or `Consumer<BukkitTask>`,

- the delay in ticks before the task should run,

- if you're scheduling a repeating task - the period in ticks between each execution of the task.

- Your plugin's instance,

- The code to run, either with a `Runnable` or `Consumer<BukkitTask>`,

- The delay in ticks before the task should run for the first time,

- If you're scheduling a repeating task - the period in ticks between each execution of the task.

Think of it as a long sentence, hence the commas and the period at the end,
will add for the first time

olijeffers0n · 2023-07-16T13:39:34Z

+	plugin, 
+	// Lambda:
+	() -> {
+		this.plugin.getServer().broadcast(Component.text("Hello, World!"));
+	},
+	// End of the lambda
+	20);


Suggested change

plugin,

// Lambda:

() -> {

this.plugin.getServer().broadcast(Component.text("Hello, World!"));

},

// End of the lambda

20);

plugin, /* Lambda: */ () -> {

this.plugin.getServer().broadcast(Component.text("Hello, World!"));

}, /* End of the lambda */ 20);

Keeps it styled the same as the next example and looks cleaner

Will change

Lulu13022002 · 2023-07-18T14:17:13Z

+
+```java
+scheduler.runTaskTimer(plugin, /* Lambda: */ task -> {
+	if(this.entity.isDead()) {


Missing a space between if and (

Nacioszeczek · 2023-07-25T06:49:07Z

succeeded by #204

Nacioszeczek added 2 commits March 17, 2023 16:32

add files

e5ebed0

add tick explanation, converting ticks and obtaining the scheduler

c6edc76

vercel Bot temporarily deployed to Preview March 17, 2023 15:43 Inactive

note the async part

4788e9f

olijeffers0n requested changes Mar 17, 2023

View reviewed changes

Comment thread docs/paper/dev/api/scheduler.md Outdated

Comment thread docs/paper/dev/api/scheduler.md Outdated

Comment thread docs/paper/dev/api/scheduler.md Outdated

Comment thread docs/paper/dev/api/scheduler.md

Comment thread docs/paper/dev/api/scheduler.md

Nacioszeczek added 3 commits March 17, 2023 17:24

arguments to schedule a task, difference between and usage of `Runnab…

8912523

…le` and `Consumer<BukkitTask>`

replace SI units with human units

a3e325a

not Java tutorial

cd47320

vercel Bot temporarily deployed to Preview March 17, 2023 16:58 Inactive

Nacioszeczek commented Mar 17, 2023

View reviewed changes

Comment thread docs/paper/dev/api/scheduler.md Outdated

Nacioszeczek added 2 commits March 19, 2023 10:22

basic sync examples

2402cdf

fix typo

3f4a10c

vercel Bot temporarily deployed to Preview March 19, 2023 09:25 Inactive

Nacioszeczek added 2 commits March 19, 2023 10:34

ensure task reschedule (try..finally)

a512fd8

rename

1dfbc9d

vercel Bot temporarily deployed to Preview March 19, 2023 09:37 Inactive

Nacioszeczek added 2 commits March 19, 2023 10:39

fix small inconsistency

181ace1

fix typo

a7b3f42

Nacioszeczek commented Mar 19, 2023

View reviewed changes

Comment thread docs/paper/dev/api/scheduler.md Outdated

yeet 1st warning, sync and async difference

170d393

vercel Bot temporarily deployed to Preview March 26, 2023 00:13 Inactive

Nacioszeczek added 2 commits March 26, 2023 01:19

fix ooga booga language

5e70ed3

flip the sentence

cd14a37

vercel Bot temporarily deployed to Preview March 26, 2023 00:30 Inactive

olijeffers0n reviewed Mar 27, 2023

View reviewed changes

Comment thread docs/paper/dev/api/scheduler.md Outdated

Nacioszeczek marked this pull request as ready for review May 13, 2023 10:57

kennytv requested changes Jun 5, 2023

View reviewed changes

Machine-Maker requested changes Jun 27, 2023

View reviewed changes

Comment thread docs/paper/dev/api/scheduler.md Outdated

Nacioszeczek added 4 commits July 13, 2023 19:23

reword what a tick is

daa5513

fix code errors

6d2af28

remove dynamic period

8ab3f4d

rewrite cancelling a repeating task

1e4872d

vercel Bot temporarily deployed to Preview July 13, 2023 17:49 Inactive

olijeffers0n requested changes Jul 16, 2023

View reviewed changes

Lulu13022002 reviewed Jul 18, 2023

View reviewed changes

olijeffers0n mentioned this pull request Jul 24, 2023

Scheduler Docs #204

Merged

Nacioszeczek closed this Jul 25, 2023


		# Task Scheduler

		The `BukkitScheduler` can be used to schedule your code to be run later or run it repeatedly.

Uh oh!

Conversation

Nacioszeczek commented Mar 17, 2023

Uh oh!

olijeffers0n left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Machine-Maker commented Mar 17, 2023

Uh oh!

Nacioszeczek commented Mar 17, 2023

Uh oh!

Machine-Maker commented Mar 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

olijeffers0n commented Mar 17, 2023

Uh oh!

Nacioszeczek commented Mar 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Nacioszeczek commented Mar 19, 2023

Uh oh!

Uh oh!

Uh oh!

Nacioszeczek commented May 13, 2023

Uh oh!

olijeffers0n commented May 13, 2023

Uh oh!

Nacioszeczek commented May 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Nacioszeczek commented Jun 27, 2023

Uh oh!

olijeffers0n left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Nacioszeczek commented Jul 25, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Machine-Maker commented Mar 17, 2023 •

edited

Loading

Nacioszeczek commented Mar 19, 2023 •

edited

Loading

Nacioszeczek commented May 13, 2023 •

edited

Loading