ScriptingState

Self-contained instance of scripting API use.

Abstracts available scope, running backends, command history Should be unique per isolated use of scripting. E.G. One for the ~-key console screen, one for each mod/all mods per save file (or whatever works best), etc.

Types

BackendSpawnResult

data class BackendSpawnResult(backend: ScriptingBackend, motd: String)

Functions

autocomplete

fun autocomplete(command: String, cursorPos: Int? = null): AutocompleteResults

echo

fun echo(text: String)

equals

open operator fun equals(other: Any?): Boolean

exec

@Synchronized

fun exec(command: String, asName: String? = null, withParams: Map<String, Any?>? = null): ExecResult

fun exec(command: String, asName: String? = null, withParams: Map<String, Any?>? = null, withBackend: ScriptingBackend): ExecResult

getIndexOfBackend

fun getIndexOfBackend(backend: ScriptingBackend): Int?

getOutputHistory

fun getOutputHistory(): List<String>

hasBackend

fun hasBackend(): Boolean

hashCode

open fun hashCode(): Int

navigateHistory

fun navigateHistory(increment: Int): String

spawnBackend

fun spawnBackend(backendtype: ScriptingBackendType): ScriptingState.BackendSpawnResult

switchToBackend

fun switchToBackend(backend: ScriptingBackend)

fun switchToBackend(index: Int)

termBackend

fun termBackend(backend: ScriptingBackend): Exception?

fun termBackend(index: Int): Exception?

toString

open fun toString(): String

Properties

activeBackend

val activeBackend: ScriptingBackend

activeBackendIndex

var activeBackendIndex: Int = 0

activeCommandHistory

var activeCommandHistory: Int = 0

commandHistory

private val commandHistory: ArrayList<String>

consoleScreenListener

var consoleScreenListener: (String) -> Unit? = null

maxCommandHistory

val maxCommandHistory: Int = 511

maxOutputHistory

val maxOutputHistory: Int = 511

outputHistory

private val outputHistory: ArrayList<String>

scriptingBackends

val scriptingBackends: ArrayList<ScriptingBackend>

Sources

jvm source