Convert context to use generics/dynamic characters #466

GregHib · Jan 16, 2025 · 7045e86 · 7045e86
1 parent 8aca877
commit 7045e86
Show file tree

Hide file tree

Showing 139 changed files with 666 additions and 594 deletions.
diff --git a/engine/src/main/kotlin/world/gregs/voidps/engine/client/ui/InterfaceOption.kt b/engine/src/main/kotlin/world/gregs/voidps/engine/client/ui/InterfaceOption.kt
@@ -1,21 +1,21 @@
 package world.gregs.voidps.engine.client.ui
 
-import world.gregs.voidps.engine.entity.character.Character
 import world.gregs.voidps.engine.entity.character.mode.interact.Interaction
+import world.gregs.voidps.engine.entity.character.player.Player
 import world.gregs.voidps.engine.entity.item.Item
 import world.gregs.voidps.engine.event.EventDispatcher
 import world.gregs.voidps.engine.event.Events
 
 data class InterfaceOption(
-    override val character: Character,
+    override val character: Player,
     val id: String,
     val component: String,
     val optionIndex: Int,
     val option: String,
     val item: Item,
     val itemSlot: Int,
     val inventory: String
-) : Interaction() {
+) : Interaction<Player>() {
     override fun copy(approach: Boolean) = copy().apply { this.approach = approach }
 
     override val size = 5

diff --git a/engine/src/main/kotlin/world/gregs/voidps/engine/client/ui/event/Command.kt b/engine/src/main/kotlin/world/gregs/voidps/engine/client/ui/event/Command.kt
@@ -9,10 +9,12 @@ import world.gregs.voidps.engine.event.EventDispatcher
 import world.gregs.voidps.engine.event.Events
 
 data class Command(
-    override val character: Character,
+    val player: Player,
     val prefix: String,
     val content: String
-) : Interaction() {
+) : Interaction<Player>() {
+    override val character = player
+
     override fun copy(approach: Boolean) = copy().apply { this.approach = approach }
 
     override val size = 3

diff --git a/engine/src/main/kotlin/world/gregs/voidps/engine/client/ui/interact/ItemOnFloorItem.kt b/engine/src/main/kotlin/world/gregs/voidps/engine/client/ui/interact/ItemOnFloorItem.kt
@@ -2,21 +2,22 @@ package world.gregs.voidps.engine.client.ui.interact
 
 import world.gregs.voidps.engine.entity.character.Character
 import world.gregs.voidps.engine.entity.character.mode.interact.Interaction
+import world.gregs.voidps.engine.entity.character.player.Player
 import world.gregs.voidps.engine.entity.item.Item
 import world.gregs.voidps.engine.entity.item.floor.FloorItem
 import world.gregs.voidps.engine.event.EventDispatcher
 import world.gregs.voidps.engine.event.Events
 import world.gregs.voidps.engine.suspend.arriveDelay
 
-data class ItemOnFloorItem(
-    override val character: Character,
+data class ItemOnFloorItem<C : Character>(
+    override val character: C,
     val floorItem: FloorItem,
     val id: String,
     val component: String,
     val item: Item,
     val itemSlot: Int,
     val inventory: String
-) : Interaction() {
+) : Interaction<C>() {
     override fun copy(approach: Boolean) = copy().apply { this.approach = approach }
 
     override val size = 5
@@ -31,17 +32,17 @@ data class ItemOnFloorItem(
     }
 }
 
-fun itemOnFloorItemOperate(item: String = "*", floorItem: String = "*", id: String = "*", component: String = "*", arrive: Boolean = true, handler: suspend ItemOnFloorItem.() -> Unit) {
-    Events.handle<ItemOnFloorItem>("item_approach_floor_item", item, floorItem, id, component) {
+fun itemOnFloorItemOperate(item: String = "*", floorItem: String = "*", id: String = "*", component: String = "*", arrive: Boolean = true, handler: suspend ItemOnFloorItem<Player>.() -> Unit) {
+    Events.handle<ItemOnFloorItem<Player>>("item_approach_floor_item", item, floorItem, id, component) {
         if (arrive) {
             arriveDelay()
         }
         handler.invoke(this)
     }
 }
 
-fun itemOnFloorItemApproach(item: String = "*", floorItem: String = "*", id: String = "*", component: String = "*", handler: suspend ItemOnFloorItem.() -> Unit) {
-    Events.handle<ItemOnFloorItem>("item_approach_floor_item", item, floorItem, id, component) {
+fun itemOnFloorItemApproach(item: String = "*", floorItem: String = "*", id: String = "*", component: String = "*", handler: suspend ItemOnFloorItem<Player>.() -> Unit) {
+    Events.handle<ItemOnFloorItem<Player>>("item_approach_floor_item", item, floorItem, id, component) {
         handler.invoke(this)
     }
 }
diff --git a/engine/src/main/kotlin/world/gregs/voidps/engine/client/ui/interact/ItemOnNPC.kt b/engine/src/main/kotlin/world/gregs/voidps/engine/client/ui/interact/ItemOnNPC.kt
@@ -1,23 +1,26 @@
 package world.gregs.voidps.engine.client.ui.interact
 
-import world.gregs.voidps.engine.entity.character.Character
 import world.gregs.voidps.engine.entity.character.mode.interact.Interaction
 import world.gregs.voidps.engine.entity.character.mode.interact.TargetNPCContext
 import world.gregs.voidps.engine.entity.character.npc.NPC
+import world.gregs.voidps.engine.entity.character.player.Player
 import world.gregs.voidps.engine.entity.item.Item
 import world.gregs.voidps.engine.event.EventDispatcher
 import world.gregs.voidps.engine.event.Events
 import world.gregs.voidps.engine.suspend.arriveDelay
 
 data class ItemOnNPC(
-    override val character: Character,
+    val player: Player,
     override val target: NPC,
     val id: String,
     val component: String,
     val item: Item,
     val itemSlot: Int,
     val inventory: String
-) : Interaction(), TargetNPCContext {
+) : Interaction<Player>(), TargetNPCContext<Player> {
+
+    override val character = player
+
     override fun copy(approach: Boolean) = copy().apply { this.approach = approach }
 
     override val size = 5

diff --git a/engine/src/main/kotlin/world/gregs/voidps/engine/client/ui/interact/ItemOnObject.kt b/engine/src/main/kotlin/world/gregs/voidps/engine/client/ui/interact/ItemOnObject.kt
@@ -1,6 +1,5 @@
 package world.gregs.voidps.engine.client.ui.interact
 
-import world.gregs.voidps.engine.entity.character.Character
 import world.gregs.voidps.engine.entity.character.mode.interact.Interaction
 import world.gregs.voidps.engine.entity.character.mode.interact.TargetObjectContext
 import world.gregs.voidps.engine.entity.character.player.Player
@@ -11,14 +10,16 @@ import world.gregs.voidps.engine.event.Events
 import world.gregs.voidps.engine.suspend.arriveDelay
 
 data class ItemOnObject(
-    override val character: Character,
+    val player: Player,
     override val target: GameObject,
     val id: String,
     val component: String,
     val item: Item,
     val itemSlot: Int,
     val inventory: String
-) : Interaction(), TargetObjectContext {
+) : Interaction<Player>(), TargetObjectContext<Player> {
+    override val character = player
+
     override fun copy(approach: Boolean) = copy().apply { this.approach = approach }
 
     override val size = 5

diff --git a/engine/src/main/kotlin/world/gregs/voidps/engine/client/ui/interact/ItemOnPlayer.kt b/engine/src/main/kotlin/world/gregs/voidps/engine/client/ui/interact/ItemOnPlayer.kt
@@ -9,15 +9,15 @@ import world.gregs.voidps.engine.event.EventDispatcher
 import world.gregs.voidps.engine.event.Events
 import world.gregs.voidps.engine.suspend.arriveDelay
 
-data class ItemOnPlayer(
-    override val character: Character,
+data class ItemOnPlayer<C: Character>(
+    override val character: C,
     override val target: Player,
     val id: String,
     val component: String,
     val item: Item,
     val itemSlot: Int,
     val inventory: String
-) : Interaction(), TargetPlayerContext {
+) : Interaction<C>(), TargetPlayerContext<C> {
     override fun copy(approach: Boolean) = copy().apply { this.approach = approach }
 
     override val size = 4
@@ -31,17 +31,17 @@ data class ItemOnPlayer(
     }
 }
 
-fun itemOnPlayerOperate(item: String = "*", id: String = "*", component: String = "*", arrive: Boolean = true, override: Boolean = true, handler: suspend ItemOnPlayer.() -> Unit) {
-    Events.handle<ItemOnPlayer>("item_on_operate_player", item, id, component, override = override) {
+fun itemOnPlayerOperate(item: String = "*", id: String = "*", component: String = "*", arrive: Boolean = true, override: Boolean = true, handler: suspend ItemOnPlayer<Player>.() -> Unit) {
+    Events.handle<ItemOnPlayer<Player>>("item_on_operate_player", item, id, component, override = override) {
         if (arrive) {
             arriveDelay()
         }
         handler.invoke(this)
     }
 }
 
-fun itemOnPlayerApproach(item: String = "*", id: String = "*", component: String = "*", override: Boolean = true, handler: suspend ItemOnPlayer.() -> Unit) {
-    Events.handle<ItemOnPlayer>("item_on_approach_player", item, id, component, override = override) {
+fun itemOnPlayerApproach(item: String = "*", id: String = "*", component: String = "*", override: Boolean = true, handler: suspend ItemOnPlayer<Player>.() -> Unit) {
+    Events.handle<ItemOnPlayer<Player>>("item_on_approach_player", item, id, component, override = override) {
         handler.invoke(this)
     }
 }
diff --git a/engine/src/main/kotlin/world/gregs/voidps/engine/entity/character/CharacterContext.kt b/engine/src/main/kotlin/world/gregs/voidps/engine/entity/character/CharacterContext.kt
@@ -6,11 +6,11 @@ import world.gregs.voidps.engine.entity.character.player.Player
 /**
  * Context of a queue or interaction action to access a [character] as either [player] or [npc] but which is only known implicitly
  */
-interface CharacterContext {
-    val character: Character
-    val player: Player
-        get() = character as Player
-    val npc: NPC
-        get() = character as NPC
+interface CharacterContext<C: Character> {
+    val character: C
     var onCancel: (() -> Unit)?
+    val CharacterContext<Player>.player: Player
+        get() = character
+    val CharacterContext<NPC>.npc: NPC
+        get() = character
 }
diff --git a/engine/src/main/kotlin/world/gregs/voidps/engine/entity/character/mode/interact/Interact.kt b/engine/src/main/kotlin/world/gregs/voidps/engine/entity/character/mode/interact/Interact.kt
@@ -28,18 +28,18 @@ import world.gregs.voidps.engine.suspend.resumeSuspension
 class Interact(
     character: Character,
     val target: Entity,
-    interaction: Interaction,
+    interaction: Interaction<*>,
     strategy: TargetStrategy = TargetStrategy(target),
     private var approachRange: Int? = null,
     private val faceTarget: Boolean = true,
     shape: Int? = null
 ) : Movement(character, strategy, shape) {
 
-    private var approach: Interaction = interaction.copy(true)
-    private var operate: Interaction = interaction.copy(false)
+    private var approach: Interaction<*> = interaction.copy(true)
+    private var operate: Interaction<*> = interaction.copy(false)
     private var clearInteracted = false
 
-    fun updateInteraction(interaction: Interaction) {
+    fun updateInteraction(interaction: Interaction<*>) {
         approach = interaction.copy(true)
         operate = interaction.copy(false)
         clearInteracted = true
@@ -151,7 +151,7 @@ class Interact(
     /**
      * Continue any suspended, clear any finished or start a new interaction
      */
-    private fun launch(event: Interaction): Boolean {
+    private fun launch(event: Interaction<*>): Boolean {
         if (character.suspension != null) {
             character.resumeSuspension()
             return true

diff --git a/...e/src/main/kotlin/world/gregs/voidps/engine/entity/character/mode/interact/Interaction.kt b/...e/src/main/kotlin/world/gregs/voidps/engine/entity/character/mode/interact/Interaction.kt
@@ -1,15 +1,16 @@
 package world.gregs.voidps.engine.entity.character.mode.interact
 
+import world.gregs.voidps.engine.entity.character.Character
 import world.gregs.voidps.engine.entity.character.CharacterContext
 import world.gregs.voidps.engine.event.CancellableEvent
 import world.gregs.voidps.engine.event.SuspendableEvent
 
-abstract class Interaction : CancellableEvent(), SuspendableEvent, CharacterContext {
+abstract class Interaction<C: Character> : CancellableEvent(), SuspendableEvent, CharacterContext<C> {
     var approach = false
     val operate: Boolean
         get() = !approach
     override var onCancel: (() -> Unit)? = null
     var launched = false
 
-    abstract fun copy(approach: Boolean): Interaction
+    abstract fun copy(approach: Boolean): Interaction<C>
 }
diff --git a/...kotlin/world/gregs/voidps/engine/entity/character/mode/interact/TargetFloorItemContext.kt b/...kotlin/world/gregs/voidps/engine/entity/character/mode/interact/TargetFloorItemContext.kt
@@ -1,8 +1,9 @@
 package world.gregs.voidps.engine.entity.character.mode.interact
 
+import world.gregs.voidps.engine.entity.character.Character
 import world.gregs.voidps.engine.entity.character.CharacterContext
 import world.gregs.voidps.engine.entity.item.floor.FloorItem
 
-interface TargetFloorItemContext : CharacterContext {
+interface TargetFloorItemContext<C: Character> : CharacterContext<C> {
     val target: FloorItem
 }
diff --git a/.../main/kotlin/world/gregs/voidps/engine/entity/character/mode/interact/TargetNPCContext.kt b/.../main/kotlin/world/gregs/voidps/engine/entity/character/mode/interact/TargetNPCContext.kt
@@ -1,8 +1,9 @@
 package world.gregs.voidps.engine.entity.character.mode.interact
 
+import world.gregs.voidps.engine.entity.character.Character
 import world.gregs.voidps.engine.entity.character.CharacterContext
 import world.gregs.voidps.engine.entity.character.npc.NPC
 
-interface TargetNPCContext : CharacterContext {
+interface TargetNPCContext<C: Character> : CharacterContext<C> {
     val target: NPC
 }
diff --git a/...in/kotlin/world/gregs/voidps/engine/entity/character/mode/interact/TargetObjectContext.kt b/...in/kotlin/world/gregs/voidps/engine/entity/character/mode/interact/TargetObjectContext.kt
@@ -1,8 +1,9 @@
 package world.gregs.voidps.engine.entity.character.mode.interact
 
+import world.gregs.voidps.engine.entity.character.Character
 import world.gregs.voidps.engine.entity.character.CharacterContext
 import world.gregs.voidps.engine.entity.obj.GameObject
 
-interface TargetObjectContext : CharacterContext {
+interface TargetObjectContext<C: Character> : CharacterContext<C> {
     val target: GameObject
 }
diff --git a/...in/kotlin/world/gregs/voidps/engine/entity/character/mode/interact/TargetPlayerContext.kt b/...in/kotlin/world/gregs/voidps/engine/entity/character/mode/interact/TargetPlayerContext.kt
@@ -1,8 +1,9 @@
 package world.gregs.voidps.engine.entity.character.mode.interact
 
+import world.gregs.voidps.engine.entity.character.Character
 import world.gregs.voidps.engine.entity.character.CharacterContext
 import world.gregs.voidps.engine.entity.character.player.Player
 
-interface TargetPlayerContext : CharacterContext {
+interface TargetPlayerContext<C: Character> : CharacterContext<C> {
     val target: Player
 }
diff --git a/engine/src/main/kotlin/world/gregs/voidps/engine/entity/character/mode/move/AreaEntered.kt b/engine/src/main/kotlin/world/gregs/voidps/engine/entity/character/mode/move/AreaEntered.kt
@@ -9,12 +9,12 @@ import world.gregs.voidps.engine.event.Events
 import world.gregs.voidps.engine.event.SuspendableEvent
 import world.gregs.voidps.type.Area
 
-data class AreaEntered(
-    override val character: Character,
+data class AreaEntered<C: Character>(
+    override val character: C,
     val name: String,
     val tags: Set<String>,
     val area: Area
-) : SuspendableEvent, CharacterContext {
+) : SuspendableEvent, CharacterContext<C> {
     override var onCancel: (() -> Unit)? = null
 
     override val size = 5
@@ -29,20 +29,20 @@ data class AreaEntered(
     }
 }
 
-fun enterArea(area: String = "*", tag: String = "*", handler: suspend AreaEntered.() -> Unit) {
-    Events.handle<Player, AreaEntered>("player_enter", area, "player", tag, "*") {
+fun enterArea(area: String = "*", tag: String = "*", handler: suspend AreaEntered<Player>.() -> Unit) {
+    Events.handle<Player, AreaEntered<Player>>("player_enter", area, "player", tag, "*") {
         handler.invoke(this)
     }
 }
 
-fun npcEnterArea(npc: String = "*", area: String = "*", tag: String = "*", handler: suspend AreaEntered.() -> Unit) {
-    Events.handle<NPC, AreaEntered>("npc_enter", area, npc, tag, "*") {
+fun npcEnterArea(npc: String = "*", area: String = "*", tag: String = "*", handler: suspend AreaEntered<NPC>.() -> Unit) {
+    Events.handle<NPC, AreaEntered<NPC>>("npc_enter", area, npc, tag, "*") {
         handler.invoke(this)
     }
 }
 
-fun characterEnterArea(area: String = "*", tag: String = "*", handler: suspend AreaEntered.() -> Unit) {
-    val block: suspend AreaEntered.(EventDispatcher) -> Unit = {
+fun characterEnterArea(area: String = "*", tag: String = "*", handler: suspend AreaEntered<Character>.() -> Unit) {
+    val block: suspend AreaEntered<Character>.(EventDispatcher) -> Unit = {
         handler.invoke(this)
     }
     Events.handle("player_enter", area, "player", tag, "*", handler = block)

diff --git a/engine/src/main/kotlin/world/gregs/voidps/engine/entity/character/mode/move/AreaExited.kt b/engine/src/main/kotlin/world/gregs/voidps/engine/entity/character/mode/move/AreaExited.kt
@@ -9,12 +9,12 @@ import world.gregs.voidps.engine.event.Events
 import world.gregs.voidps.engine.event.SuspendableEvent
 import world.gregs.voidps.type.Area
 
-data class AreaExited(
-    override val character: Character,
+data class AreaExited<C: Character>(
+    override val character: C,
     val name: String,
     val tags: Set<String>,
     val area: Area
-) : SuspendableEvent, CharacterContext {
+) : SuspendableEvent, CharacterContext<C> {
     override var onCancel: (() -> Unit)? = null
 
     override val size = 5
@@ -29,20 +29,20 @@ data class AreaExited(
     }
 }
 
-fun exitArea(area: String = "*", tag: String = "*", handler: suspend AreaExited.() -> Unit) {
-    Events.handle<Player, AreaExited>("player_exit", area, "player", tag, "*") {
+fun exitArea(area: String = "*", tag: String = "*", handler: suspend AreaExited<Player>.() -> Unit) {
+    Events.handle<Player, AreaExited<Player>>("player_exit", area, "player", tag, "*") {
         handler.invoke(this)
     }
 }
 
-fun npcExitArea(npc: String = "*", area: String = "*", tag: String = "*", handler: suspend AreaExited.() -> Unit) {
-    Events.handle<NPC, AreaExited>("npc_exit", area, npc, tag, "*") {
+fun npcExitArea(npc: String = "*", area: String = "*", tag: String = "*", handler: suspend AreaExited<NPC>.() -> Unit) {
+    Events.handle<NPC, AreaExited<NPC>>("npc_exit", area, npc, tag, "*") {
         handler.invoke(this)
     }
 }
 
-fun characterExitArea(area: String = "*", tag: String = "*", handler: suspend AreaExited.() -> Unit) {
-    val block: suspend AreaExited.(EventDispatcher) -> Unit = {
+fun characterExitArea(area: String = "*", tag: String = "*", handler: suspend AreaExited<Character>.() -> Unit) {
+    val block: suspend AreaExited<Character>.(EventDispatcher) -> Unit = {
         handler.invoke(this)
     }
     Events.handle("player_exit", area, "player", tag, "*", handler = block)