Skip to content

Add ensureGlobalTickThread method for validation #374

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
twisti-dev merged 2 commits into from
Jun 14, 2026
Merged

Add ensureGlobalTickThread method for validation #374

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ddd4b58
✨ feat(tick-thread-guard): add ensureGlobalTickThread method for glob…
twisti-dev Jun 14, 2026
becd2e9
Merge branch 'version/26.1' into feat/more-tick-thread-guards
twisti-dev Jun 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion gradle.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled
javaVersion=25
mcVersion=26.1.2
group=dev.slne.surf.api
version=3.22.0
version=3.23.0
relocationPrefix=dev.slne.surf.api.libs
snapshot=false
7 changes: 7 additions & 0 deletions ...main/kotlin/dev/slne/surf/api/paper/server/nms/v1_21_11/region/V1_21_11TickThreadGuard.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package dev.slne.surf.api.paper.server.nms.v1_21_11.region

import ca.spottedleaf.moonrise.common.util.TickThread
import dev.slne.surf.api.paper.extensions.server
import dev.slne.surf.api.paper.region.TickThreadGuard
import dev.slne.surf.api.paper.server.nms.v1_21_11.extensions.toNms
import dev.slne.surf.api.paper.util.chunkX
Expand Down Expand Up @@ -62,4 +63,10 @@ class V1_21_11TickThreadGuard : TickThreadGuard {
) {
TickThread.ensureTickThread(world.toNms(), blockX, blockZ, reason)
}

override fun ensureGlobalTickThread(reason: String) {
if (!server.isGlobalTickThread) {
throw IllegalStateException("Not on global tick thread: $reason")
}
}
}
9 changes: 9 additions & 0 deletions ...1/src/main/kotlin/dev/slne/surf/api/paper/server/nms/v26_1/region/V26_1TickThreadGuard.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package dev.slne.surf.api.paper.server.nms.v26_1.region

import ca.spottedleaf.moonrise.common.util.TickThread
import dev.slne.surf.api.paper.extensions.server
import dev.slne.surf.api.paper.region.TickThreadGuard
import dev.slne.surf.api.paper.server.nms.v26_1.extensions.toNms
import dev.slne.surf.api.paper.util.chunkX
Expand All @@ -16,6 +17,8 @@ import org.bukkit.util.BoundingBox
class V26_1TickThreadGuard : TickThreadGuard {

override fun ensureTickThread(world: World, pos: Position, reason: String) {
TickThread.ensureTickThread("")

TickThread.ensureTickThread(world.toNms(), pos.chunkX, pos.chunkZ, reason)
}
Comment on lines 19 to 23

Expand Down Expand Up @@ -62,4 +65,10 @@ class V26_1TickThreadGuard : TickThreadGuard {
) {
TickThread.ensureTickThread(world.toNms(), blockX, blockZ, reason)
}

override fun ensureGlobalTickThread(reason: String) {
if (!server.isGlobalTickThread) {
throw IllegalStateException("Not on global tick thread: $reason")
}
}
}
2 changes: 2 additions & 0 deletions surf-api-paper/surf-api-paper/api/surf-api-paper.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2583,6 +2583,7 @@ public abstract class dev/slne/surf/api/paper/permission/PermissionRegistry {

public abstract interface class dev/slne/surf/api/paper/region/TickThreadGuard {
public static final field Companion Ldev/slne/surf/api/paper/region/TickThreadGuard$Companion;
public abstract fun ensureGlobalTickThread (Ljava/lang/String;)V
public abstract fun ensureTickThread (Lorg/bukkit/World;DDLjava/lang/String;)V
public abstract fun ensureTickThread (Lorg/bukkit/World;IILjava/lang/String;)V
public abstract fun ensureTickThread (Lorg/bukkit/World;Lio/papermc/paper/math/Position;ILjava/lang/String;)V
Expand All @@ -2592,6 +2593,7 @@ public abstract interface class dev/slne/surf/api/paper/region/TickThreadGuard {
}

public final class dev/slne/surf/api/paper/region/TickThreadGuard$Companion : dev/slne/surf/api/paper/region/TickThreadGuard {
public fun ensureGlobalTickThread (Ljava/lang/String;)V
public fun ensureTickThread (Lorg/bukkit/World;DDLjava/lang/String;)V
public fun ensureTickThread (Lorg/bukkit/World;IILjava/lang/String;)V
public fun ensureTickThread (Lorg/bukkit/World;Lio/papermc/paper/math/Position;ILjava/lang/String;)V
Expand Down
2 changes: 2 additions & 0 deletions ...pi-paper/surf-api-paper/src/main/kotlin/dev/slne/surf/api/paper/region/TickThreadGuard.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ interface TickThreadGuard {
fun ensureTickThread(world: World, box: BoundingBox, reason: String)
fun ensureTickThread(world: World, blockX: Double, blockZ: Double, reason: String)

fun ensureGlobalTickThread(reason: String)

companion object : TickThreadGuard by tickThreadGuard {
val INSTANCE get() = tickThreadGuard
}
Expand Down