2006-Scape/apollo
1
0
Fork 0
mirror of https://github.com/2006-Scape/apollo.git synced 2026-07-07 08:39:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Let plugins intercept Events

Browse Source 
Support for PlayerEvents already exists, but general event
support wasn't included in the original KotlinPluginScript.
This commit is contained in:
Major
2017-09-24 18:13:17 +01:00
parent ae3d3c7ce2
commit cb9e6f353d
2 changed files with 116 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files
game/src/main/kotlin/org/apollo/game/plugin/kotlin/KotlinPluginScript.kt
+112 -63
View File
@@ -7,6 +7,7 @@ import org.apollo.game.message.impl.ButtonMessage
import org.apollo.game.model.World import org.apollo.game.model.World
import org.apollo.game.model.entity.Player import org.apollo.game.model.entity.Player
import org.apollo.game.model.entity.setting.PrivilegeLevel import org.apollo.game.model.entity.setting.PrivilegeLevel
import org.apollo.game.model.event.Event
import org.apollo.game.model.event.EventListener import org.apollo.game.model.event.EventListener
import org.apollo.game.model.event.PlayerEvent import org.apollo.game.model.event.PlayerEvent
import org.apollo.game.plugin.PluginContext import org.apollo.game.plugin.PluginContext
@@ -15,103 +16,151 @@ import kotlin.reflect.KClass
import kotlin.script.templates.ScriptTemplateDefinition import kotlin.script.templates.ScriptTemplateDefinition
@ScriptTemplateDefinition( @ScriptTemplateDefinition(
scriptFilePattern = ".*\\.plugin\\.kts" scriptFilePattern = ".*\\.plugin\\.kts"
) )
abstract class KotlinPluginScript(private var world: World, val context: PluginContext) { abstract class KotlinPluginScript(private var world: World, val context: PluginContext) {
var startListener: (World) -> Unit = { _ -> }; var startListener: (World) -> Unit = { _ -> }
var stopListener: (World) -> Unit = { _ -> }; var stopListener: (World) -> Unit = { _ -> }
/** /**
* Create a new [MessageHandler]. * Creates a [MessageHandler].
*/ */
fun <T : Message> on(type: () -> KClass<T>) = KotlinMessageHandler<T>(world, context, type.invoke()) fun <T : Message> on(type: () -> KClass<T>) = KotlinMessageHandler(world, context, type.invoke())
/** /**
* Create a new [EventListener] for a type of [PlayerEvent]. * Create an [EventListener] for a [PlayerEvent].
*/ */
fun <T : PlayerEvent> on_player_event(type: () -> KClass<T>) = KotlinPlayerEventHandler(world, type.invoke()) fun <T : PlayerEvent> on_player_event(type: () -> KClass<T>) = KotlinPlayerEventHandler(world, type.invoke())
/** /**
* Create a new [CommandHandler] for the given _command_ name, which only players with a [PrivelegeLevel] * Create an [EventListener] for an [Event].
* of _privileges_ and above can use. */
*/ fun <T : Event> on_event(type: () -> KClass<T>) = KotlinEventHandler(world, type.invoke())
fun on_command(command: String, privileges: PrivilegeLevel) = KotlinCommandHandler(world, command, privileges)
/** /**
* Create a new [ButtonMessage] [MessageHandler] for the given _button_ id. * Create a [CommandListener] for the given [command] name, which only players with a [PrivilegeLevel]
*/ * of [privileges] and above can use.
fun on_button(button: Int) = on { ButtonMessage::class }.where { widgetId == button } */
fun on_command(command: String, privileges: PrivilegeLevel) = KotlinCommandHandler(world, command, privileges)
fun start(callback: (World) -> Unit) { /**
this.startListener = callback * Create a [ButtonMessage] [MessageHandler] for the given [id].
} */
fun on_button(id: Int) = on { ButtonMessage::class }.where { widgetId == id }
fun stop(callback: (World) -> Unit) { fun start(callback: (World) -> Unit) {
this.stopListener = callback this.startListener = callback
} }
fun doStart(world: World) { fun stop(callback: (World) -> Unit) {
this.startListener.invoke(world) this.stopListener = callback
} }
fun doStart(world: World) {
this.startListener.invoke(world)
}
fun doStop(world: World) {
this.stopListener.invoke(world)
}
fun doStop(world: World) {
this.stopListener.invoke(world)
}
} }
/**
* A proxy interface for any handler that operates on [Player]s.
*/
interface KotlinPlayerHandlerProxyTrait<S : Any> { interface KotlinPlayerHandlerProxyTrait<S : Any> {
var callback: S.(Player) -> Unit var callback: S.(Player) -> Unit
var predicate: S.() -> Boolean var predicate: S.() -> Boolean
fun where(predicate: S.() -> Boolean): KotlinPlayerHandlerProxyTrait<S> { fun register()
this.predicate = predicate
return this
}
fun then(callback: S.(Player) -> Unit) { fun where(predicate: S.() -> Boolean): KotlinPlayerHandlerProxyTrait<S> {
this.callback = callback this.predicate = predicate
this.register() return this
} }
fun register() fun then(callback: S.(Player) -> Unit) {
this.callback = callback
this.register()
}
fun handleProxy(player: Player, subject: S) {
if (subject.predicate()) {
subject.callback(player)
}
}
fun handleProxy(player: Player, subject: S) {
if (subject.predicate()) {
subject.callback(player)
}
}
} }
/**
* A handler for [PlayerEvent]s.
*/
class KotlinPlayerEventHandler<T : PlayerEvent>(val world: World, val type: KClass<T>) : class KotlinPlayerEventHandler<T : PlayerEvent>(val world: World, val type: KClass<T>) :
KotlinPlayerHandlerProxyTrait<T>, EventListener<T> { KotlinPlayerHandlerProxyTrait<T>, EventListener<T> {
override var callback: T.(Player) -> Unit = {} override var callback: T.(Player) -> Unit = {}
override var predicate: T.() -> Boolean = { true } override var predicate: T.() -> Boolean = { true }
override fun handle(event: T) = handleProxy(event.player, event) override fun handle(event: T) = handleProxy(event.player, event)
override fun register() = world.listenFor(type.java, this) override fun register() = world.listenFor(type.java, this)
} }
/**
* A handler for [Event]s.
*/
class KotlinEventHandler<S : Event>(val world: World, val type: KClass<S>) : EventListener<S> {
private var callback: S.() -> Unit = {}
private var predicate: S.() -> Boolean = { true }
fun where(predicate: S.() -> Boolean): KotlinEventHandler<S> {
this.predicate = predicate
return this
}
fun then(callback: S.() -> Unit) {
this.callback = callback
this.register()
}
override fun handle(event: S) {
if (event.predicate()) {
event.callback()
}
}
fun register() = world.listenFor(type.java, this)
}
/**
* A handler for [Message]s.
*/
class KotlinMessageHandler<T : Message>(val world: World, val context: PluginContext, val type: KClass<T>) : class KotlinMessageHandler<T : Message>(val world: World, val context: PluginContext, val type: KClass<T>) :
KotlinPlayerHandlerProxyTrait<T>, MessageHandler<T>(world) { KotlinPlayerHandlerProxyTrait<T>, MessageHandler<T>(world) {
override var callback: T.(Player) -> Unit = {} override var callback: T.(Player) -> Unit = {}
override var predicate: T.() -> Boolean = { true } override var predicate: T.() -> Boolean = { true }
override fun handle(player: Player, message: T) = handleProxy(player, message) override fun handle(player: Player, message: T) = handleProxy(player, message)
override fun register() = context.addMessageHandler(type.java, this) override fun register() = context.addMessageHandler(type.java, this)
} }
/**
* A handler for [Command]s.
*/
class KotlinCommandHandler(val world: World, val command: String, privileges: PrivilegeLevel) : class KotlinCommandHandler(val world: World, val command: String, privileges: PrivilegeLevel) :
KotlinPlayerHandlerProxyTrait<Command>, CommandListener(privileges) { KotlinPlayerHandlerProxyTrait<Command>, CommandListener(privileges) {
override var callback: Command.(Player) -> Unit = {} override var callback: Command.(Player) -> Unit = {}
override var predicate: Command.() -> Boolean = { true } override var predicate: Command.() -> Boolean = { true }
override fun execute(player: Player, command: Command) = handleProxy(player, command) override fun execute(player: Player, command: Command) = handleProxy(player, command)
override fun register() = world.commandDispatcher.register(command, this) override fun register() = world.commandDispatcher.register(command, this)
} }
game/src/main/kotlin/stub.kt
+4 -4
View File
@@ -7,19 +7,19 @@
*/ */
import org.apollo.game.command.Command import org.apollo.game.command.Command
import org.apollo.game.message.handler.MessageHandlerChainSet
import org.apollo.game.message.impl.ButtonMessage import org.apollo.game.message.impl.ButtonMessage
import org.apollo.game.model.World import org.apollo.game.model.World
import org.apollo.game.model.area.RegionRepository
import org.apollo.game.model.entity.*
import org.apollo.game.model.entity.setting.PrivilegeLevel import org.apollo.game.model.entity.setting.PrivilegeLevel
import org.apollo.game.model.event.Event
import org.apollo.game.model.event.PlayerEvent import org.apollo.game.model.event.PlayerEvent
import org.apollo.game.plugin.kotlin.* import org.apollo.game.plugin.kotlin.KotlinEventHandler
import org.apollo.game.plugin.kotlin.KotlinPlayerHandlerProxyTrait
import org.apollo.net.message.Message import org.apollo.net.message.Message
import kotlin.reflect.KClass import kotlin.reflect.KClass
fun <T : Message> on(type: () -> KClass<T>): KotlinPlayerHandlerProxyTrait<T> = null!! fun <T : Message> on(type: () -> KClass<T>): KotlinPlayerHandlerProxyTrait<T> = null!!
fun <T : PlayerEvent> on_player_event(type: () -> KClass<T>): KotlinPlayerHandlerProxyTrait<T> = null!! fun <T : PlayerEvent> on_player_event(type: () -> KClass<T>): KotlinPlayerHandlerProxyTrait<T> = null!!
fun <T : Event> on_event(type: () -> KClass<T>): KotlinEventHandler<T> = null!!
fun on_command(command: String, privileges: PrivilegeLevel): KotlinPlayerHandlerProxyTrait<Command> = null!! fun on_command(command: String, privileges: PrivilegeLevel): KotlinPlayerHandlerProxyTrait<Command> = null!!
fun on_button(button: Int): KotlinPlayerHandlerProxyTrait<ButtonMessage> = null!! fun on_button(button: Int): KotlinPlayerHandlerProxyTrait<ButtonMessage> = null!!