Summoning: complete familiar abilities (specials, passives, dialogue)

cache/src/main/kotlin/world/gregs/voidps/cache/definition/Params.kt

@@ -262,9 +262,11 @@ object Params {
     const val QUEST_INFO = 5262
     const val VARIABLES = 5263
     const val SUMMONING_BEAST_OF_BURDEN_ESSENCE = 5264
+    const val SUMMONING_SPECIAL_COST = 5265
 
     private fun custom(name: String) = when (name) {
         "summoning_beast_of_burden_essence" -> SUMMONING_BEAST_OF_BURDEN_ESSENCE
+        "summoning_special_cost" -> SUMMONING_SPECIAL_COST
         "variables" -> VARIABLES
         "quest_info" -> QUEST_INFO
         "skill_cape_t" -> SKILL_CAPE_T

cache/src/main/kotlin/world/gregs/voidps/cache/definition/encoder/GraphicEncoder.kt

@@ -0,0 +1,77 @@
+package world.gregs.voidps.cache.definition.encoder
+
+import world.gregs.voidps.buffer.write.Writer
+import world.gregs.voidps.cache.DefinitionEncoder
+import world.gregs.voidps.cache.definition.data.GraphicDefinition
+
+class GraphicEncoder : DefinitionEncoder<GraphicDefinition> {
+
+    override fun Writer.encode(definition: GraphicDefinition, members: GraphicDefinition) {
+        if (definition.id == -1) {
+            return
+        }
+
+        if (definition.modelId != 0) {
+            writeByte(1)
+            writeShort(definition.modelId)
+        }
+
+        if (definition.animationId != -1) {
+            writeByte(2)
+            writeShort(definition.animationId)
+        }
+
+        if (definition.sizeXY != 128) {
+            writeByte(4)
+            writeShort(definition.sizeXY)
+        }
+
+        if (definition.sizeZ != 128) {
+            writeByte(5)
+            writeShort(definition.sizeZ)
+        }
+
+        if (definition.rotation != 0) {
+            writeByte(6)
+            writeShort(definition.rotation)
+        }
+
+        if (definition.ambience != 0) {
+            writeByte(7)
+            writeByte(definition.ambience)
+        }
+
+        if (definition.contrast != 0) {
+            writeByte(8)
+            writeByte(definition.contrast)
+        }
+
+        when (definition.aByte2381.toInt()) {
+            1 -> writeByte(11)
+            2 -> {
+                writeByte(14)
+                writeByte(definition.anInt2385 / 256)
+            }
+            3 -> when {
+                definition.anInt2385 == 8224 -> writeByte(9)
+                definition.anInt2385 in 0..0xffff -> {
+                    writeByte(15)
+                    writeShort(definition.anInt2385)
+                }
+                else -> {
+                    writeByte(16)
+                    writeInt(definition.anInt2385)
+                }
+            }
+            4 -> writeByte(12)
+            5 -> writeByte(13)
+        }
+
+        if (definition.aBoolean2402) {
+            writeByte(10)
+        }
+
+        definition.writeColoursTextures(this)
+        writeByte(0)
+    }
+}

data/area/asgarnia/taverley/taverley.npc-spawns.toml

@@ -1,8 +1,7 @@
 spawns = [
 # 11573
   { id = "sanfew", x = 2897, y = 3426, level = 1, members = true },
-  { id = "pikkupstix_spawn", x = 2925, y = 3443 },
-  { id = "pikkupstix_spawn_2", x = 2925, y = 3443 },
+  { id = "pikkupstix", x = 2925, y = 3443 },
   { id = "thaerisk_cemphier", x = 2916, y = 3449, level = 1, members = true },
   { id = "ivy_sophista", x = 2917, y = 3449, members = true },
   { id = "dalmatian", x = 2927, y = 3431, members = true },

data/client/all.enums.toml

@@ -371,11 +371,11 @@ id = 1187
 [summoning_scroll_ids_1]
 id = 1188
 
-# Used if varp 4282 > 50
+# Chathead animation from varbit 4282 minus 50, used by cs2 751 when the varbit is over 50
 [pet_details_chathead_animations_sad]
 id = 1275
 
-# Used if varp 4282 <= 50
+# Chathead animation from varbit 4282, used by cs2 751 when the varbit is 50 or under
 [pet_details_chathead_animations_normal]
 id = 1276
 

data/entity/player/modal/toplevel/gameframe.ifaces.toml

@@ -210,12 +210,11 @@ id = 12
 [.renew_familiar]
 id = 13
 
-# Can't yet confirm that these 2 are cast / attack.
-# Likely IDs 21 and 22 will be their left-click options as well
-#[.n14]
-#id = 14
-#
-#[.n15]
+[.attack]
+id = 14
+
+# id 15 is the (still unconfirmed) cast option; its left-click counterpart is likely 22.
+#[.cast]
 #id = 15
 
 [.leftclick_follower_details]
@@ -233,6 +232,9 @@ id = 19
 [.leftclick_renew_familiar]
 id = 20
 
+[.leftclick_attack]
+id = 21
+
 
 [.cast_fetch_casket]
 id = 87

data/skill/summoning/familiar_overhead.tables.toml

@@ -0,0 +1,256 @@
+# Random overhead lines a summoned familiar periodically shouts (~every 30s, see
+# SummoningTimers). Sourced from the RuneScape Wiki transcript "Overhead dialogue"
+# sections. Keyed by familiar npc id; familiars without a row stay silent.
+
+[familiar_overhead]
+lines = "list<string>"
+
+[.spirit_wolf_familiar]
+lines = ["Grrrrr...", "Whuff-whuff!"]
+
+[.dreadfowl_familiar]
+lines = ["Bwaaak!", "Bwuk bwuk!"]
+
+[.vampire_bat_familiar]
+lines = ["Squeak!", "Squeak squeak!"]
+
+[.spirit_terrorbird_familiar]
+lines = ["Scree screee!", "Screee!"]
+
+[.granite_crab_familiar]
+lines = ["Chitter!", "Click click!"]
+
+[.praying_mantis_familiar]
+lines = ["Chitter!", "Clack clack!"]
+
+[.giant_ent_familiar]
+lines = ["Groooooan!", "Creeeeak!"]
+
+[.spirit_cobra_familiar]
+lines = ["Hssssssss!", "Hsss!"]
+
+[.spirit_dagannoth_familiar]
+lines = ["Raaaw!", "Grrrowl!"]
+
+[.thorny_snail_familiar]
+lines = ["Slither!", "Sclurp!"]
+
+[.beaver_familiar]
+lines = ["Gnawgnaw...", "Gnaw ..."]
+
+[.karamthulhu_overlord_familiar]
+lines = ["(Bow down!)", "(Obey!)"]
+
+[.hydra_familiar]
+lines = ["Rassssssp!", "Raaaaasp!"]
+
+[.spirit_jelly_familiar]
+lines = ["Jiggle!", "Flobble!"]
+
+[.bunyip_familiar]
+lines = ["Glorp glorp!", "Glorp!"]
+
+[.war_tortoise_familiar]
+lines = ["Hsss..."]
+
+[.fruit_bat_familiar]
+lines = ["Squeeeak!", "Squeee!"]
+
+[.abyssal_parasite_familiar]
+lines = ["Schlorp!", "Gurgle"]
+
+[.abyssal_lurker_familiar]
+lines = ["Craaaw!", "Screee!"]
+
+[.unicorn_stallion_familiar]
+lines = ["Whinney!", "Neigh!"]
+
+[.magpie_familiar]
+lines = ["Chirrup!", "Twitter!"]
+
+[.stranger_plant_familiar]
+lines = ["Rustle!", "Snapsnap!"]
+
+[.desert_wyrm_familiar]
+lines = ["Ssssss!", "Hssssss!"]
+
+[.evil_turnip_familiar]
+lines = ["Graaah!", "Hur hur hur!"]
+
+[.spirit_scorpion_familiar]
+lines = ["Clatter!", "Clack clack!"]
+
+[.arctic_bear_familiar]
+lines = ["Unf!", "Graaaowl!"]
+
+[.spirit_spider_familiar]
+lines = ["Clitterclatter!", "Click!"]
+
+[.bloated_leech_familiar]
+lines = ["Gurgle!", "Schlurp!"]
+
+[.spirit_kalphite_familiar]
+lines = ["Click click!", "Hsssss!"]
+
+[.honey_badger_familiar]
+lines = ["Raaaaar!", "Grooowl!"]
+
+[.albino_rat_familiar]
+lines = ["Squeee!", "Squeak squeak!"]
+
+[.granite_lobster_familiar]
+lines = ["Grind!", "Clonk clonk!"]
+
+[.macaw_familiar]
+lines = ["Braaak!", "Caw!"]
+
+[.bronze_minotaur_familiar]
+lines = ["Out of the way!", "Hey, no-horns!"]
+
+[.iron_minotaur_familiar]
+lines = ["Out of the way!", "Hey, no-horns!"]
+
+[.steel_minotaur_familiar]
+lines = ["Out of the way!", "Hey, no-horns!"]
+
+[.mithril_minotaur_familiar]
+lines = ["Out of the way!", "Hey, no-horns!"]
+
+[.adamant_minotaur_familiar]
+lines = ["Out of the way!", "Hey, no-horns!"]
+
+[.rune_minotaur_familiar]
+lines = ["Out of the way!", "Hey, no-horns!"]
+
+[.smoke_devil_familiar]
+lines = ["Hoot!", "Honk!"]
+
+[.bull_ant_familiar]
+lines = ["Click click!", "Click!"]
+
+[.wolpertinger_familiar]
+lines = ["Mew!", "Raawr!"]
+
+[.compost_mound_familiar]
+lines = ["Splutter!", "Schlorp!"]
+
+[.pack_yak_familiar]
+lines = ["Barooo barooo!", "Barooo!"]
+
+[.spirit_cockatrice_familiar]
+lines = ["Bwwwark bwwwark!", "Bwwwark!"]
+
+[.spirit_guthatrice_familiar]
+lines = ["Caaaw caaaw!", "Caaaw!"]
+
+[.spirit_saratrice_familiar]
+lines = ["Hoooot hoooot!", "Hoooot!"]
+
+[.spirit_zamatrice_familiar]
+lines = ["Screeee screeee!", "Screeee!"]
+
+[.spirit_pengatrice_familiar]
+lines = ["Awk awk!", "Awk!"]
+
+[.spirit_coraxatrice_familiar]
+lines = ["Craaw craaw!", "Craaw!"]
+
+[.spirit_vulatrice_familiar]
+lines = ["Scraaaaw scraaaaw!", "Scraaaaw!"]
+
+[.barker_toad_familiar]
+lines = ["Braaaaap!", "Craaaaaaak!"]
+
+[.ibis_familiar]
+lines = ["Chirp!", "Twitter!"]
+
+[.swamp_titan_familiar]
+lines = ["Something smells clean...", "The power of stench compels you!"]
+
+[.spirit_mosquito_familiar]
+lines = ["Bzzzzzzzzz!", "Whiiiiiine!"]
+
+[.void_spinner_familiar]
+lines = ["Whiiiiiir!", "Whiiiir!"]
+
+[.forge_regent_familiar]
+lines = ["Sizzle!", "Crackle!"]
+
+[.spirit_larupia_familiar]
+lines = ["Hssssss!", "Ssssss!"]
+
+[.geyser_titan_familiar]
+lines = ["Pah!", "Flee from me!"]
+
+[.lava_titan_familiar]
+lines = ["Sacred flames...", "By my fire..."]
+
+[.steel_titan_familiar]
+lines = ["Stand back!", "I Am Legend!"]
+
+[.obsidian_golem_familiar]
+lines = ["Onward to glory!", "Stand back!"]
+
+[.talon_beast_familiar]
+lines = ["Growwwl!", "Mrowl!"]
+
+[.abyssal_titan_familiar]
+lines = ["Mwanu b'ruum!", "T'verah hoshay!"]
+
+[.void_torcher_familiar]
+lines = ["Scree!", "Squaa!"]
+
+[.giant_chinchompa_familiar]
+lines = ["Squeek!", "Squeek squeek!"]
+
+[.fire_titan_familiar]
+lines = ["Come on and fight!", "Hey, tiny!"]
+
+[.moss_titan_familiar]
+lines = ["Don't get me mad!", "Little soft humies!"]
+
+[.ice_titan_familiar]
+lines = ["I'm melting!", "It's so warm here!"]
+
+[.spirit_tz-kih_familiar]
+lines = ["Squee!", "Squee squee!"]
+
+[.spirit_graahk_familiar]
+lines = ["Howl!", "Rowr!"]
+
+[.spirit_kyatt_familiar]
+lines = ["Grrrrrr!", "Mrrrowl!"]
+
+[.void_shifter_familiar]
+lines = ["Chitter!", "Scree!"]
+
+[.pyrelord_familiar]
+lines = ["Whoosh!", "Crackle!"]
+
+[.void_ravager_familiar]
+lines = ["Rarf!", "Grrrrr!"]
+
+[.ravenous_locust_familiar]
+lines = ["Whiiiiiine!", "Click!"]
+
+[.iron_titan_familiar]
+lines = ["Victory!", "Crush them!"]
+
+[.meerkats_familiar]
+lines = ["Squeak squeak!", "Simples!"]
+
+[.clay_familiar_class_1_familiar]
+lines = ["Rumble!", "Rumble, rumble!"]
+
+[.clay_familiar_class_2_familiar]
+lines = ["Rumble!", "Rumble, rumble!"]
+
+[.clay_familiar_class_3_familiar]
+lines = ["Rumble!", "Rumble, rumble!"]
+
+[.clay_familiar_class_4_familiar]
+lines = ["Rumble!", "Rumble, rumble!"]
+
+[.clay_familiar_class_5_familiar]
+lines = ["Rumble!", "Rumble, rumble!"]
+