GraphMine

graphmine-core / io.github.sof3.graphmine.scope / Scope

Scope

interface Scope : CoroutineScope

A Scope represents some period of persistence. Features are enabled only during the scope is not disposed. Builtin scopes include:

• Server scope: Until the server is stopped
• Player scope: Until the player leaves the server
• Plugin scope: While the plugin is enabled
• World scope: While the world is loaded
• World partition scope: While the world partition is loaded

Plugins may create their own scopes too, e.g. a Hunger Games plugin may create a scope that lasts during the Hunger Games tournament

A scope is also a coroutine scope. Coroutines may be started from the scope.

Properties

isDisposed	abstract val isDisposed: Boolean whether the scope has been disposed
name	abstract val name: String

Functions

addOnDispose

abstract fun addOnDispose(fn: () -> Unit): Unit Adds an action to execute when the scope is disposed

Inheritors

BaseScope	open class BaseScope : Scope Basic implementation of BaseScope
Server	class Server : Scope, HasLogger The Server should be the object that links up different components of the server.

This site is open source. Improve this page.