Implement several actors/entities (#49)

* Implement the following actors/entities:
-Inn Toy Chest actor, which simply says you haven't unlocked mini-games
-Inn Glamour Dresser actor, which simply says you haven't unlocked the GD yet
-Orchestrion, which is fully functional as long as you have songs unlocked

Accompanying the orchestrion is the GM orchestrion command, with a caveat:
-It allows you to learn one song at a time, but id 0 (aka "all) doesn't learn a single
song for some unknown reason, so I've disabled it for now.

* Run cargo fmt

* Update USAGE.md
How many times will I forget...

USAGE.md

@@ -129,3 +129,4 @@ These GM commands are implemented in the FFXIV protocol, but only some of them a
 * `//gm lv <level>`: Sets your current level
 * `//gm aetheryte <on/off> <id>`: Unlock an Aetheryte.
 * `//gm speed <multiplier>`: Increases your movement speed by `multiplier`.
+* `//gm orchestrion <on/off> <id>`: Unlock an Orchestrion song.

resources/scripts/Global.lua

@@ -193,8 +193,11 @@ registerEvent(327918, "common/GenericAetheryte.lua") -- Dock Poga Aetheryte
 -- Misc. Events
 registerEvent(720915, "common/GenericMender.lua")
 registerEvent(720916, "custom/000/cmndefinnbed_00020.lua")
+registerEvent(721096, "tosort/ToyChest.lua")
 registerEvent(721028, "tosort/UnendingJourney.lua")
 registerEvent(721044, "tosort/CrystalBell.lua")
+registerEvent(721226, "tosort/Orchestrion.lua")
+registerEvent(721347, "tosort/GlamourDresser.lua")
 registerEvent(1179657, "tosort/Chocobokeep.lua") -- Chocobokeep in Central Shroud
 registerEvent(1245185, "opening/OpeningLimsaLominsa.lua")
 registerEvent(1245186, "opening/OpeningGridania.lua")

resources/scripts/commands/debug/UnlockAetheryte.lua

@@ -29,7 +29,7 @@ function onCommand(args, player)
         if id == "all" then
             id = 0
         else
-            player:send_message(sender.."Error parsing id parameter. Must be a territory id or the word 'all'."..usage)
+            player:send_message(sender.."Error parsing id parameter. Must be an aetheryte id or the word 'all'."..usage)
             return
         end
     end

resources/scripts/tosort/GlamourDresser.lua

@@ -0,0 +1,10 @@
+-- TODO: actually implement this menu
+
+function onTalk(target, player)
+    -- You have not yet unlocked the glamour dresser.
+    player:play_scene(target, EVENT_ID, 00000, 8192, 0)
+end
+
+function onReturn(scene, results, player)
+    player:finish_event(EVENT_ID)
+end

resources/scripts/tosort/Orchestrion.lua

@@ -0,0 +1,7 @@
+function onTalk(target, player)
+    player:play_scene(target, EVENT_ID, 00000, 8192, 0)
+end
+
+function onReturn(scene, results, player)
+    player:finish_event(EVENT_ID)
+end

resources/scripts/tosort/ToyChest.lua

@@ -0,0 +1,10 @@
+-- TODO: actually implement this menu
+
+function onTalk(target, player)
+    -- You have not yet unlocked any mini-games.
+    player:play_scene(target, EVENT_ID, 00000, 8192, 0)
+end
+
+function onReturn(scene, results, player)
+    player:finish_event(EVENT_ID)
+end

src/bin/kawari-world.rs

@@ -646,6 +646,27 @@ async fn client_loop(
                                                         connection.player_data.inventory.add_in_next_free_slot(Item { id: *arg0, quantity: 1 });
                                                         connection.send_inventory(false).await;
                                                     }
+                                                    GameMasterCommandType::Orchestrion => {
+                                                        let on = *arg0 == 1; // This command uses 1 for on, 2 for off.
+                                                        let id = *arg1 as u16;
+
+                                                        // id == 0 means "all"
+                                                        if id == 0 {
+                                                            /* Currently 792 songs ingame.
+                                                             * Commented out because this learns literally zero songs
+                                                             * for some unknown reason. */
+                                                            /*for i in 1..793 {
+                                                                let idd = i as u16;
+                                                                connection.send_message("test!").await;
+                                                                connection.actor_control_self(ActorControlSelf {
+                                                                    category: ActorControlCategory::ToggleOrchestrionUnlock { song_id: id, unlocked: on } }).await;
+                                                            }*/
+                                                        } else {
+                                                            connection.actor_control_self(ActorControlSelf {
+                                                                    category: ActorControlCategory::ToggleOrchestrionUnlock { song_id: id, unlocked: on }
+                                                            }).await;
+                                                        }
+                                                    }
                                                     GameMasterCommandType::Aetheryte => {
                                                         let on = *arg0 == 0;
                                                         let id = *arg1;

src/ipc/zone/actor_control.rs

@@ -84,6 +84,17 @@ pub enum ActorControlCategory {
     },
     #[brw(magic = 0xFu16)]
     CancelCast {},
+    #[brw(magic = 0x396u16)]
+    ToggleOrchestrionUnlock {
+        #[brw(pad_before = 2)] // padding
+        song_id: u16,
+        /* TODO: guessed, Sapphire suggests it's an u32 item id,
+        * but it behaves as an unlock boolean like aetherytes, so
+        perhaps it's been repurposed since Shadowbringers. */
+        #[br(map = read_bool_from::<u32>)]
+        #[bw(map = write_bool_as::<u32>)]
+        unlocked: bool,
+    },
 }
 
 #[binrw]

src/ipc/zone/mod.rs

@@ -144,6 +144,7 @@ pub enum GameMasterCommandType {
     ToggleInvisibility = 0xD,
     ToggleWireframe = 0x26,
     ChangeTerritory = 0x58,
+    Orchestrion = 0x74,
     GiveItem = 0xC8,
     Aetheryte = 0x5E,
 }