Terix-API/dev.racci.terix.api.origins.origin/Origin

Origin

@API(status = API.Status.MAINTAINED, since = "1.0.0")

abstract class Origin : OriginBuilder

Constructors

Origin

fun Origin()

Functions

async

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

completableAsync

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

completableSync

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

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)

fireImmunity

fun fireImmunity(fireImmunity: Boolean = true): OriginBuilder

getKoin

open fun getKoin(): Koin

getProperty

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

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

handleBecomeOrigin

open suspend fun handleBecomeOrigin(player: Player)

Called when the player first becomes this origin. Called before handleLoad.

handleChangeOrigin

open suspend fun handleChangeOrigin(player: Player)

Called when the player changes from this origin.

handleDeactivate

open suspend fun handleDeactivate(player: Player)

When the player changes to gm 1 for example.

handleLoad

open suspend fun handleLoad(player: Player)

Called when the player loads|joins|respawns as this origin. Called after handleBecomeOrigin if the player is becoming this origin.

handleRegister

open suspend fun handleRegister()

Called when Terix first registers this origin.

handleUnload

open suspend fun handleUnload()

Called when the server is stopping or plugin is being unloaded and caches should be cleaned.

launch

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

onTick

open suspend fun onTick(player: Player)

Called each game tick.

registerEvents

open fun registerEvents(vararg listeners: Listener)

setProperty

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

sync

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

toString

override fun toString(): String

waterBreathing

fun waterBreathing(waterBreathing: Boolean = true): OriginBuilder

Properties

abilityData

var abilityData: OriginValues.AbilityData

becomeOriginTitle

open val becomeOriginTitle: TitleBuilder? = null

builderCache

@API(status = API.Status.INTERNAL)

val builderCache: LoadingCache<KClass<out BuilderPart<*>>, BuilderPart<*>>

colour

open val colour: TextColor

damageActions

var damageActions: PersistentMap<EntityDamageEvent.DamageCause, suspend EntityDamageEvent.() -> Unit>

displayName

val displayName: Component

eventListener

val eventListener: KListener<MinixPlugin>

fireImmunity

open var fireImmunity: Boolean = false

foodData

var foodData: OriginValues.FoodData

item

val item: OriginItem

logger

open val logger: MinixLogger

name

open val name: String

plugin

abstract val plugin: MinixPlugin

requirements

open val requirements: PersistentList<Pair<Component, (Player) -> Boolean>>

sounds

val sounds: SoundEffects

stateData

var stateData: OriginValues.ImmutableStateMap<OriginValues.StateData>

waterBreathing

open var waterBreathing: Boolean = false