Package dev.bouncingelf10.timelesslib.api.countdown

Class Countdown

java.lang.Object

dev.bouncingelf10.timelesslib.api.countdown.Countdown

public class Countdown
extends Object

Method Summary

Modifier and Type	Method	Description
boolean	cancel()	Cancels the countdown.
Countdown	displayAllUsers()
Countdown	displayAllUsers(TimeFormat timeFormat, String prefix, String suffix)
Countdown	displayNearbyUsers(double x, double y, double z, float radius)
Countdown	displayNearbyUsers(double x, double y, double z, float radius, TimeFormat timeFormat, String prefix, String suffix)
Countdown	displayNearbyUsers(net.minecraft.core.BlockPos blockPos, float radius)
Countdown	displayNearbyUsers(net.minecraft.core.BlockPos blockPos, float radius, TimeFormat timeFormat, String prefix, String suffix)
Countdown	displayNearbyUsers(net.minecraft.server.level.ServerPlayer player, float radius)
Countdown	displayNearbyUsers(net.minecraft.server.level.ServerPlayer player, float radius, TimeFormat timeFormat, String prefix, String suffix)
Countdown	displayNearbyUsers(net.minecraft.world.phys.Vec3 position, float radius)
Countdown	displayNearbyUsers(net.minecraft.world.phys.Vec3 position, float radius, TimeFormat timeFormat, String prefix, String suffix)
Countdown	displayToUser(net.minecraft.server.level.ServerPlayer player)
Countdown	displayToUser(net.minecraft.server.level.ServerPlayer player, TimeFormat timeFormat, String prefix, String suffix)
Countdown	every(Duration interval, Consumer<Object> handler)	Adds a task to execute every time the specified interval elapses.
String	getId()
boolean	isCancelled()
boolean	isFinished()
boolean	isPaused()
Countdown	onFinish(Consumer<Object> handler)	Adds a task to execute when the countdown finishes.
Countdown	onThreshold(Duration threshold, Consumer<Object> handler)	Adds a task to execute when the countdown reaches the specified threshold.
Countdown	onTick(BiConsumer<Object,Duration> handler)	Adds a task to execute every countdown tick specified by the tick interval.
boolean	pause()	Pauses the countdown.
boolean	pauseOrUnpause()	Toggles to pause or unpause the countdown.
Duration	remaining()
boolean	resume()	Resumes a paused countdown.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

cancel

public boolean cancel()

Cancels the countdown.

Returns:

true if the countdown was cancelled, false if it was already finished or canceled

pause

public boolean pause()

Pauses the countdown. Note: If the countdown is already paused, this method does nothing.

Returns:

true if the countdown was paused, false if it was already finished or canceled

resume

public boolean resume()

Resumes a paused countdown. Note: If the countdown is not paused, this method does nothing.

Returns:

true if the countdown was resumed, false if it was already finished or canceled

pauseOrUnpause

public boolean pauseOrUnpause()

Toggles to pause or unpause the countdown.

Returns:

true if the countdown was changed state, false if it was already finished or canceled

isCancelled

public boolean isCancelled()

isPaused

public boolean isPaused()

isFinished

public boolean isFinished()

remaining

public Duration remaining()

getId

public String getId()

onTick

public Countdown onTick(BiConsumer<Object,Duration> handler)

Adds a task to execute every countdown tick specified by the tick interval.

Parameters:

handler - Handler to execute every countdown tick.

See Also:

• CountdownManager.start(Duration, Duration, TimeSource)

onFinish

public Countdown onFinish(Consumer<Object> handler)

Adds a task to execute when the countdown finishes.

Parameters:

handler - Handler to execute when the countdown finishes.

onThreshold

public Countdown onThreshold(Duration threshold,
 Consumer<Object> handler)

Adds a task to execute when the countdown reaches the specified threshold.

Parameters:

threshold - Duration threshold to reach.

handler - Handler to execute when the threshold is reached.

every

public Countdown every(Duration interval,
 Consumer<Object> handler)

Adds a task to execute every time the specified interval elapses. (Like onTick(BiConsumer), but with a specified interval instead of the countdown tick interval)

Parameters:

interval - Interval at which to execute the handler.

handler - Handler to execute every time the interval elapses.

displayToUser

public Countdown displayToUser(net.minecraft.server.level.ServerPlayer player)

displayToUser

public Countdown displayToUser(net.minecraft.server.level.ServerPlayer player,
 TimeFormat timeFormat,
 String prefix,
 String suffix)

displayAllUsers

public Countdown displayAllUsers()

displayAllUsers

public Countdown displayAllUsers(TimeFormat timeFormat,
 String prefix,
 String suffix)

displayNearbyUsers

public Countdown displayNearbyUsers(net.minecraft.world.phys.Vec3 position,
 float radius)

displayNearbyUsers

public Countdown displayNearbyUsers(net.minecraft.world.phys.Vec3 position,
 float radius,
 TimeFormat timeFormat,
 String prefix,
 String suffix)

displayNearbyUsers

public Countdown displayNearbyUsers(net.minecraft.server.level.ServerPlayer player,
 float radius)

displayNearbyUsers

public Countdown displayNearbyUsers(net.minecraft.server.level.ServerPlayer player,
 float radius,
 TimeFormat timeFormat,
 String prefix,
 String suffix)

displayNearbyUsers

public Countdown displayNearbyUsers(net.minecraft.core.BlockPos blockPos,
 float radius)

displayNearbyUsers

public Countdown displayNearbyUsers(net.minecraft.core.BlockPos blockPos,
 float radius,
 TimeFormat timeFormat,
 String prefix,
 String suffix)

displayNearbyUsers

public Countdown displayNearbyUsers(double x,
 double y,
 double z,
 float radius)

displayNearbyUsers

public Countdown displayNearbyUsers(double x,
 double y,
 double z,
 float radius,
 TimeFormat timeFormat,
 String prefix,
 String suffix)