Skip to content

Commit f55b2d1

Browse files
0utplayderklaro
0utplay
and
derklaro
authored
feat: implement base folia support (#1838)
### Motivation Folia has been somewhat stable for some time now. Some users are requesting support and even took matters into their own hands by forking CloudNet, so indeed there is some need :) ### Modification Added a new `platform-scheduler` ext module which enables platform (bukkit / folia currently) independant scheduling capabilities. Made use of the new platform scheduler in the bukkit impl of bridge to properly support Folia there. Furthermore, Folia was added to the version installer (currently only 1.21.11) ### Result Folia is supported in the CloudNet-Bridge and can be installed using the version installer. ##### Other context Fixes #1352 --------- Co-authored-by: Pasqual Koschmieder <git@derklaro.dev>
1 parent 84f6035 commit f55b2d1

File tree

16 files changed

+893
-14
lines changed

16 files changed

+893
-14
lines changed

‎ext/platform-scheduler/build.gradle.kts‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
/*
2+
* Copyright 2019-present CloudNetService team & contributors
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
plugins {
18+
id("cloudnet-java")
19+
id("cloudnet-publish")
20+
}
21+
22+
repositories {
23+
maven("https://repo.papermc.io/repository/maven-public/")
24+
}
25+
26+
dependencies {
27+
compileOnly(libs.folia)
28+
}

‎ext/platform-scheduler/src/main/java/eu/cloudnetservice/ext/scheduler/BukkitPlatformScheduler.java‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
/*
2+
* Copyright 2019-present CloudNetService team & contributors
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package eu.cloudnetservice.ext.scheduler;
18+
19+
import lombok.NonNull;
20+
import org.bukkit.World;
21+
import org.bukkit.entity.Entity;
22+
import org.bukkit.plugin.Plugin;
23+
24+
/**
25+
* Base type for all scheduler implementations that target a platform that implements the bukkit api.
26+
*
27+
* @since 4.0
28+
*/
29+
public sealed interface BukkitPlatformScheduler
30+
extends PlatformScheduler<Plugin, World, Entity>
31+
permits RawBukkitPlatformScheduler, FoliaPlatformScheduler {
32+
33+
/**
34+
* Get the selected bukkit platform scheduler instance.
35+
*
36+
* @return the selected bukkit platform scheduler instance.
37+
* @throws UnsupportedOperationException if the current platform is not a bukkit platform.
38+
*/
39+
static @NonNull BukkitPlatformScheduler bukkitScheduler() {
40+
var scheduler = PlatformScheduler.scheduler();
41+
if (!(scheduler instanceof BukkitPlatformScheduler bukkitPlatformScheduler)) {
42+
throw new UnsupportedOperationException("Selected platform scheduler impl is not a bukkit platform scheduler");
43+
}
44+
45+
return bukkitPlatformScheduler;
46+
}
47+
}

‎ext/platform-scheduler/src/main/java/eu/cloudnetservice/ext/scheduler/FoliaPlatformScheduler.java‎

Lines changed: 196 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,196 @@
1+
/*
2+
* Copyright 2019-present CloudNetService team & contributors
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package eu.cloudnetservice.ext.scheduler;
18+
19+
import io.papermc.paper.threadedregions.scheduler.AsyncScheduler;
20+
import io.papermc.paper.threadedregions.scheduler.GlobalRegionScheduler;
21+
import io.papermc.paper.threadedregions.scheduler.RegionScheduler;
22+
import io.papermc.paper.threadedregions.scheduler.ScheduledTask;
23+
import java.util.concurrent.TimeUnit;
24+
import lombok.NonNull;
25+
import org.bukkit.Bukkit;
26+
import org.bukkit.World;
27+
import org.bukkit.entity.Entity;
28+
import org.bukkit.plugin.Plugin;
29+
import org.jetbrains.annotations.Nullable;
30+
31+
/**
32+
* Folia implementation of a platform scheduler.
33+
*
34+
* @since 4.0
35+
*/
36+
final class FoliaPlatformScheduler implements BukkitPlatformScheduler {
37+
38+
private static final AsyncScheduler ASYNC_SCHEDULER = Bukkit.getAsyncScheduler();
39+
private static final RegionScheduler REGION_SCHEDULER = Bukkit.getRegionScheduler();
40+
private static final GlobalRegionScheduler GLOBAL_REGION_SCHEDULER = Bukkit.getGlobalRegionScheduler();
41+
42+
/**
43+
* {@inheritDoc}
44+
*/
45+
@Override
46+
public @NonNull ScheduledPlatformTask globalRunDelayed(
47+
@NonNull Plugin plugin,
48+
@NonNull Runnable task,
49+
long delayTicks
50+
) {
51+
var scheduledTask = GLOBAL_REGION_SCHEDULER.runDelayed(plugin, _ -> task.run(), delayTicks);
52+
return new TaskWrapper(scheduledTask);
53+
}
54+
55+
/**
56+
* {@inheritDoc}
57+
*/
58+
@Override
59+
public @NonNull ScheduledPlatformTask globalRunAtFixedRate(
60+
@NonNull Plugin plugin,
61+
@NonNull Runnable task,
62+
long initialDelayTicks,
63+
long periodTicks
64+
) {
65+
var scheduledTask = GLOBAL_REGION_SCHEDULER.runAtFixedRate(plugin, _ -> task.run(), initialDelayTicks, periodTicks);
66+
return new TaskWrapper(scheduledTask);
67+
}
68+
69+
/**
70+
* {@inheritDoc}
71+
*/
72+
@Override
73+
public @NonNull ScheduledPlatformTask regionRunDelayed(
74+
@NonNull Plugin plugin,
75+
@NonNull World world,
76+
int chunkX,
77+
int chunkZ,
78+
@NonNull Runnable task,
79+
long delayTicks
80+
) {
81+
var scheduledTask = REGION_SCHEDULER.runDelayed(plugin, world, chunkX, chunkZ, _ -> task.run(), delayTicks);
82+
return new TaskWrapper(scheduledTask);
83+
}
84+
85+
/**
86+
* {@inheritDoc}
87+
*/
88+
@Override
89+
public @NonNull ScheduledPlatformTask regionRunAtFixedRate(
90+
@NonNull Plugin plugin,
91+
@NonNull World world,
92+
int chunkX,
93+
int chunkZ,
94+
@NonNull Runnable task,
95+
long initialDelayTicks,
96+
long periodTicks
97+
) {
98+
var scheduledTask = REGION_SCHEDULER.runAtFixedRate(
99+
plugin,
100+
world,
101+
chunkX,
102+
chunkZ,
103+
_ -> task.run(),
104+
initialDelayTicks,
105+
periodTicks);
106+
return new TaskWrapper(scheduledTask);
107+
}
108+
109+
/**
110+
* {@inheritDoc}
111+
*/
112+
@Override
113+
public @NonNull ScheduledPlatformTask asyncRunNow(
114+
@NonNull Plugin plugin,
115+
@NonNull Runnable task
116+
) {
117+
var scheduledTask = ASYNC_SCHEDULER.runNow(plugin, _ -> task.run());
118+
return new TaskWrapper(scheduledTask);
119+
}
120+
121+
/**
122+
* {@inheritDoc}
123+
*/
124+
@Override
125+
public @NonNull ScheduledPlatformTask asyncRunDelayed(
126+
@NonNull Plugin plugin,
127+
@NonNull Runnable task,
128+
long delay,
129+
@NonNull TimeUnit unit
130+
) {
131+
var scheduledTask = ASYNC_SCHEDULER.runDelayed(plugin, _ -> task.run(), delay, unit);
132+
return new TaskWrapper(scheduledTask);
133+
}
134+
135+
/**
136+
* {@inheritDoc}
137+
*/
138+
@Override
139+
public @NonNull ScheduledPlatformTask asyncRunAtFixedRate(
140+
@NonNull Plugin plugin,
141+
@NonNull Runnable task,
142+
long initialDelay,
143+
long period,
144+
@NonNull TimeUnit unit
145+
) {
146+
var scheduledTask = ASYNC_SCHEDULER.runAtFixedRate(plugin, _ -> task.run(), initialDelay, period, unit);
147+
return new TaskWrapper(scheduledTask);
148+
}
149+
150+
/**
151+
* {@inheritDoc}
152+
*/
153+
@Override
154+
public @Nullable ScheduledPlatformTask entityRunDelayed(
155+
@NonNull Plugin plugin,
156+
@NonNull Entity entity,
157+
@NonNull Runnable task,
158+
long delayTicks
159+
) {
160+
var scheduler = entity.getScheduler();
161+
var scheduledTask = scheduler.runDelayed(plugin, _ -> task.run(), task, delayTicks);
162+
return scheduledTask == null ? null : new TaskWrapper(scheduledTask);
163+
}
164+
165+
/**
166+
* {@inheritDoc}
167+
*/
168+
@Override
169+
public @Nullable ScheduledPlatformTask entityRunAtFixedRate(
170+
@NonNull Plugin plugin,
171+
@NonNull Entity entity,
172+
@NonNull Runnable task,
173+
long initialDelayTicks,
174+
long periodTicks
175+
) {
176+
var scheduler = entity.getScheduler();
177+
var scheduledTask = scheduler.runAtFixedRate(plugin, _ -> task.run(), task, initialDelayTicks, periodTicks);
178+
return scheduledTask == null ? null : new TaskWrapper(scheduledTask);
179+
}
180+
181+
/**
182+
* Wrapper for a task scheduled on a folia task scheduler.
183+
*
184+
* @param task the wrapped task.
185+
*/
186+
private record TaskWrapper(@NonNull ScheduledTask task) implements ScheduledPlatformTask {
187+
188+
/**
189+
* {@inheritDoc}
190+
*/
191+
@Override
192+
public void cancel() {
193+
this.task.cancel();
194+
}
195+
}
196+
}

0 commit comments

Comments
 (0)