Upstream/Folia
1
0
Fork 0
mirror of https://github.com/PaperMC/Folia.git synced 2024-11-21 11:55:11 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fix class name reference in readme

Browse Source
This commit is contained in:
Nassim Jahnke 2023-03-30 08:20:03 +02:00
parent f3e6529d49
commit 5b74945159
No known key found for this signature in database
GPG Key ID: 6BE3B555EBC5982B
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -86,7 +86,7 @@ be compatible with Folia. However, there are plans to add API that
would allow Folia plugins to be compatible with Paper. would allow Folia plugins to be compatible with Paper.
For example, the Bukkit Scheduler. The Bukkit Scheduler inherently For example, the Bukkit Scheduler. The Bukkit Scheduler inherently
relies on a single main thread. Folia's RegionisedScheduler and Folia's relies on a single main thread. Folia's RegionScheduler and Folia's
EntityScheduler allow scheduling of tasks to the "next tick" of whatever EntityScheduler allow scheduling of tasks to the "next tick" of whatever
region "owns" either a location or an entity. These could be implemented region "owns" either a location or an entity. These could be implemented
on regular Paper, except they schedule to the main thread - in both cases, on regular Paper, except they schedule to the main thread - in both cases,
@ -121,11 +121,11 @@ prevent and find these bugs is to make bad accesses fail _hard_ at the
source of the bad access. source of the bad access.
This means that Folia compatible plugins need to take advantage of This means that Folia compatible plugins need to take advantage of
API like the RegionisedScheduler and the EntityScheduler to ensure API like the RegionScheduler and the EntityScheduler to ensure
their code is running on the correct thread context. their code is running on the correct thread context.
In general, it is safe to assume that a region owns chunk data In general, it is safe to assume that a region owns chunk data
in an approximate 8 chunks from the source of an event (i.e player in an approximate 8 chunks from the source of an event (i.e. player
breaks block, can probably access 8 chunks around that block). But, breaks block, can probably access 8 chunks around that block). But,
this is not guaranteed - plugins should take advantage of upcoming this is not guaranteed - plugins should take advantage of upcoming
thread-check API to ensure correct behavior. thread-check API to ensure correct behavior.
@ -137,7 +137,7 @@ specifically entity/chunk/poi data, and is entirely unrelated
to **ANY** plugin data. to **ANY** plugin data.
Normal multithreading rules apply to data that plugins store/access Normal multithreading rules apply to data that plugins store/access
their own data or another plugin's - events/commands/etc are called their own data or another plugin's - events/commands/etc. are called
in _parallel_ because regions are ticking in _parallel_ (we CANNOT in _parallel_ because regions are ticking in _parallel_ (we CANNOT
call them in a synchronous fashion, as this opens up deadlock issues call them in a synchronous fashion, as this opens up deadlock issues
and would handicap performance). There are no easy ways out of this, and would handicap performance). There are no easy ways out of this,