Upstream/Minestom
1
0
Fork 0
mirror of https://github.com/Minestom/Minestom.git synced 2025-03-27 05:59:23 +01:00
Code Issues Projects Releases Wiki Activity

#currentEntities documentation

Browse Source
This commit is contained in:
TheMode 2021-04-21 11:31:56 +02:00
parent 73dee1fb1a
commit 224a1f57b4
1 changed files with 15 additions and 0 deletions

15
src/main/java/net/minestom/server/lock/Acquirable.java
View File

@ -21,10 +21,25 @@ public final class Acquirable<T> {
public static final ThreadLocal<Collection<Entity>> CURRENT_ENTITIES = ThreadLocal.withInitial(Collections::emptyList);
/**
* Gets all the {@link Entity entities} being ticked in the current thread.
* <p>
* Useful when you want to ensure that no acquisition is ever done.
*
* @return the entities ticked in the current thread
*/
public static @NotNull Collection<@NotNull Entity> currentEntities() {
return CURRENT_ENTITIES.get();
}
/**
* Changes the collection returned by {@link #currentEntities()}.
* <p>
* Mostly for internal use, internal calls are unrecommended as they could lead
* to unexpected behavior.
*
* @param entities the new entity collection
*/
@ApiStatus.Internal
public static void refreshEntities(@NotNull Collection<@NotNull Entity> entities) {
CURRENT_ENTITIES.set(entities);