org.spongepowered.api.scheduler.ScheduledUpdateList Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of spongeapi Show documentation
Show all versions of spongeapi Show documentation
A plugin API for Minecraft: Java Edition
/*
* This file is part of SpongeAPI, licensed under the MIT License (MIT).
*
* Copyright (c) SpongePowered
* Copyright (c) contributors
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package org.spongepowered.api.scheduler;
import org.spongepowered.api.block.BlockType;
import org.spongepowered.api.fluid.FluidType;
import org.spongepowered.api.registry.DefaultedRegistryReference;
import org.spongepowered.api.util.Ticks;
import org.spongepowered.math.vector.Vector3i;
import java.time.Duration;
import java.time.temporal.TemporalUnit;
import java.util.Collection;
/**
* A tick based priority scheduled list targeting specific types of
* objects that need to be ticked. In common cases, there's either
* a {@link BlockType} or {@link FluidType} being ticked.
* @param The type of update objects that are being scheduled
*/
public interface ScheduledUpdateList {
/**
* Schedules a new update at the desired position with the provided delay.
*
* @param pos The position
* @param target The target
* @param delay The delay
* @param temporalUnit The unit of the delay
* @return The scheduled update
*/
default ScheduledUpdate schedule(final Vector3i pos, final T target, final int delay, final TemporalUnit temporalUnit) {
return this.schedule(pos.x(), pos.y(), pos.z(), target, delay, temporalUnit, TaskPriorities.NORMAL.get());
}
/**
* Schedules a new update with the given {@code T object} for a desired {@link Duration}
* @param pos The position
* @param target The target
* @param delay The delay with a duration
* @return The scheduled update
*/
default ScheduledUpdate schedule(final Vector3i pos, final T target, final Duration delay) {
return this.schedule(pos.x(), pos.y(), pos.z(), target, delay, TaskPriorities.NORMAL);
}
/**
* Schedules a new update for the desired target
* @param x The x coordinate
* @param y The y coordinate
* @param z The z coordinate
* @param target The target object
* @param delay The delay
* @param temporalUnit The unit of time
* @return The scheduled update
*/
default ScheduledUpdate schedule(final int x, final int y, final int z, final T target, final int delay, final TemporalUnit temporalUnit) {
return this.schedule(x, y, z, target, delay, temporalUnit, TaskPriorities.NORMAL.get());
}
/**
*
* @param x The x coordinate
* @param y The y coordinate
* @param z The z coordinate
* @param target The target
* @param delay The delay
* @return The scheduled update
*/
default ScheduledUpdate schedule(final int x, final int y, final int z, final T target, final Duration delay) {
return this.schedule(x, y, z, target, delay, TaskPriorities.NORMAL);
}
/**
*
* @param pos The position
* @param target The target
* @param delay The delay
* @param temporalUnit The unit of time
* @param priority The priority of the scheduled update
* @return The scheduled update
*/
default ScheduledUpdate schedule(final Vector3i pos, final T target, final int delay, final TemporalUnit temporalUnit, final TaskPriority priority) {
return this.schedule(pos.x(), pos.y(), pos.z(), target, Duration.of(delay, temporalUnit), priority);
}
/**
*
* @param pos The position
* @param target The target
* @param delay The delay
* @param temporalUnit The unit of time
* @param priority The priority of the scheduled update
* @return The scheduled update
*/
default ScheduledUpdate schedule(final Vector3i pos, final T target, final int delay, final TemporalUnit temporalUnit, final DefaultedRegistryReference priority) {
return this.schedule(pos.x(), pos.y(), pos.z(), target, Duration.of(delay, temporalUnit), priority.get());
}
/**
*
* @param pos The position
* @param target The target
* @param delay The delay
* @param priority The priority of the scheduled update
* @return The scheduled update
*/
default ScheduledUpdate schedule(final Vector3i pos, final T target, final Duration delay, final TaskPriority priority) {
return this.schedule(pos.x(), pos.y(), pos.z(), target, delay, priority);
}
/**
*
* @param pos The position
* @param target The target
* @param delay The delay
* @param priority The priority of the scheduled update
* @return The scheduled update
*/
default ScheduledUpdate schedule(final Vector3i pos, final T target, final Duration delay, final DefaultedRegistryReference priority) {
return this.schedule(pos.x(), pos.y(), pos.z(), target, delay, priority.get());
}
/**
*
* @param x The x coordinate
* @param y The y coordinate
* @param z The z coordinate
* @param target The target
* @param delay The delay
* @param temporalUnit The unit of time
* @param priority The priority of the scheduled update
* @return The scheduled update
*/
default ScheduledUpdate schedule(
final int x, final int y, final int z, final T target, final int delay, final TemporalUnit temporalUnit, final TaskPriority priority) {
return this.schedule(x, y, z, target, Duration.of(delay, temporalUnit), priority);
}
/**
*
* @param x The x coordinate
* @param y The y coordinate
* @param z The z coordinate
* @param target The target
* @param delay The delay
* @param temporalUnit The unit of time
* @param priority The priority of the scheduled update
* @return The scheduled update
*/
default ScheduledUpdate schedule(
final int x, final int y, final int z, final T target, final int delay, final TemporalUnit temporalUnit, final DefaultedRegistryReference priority) {
return this.schedule(x, y, z, target, Duration.of(delay, temporalUnit), priority.get());
}
/**
*
* @param x The x coordinate
* @param y The y coordinate
* @param z The z coordinate
* @param target The target
* @param delay The delay
* @param priority The priority of the scheduled update
* @return The scheduled update
*/
ScheduledUpdate schedule(int x, int y, int z, T target, Duration delay, TaskPriority priority);
/**
*
* @param x The x coordinate
* @param y The y coordinate
* @param z The z coordinate
* @param target The target
* @param ticks The delay, in {@link Ticks}
* @param priority The priority of the scheduled update
* @return The scheduled update
*/
default ScheduledUpdate schedule(
final int x, final int y, final int z, final T target, final Ticks ticks, final DefaultedRegistryReference priority) {
return this.schedule(x, y, z, target, ticks, priority.get());
}
/**
*
* @param x The x coordinate
* @param y The y coordinate
* @param z The z coordinate
* @param target The target
* @param delay The delay
* @return The scheduled update
*/
default ScheduledUpdate schedule(int x, int y, int z, final T target, final Ticks delay) {
return this.schedule(x, y, z, target, delay, TaskPriorities.NORMAL.get());
}
/**
*
* @param pos The position
* @param target The target
* @param delay The delay
* @return The scheduled update
*/
default ScheduledUpdate schedule(final Vector3i pos, final T target, final Ticks delay) {
return this.schedule(pos.x(), pos.y(), pos.z(), target, delay, TaskPriorities.NORMAL.get());
}
/**
*
* @param pos The position
* @param target The target
* @param delay The delay
* @param priority The priority of the scheduled update
* @return The scheduled update
*/
default ScheduledUpdate schedule(final Vector3i pos, final T target, final Ticks delay, final TaskPriority priority) {
return this.schedule(pos.x(), pos.y(), pos.z(), target, delay, priority);
}
/**
*
* @param x The x coordinate
* @param y The y coordinate
* @param z The z coordinate
* @param target The target
* @param delay The delay
* @param priority The priority of the scheduled update
* @return The scheduled update
*/
default ScheduledUpdate schedule(final int x, final int y, final int z, final T target, final Duration delay, final DefaultedRegistryReference priority) {
return this.schedule(x, y, z, target, delay, priority.get());
}
/**
* Schedules a new update at the desired position after the specified
* number of {@link Ticks}.
*
* @param x The x coordinate
* @param y The y coordinate
* @param z The z coordinate
* @param target The target
* @param delay The delay, in {@link Ticks}
* @param priority The priority of the scheduled update
* @return The scheduled update
*/
ScheduledUpdate schedule(int x, int y, int z, T target, Ticks delay, TaskPriority priority);
/**
* Gets whether there's a scheduled update at the desired position with the provided target.
*
* @param pos The position
* @param target The target
* @return True if there's an update scheduled
*/
default boolean isScheduled(final Vector3i pos, final T target) {
return this.isScheduled(pos.x(), pos.y(), pos.z(), target);
}
/**
*
* @param x The x coordinate
* @param y The y coordinate
* @param z The z coordinate
* @param target The target
* @return True if there's an update scheduled
*/
boolean isScheduled(int x, int y, int z, T target);
/**
*
* @param pos The position
* @return The collection of scheduled updates at the desired position
*/
default Collection> scheduledAt(final Vector3i pos) {
return this.scheduledAt(pos.x(), pos.y(), pos.z());
}
/**
* Gets a collection of scheduled updates at the desired position. There is
* no guarantee
* @param x The x coordinate
* @param y The y coordinate
* @param z The z coordinate
* @return The collection of scheduled updates at the desired position
*/
Collection> scheduledAt(int x, int y, int z);
}