Terix-API/dev.racci.terix.api.origins/OriginHelper

OriginHelper

object OriginHelper : KoinComponent, WithPlugin<Terix>

Types

IgnoreReason

enum IgnoreReason : Enum<OriginHelper.IgnoreReason>

Functions

activateOrigin

suspend fun activateOrigin(player: TerixPlayer, origin: Origin = player.origin)

Designed to be invoked for when a player needs everything to reset.

async

open fun async(block: suspend CoroutineScope.() -> Unit): Job

changeTo

suspend fun changeTo(player: TerixPlayer, oldOrigin: Origin?, newOrigin: Origin)

completableAsync

open fun <R> completableAsync(block: suspend () -> R): CompletableFuture<R>

completableSync

open fun <R> completableSync(block: suspend () -> R): CompletableFuture<R>

deactivateOrigin

suspend fun deactivateOrigin(player: TerixPlayer, origin: Origin = player.origin)

Completely disables all parts of the players' origin.

deferredAsync

open fun <R> deferredAsync(block: suspend () -> R): Deferred<R>

deferredSync

open fun <R> deferredSync(block: suspend () -> R): Deferred<R>

deleteProperty

open fun deleteProperty(key: String)

getBaseOriginPotions

fun getBaseOriginPotions(player: TerixPlayer, state: State?): Sequence<PotionEffectType>

If state is not null, then returns all potions, which are from the state. Otherwise, returns all potions that are origin related.

getKoin

open fun getKoin(): Koin

getProperty

open fun <T : Any> getProperty(key: String): T?

open fun <T : Any> getProperty(key: String, default: T): T

increaseHealth

fun increaseHealth(player: Player, amount: Double)

Increases the players' health safely by clamping it within 0 and the maximum health.

launch

open fun launch(dispatcher: CoroutineContext, block: suspend CoroutineScope.() -> Unit): Job

potionOrigin

fun potionOrigin(potion: PotionEffect): Origin?

potionState

fun potionState(potion: PotionEffect): State?

recalculateStates

suspend fun recalculateStates(player: TerixPlayer, origin: Origin = player.origin)

registerEvents

open fun registerEvents(vararg listeners: Listener)

setHealth

fun setHealth(player: Player, amount: Double)

Set the players' health safely by clamping it within 0 and the maximum health.

setProperty

open fun <T : Any> setProperty(key: String, value: T): T

shouldIgnorePlayer

fun shouldIgnorePlayer(player: TerixPlayer): Boolean

Checks if a player should be ignored for something like staff mode.

sync

open fun sync(block: suspend CoroutineScope.() -> Unit): Job

Properties

logger

open val logger: MinixLogger

plugin

open override val plugin: Terix