ScriptingPacket

data class ScriptingPacket(action: String?, identifier: String?, data: JsonElement?, flags: Collection<String>)

Implementation of IPC packet specified in Module.md.

Constructors

ScriptingPacket
Link copied to clipboard
fun ScriptingPacket(action: String?, identifier: String?, data: JsonElement? = null, flags: Collection<String> = listOf())

Types

Companion
Link copied to clipboard
object Companion

Functions

component1
Link copied to clipboard
operator fun component1(): String?
component2
Link copied to clipboard
operator fun component2(): String?
component3
Link copied to clipboard
operator fun component3(): JsonElement?
component4
Link copied to clipboard
operator fun component4(): Collection<String>
copy
Link copied to clipboard
fun copy(action: String?, identifier: String?, data: JsonElement? = null, flags: Collection<String> = listOf()): ScriptingPacket
equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
hasFlag
Link copied to clipboard
fun hasFlag(flag: ScriptingProtocol.KnownFlag): Boolean
hashCode
Link copied to clipboard
open override fun hashCode(): Int
toJson
Link copied to clipboard
fun toJson(): String

Encode this packet into a JSON string.

toString
Link copied to clipboard
open override fun toString(): String

Properties

action
Link copied to clipboard
var action: String?

String or null specifying request or response type of packet.

data
Link copied to clipboard
var data: JsonElement? = null

Arbitratry hierarchy of containers and values.

flags
Link copied to clipboard
var flags: Collection<String>

Collection of Strings that communicate extra information in this packet. Can be used with null action.

identifier
Link copied to clipboard
var identifier: String?

Randomly generated String, or null, that should be shared by and unique to each request-response pair.

Sources

jvm source
Link copied to clipboard