wow_world_messages 0.3.0

Message definitions for World of Warcraft world servers
Documentation
use std::io::{Read, Write};

use crate::Guid;
use crate::tbc::{
    Power, SpellEffect, SpellLog,
};

/// Auto generated from the original `wowm` in file [`wow_message_parser/wowm/world/spell/smsg_spelllogexecute.wowm:1`](https://github.com/gtker/wow_messages/tree/main/wow_message_parser/wowm/world/spell/smsg_spelllogexecute.wowm#L1):
/// ```text
/// smsg SMSG_SPELLLOGEXECUTE = 0x024C {
///     PackedGuid caster;
///     Spell spell;
///     u32 amount_of_effects;
///     SpellLog[amount_of_effects] logs;
/// }
/// ```
#[derive(Debug, Clone, PartialEq, PartialOrd, Default)]
pub struct SMSG_SPELLLOGEXECUTE {
    pub caster: Guid,
    pub spell: u32,
    pub logs: Vec<SpellLog>,
}

impl crate::private::Sealed for SMSG_SPELLLOGEXECUTE {}
impl SMSG_SPELLLOGEXECUTE {
    fn read_inner(mut r: &mut &[u8], body_size: u32) -> Result<Self, crate::errors::ParseErrorKind> {
        if !(9..=65535).contains(&body_size) {
            return Err(crate::errors::ParseErrorKind::InvalidSize);
        }

        // caster: PackedGuid
        let caster = crate::util::read_packed_guid(&mut r)?;

        // spell: Spell
        let spell = crate::util::read_u32_le(&mut r)?;

        // amount_of_effects: u32
        let amount_of_effects = crate::util::read_u32_le(&mut r)?;

        // logs: SpellLog[amount_of_effects]
        let logs = {
            let mut logs = Vec::with_capacity(amount_of_effects as usize);

            let allocation_size = u64::from(amount_of_effects) * 8;
            if allocation_size > crate::errors::MAX_ALLOCATION_SIZE {
                return Err(crate::errors::ParseErrorKind::AllocationTooLargeError(allocation_size));
            }

            for _ in 0..amount_of_effects {
                logs.push(SpellLog::read(&mut r)?);
            }
            logs
        };

        Ok(Self {
            caster,
            spell,
            logs,
        })
    }

}

impl crate::Message for SMSG_SPELLLOGEXECUTE {
    const OPCODE: u32 = 0x024c;

    #[cfg(feature = "print-testcase")]
    fn message_name(&self) -> &'static str {
        "SMSG_SPELLLOGEXECUTE"
    }

    #[cfg(feature = "print-testcase")]
    fn to_test_case_string(&self) -> Option<String> {
        use std::fmt::Write;
        use crate::traits::Message;

        let mut s = String::new();

        writeln!(s, "test SMSG_SPELLLOGEXECUTE {{").unwrap();
        // Members
        writeln!(s, "    caster = {};", self.caster.guid()).unwrap();
        writeln!(s, "    spell = {};", self.spell).unwrap();
        writeln!(s, "    amount_of_effects = {};", self.logs.len()).unwrap();
        writeln!(s, "    logs = [").unwrap();
        for v in self.logs.as_slice() {
            writeln!(s, "        {{").unwrap();
            // Members
            writeln!(s, "            effect = {};", SpellEffect::try_from(v.as_int()).unwrap().as_test_case_value()).unwrap();
            match &v {
                crate::tbc::SpellLog::PowerDrain {
                    amount,
                    multiplier,
                    power,
                    target1,
                } => {
                    writeln!(s, "            target1 = {};", target1.guid()).unwrap();
                    writeln!(s, "            amount = {};", amount).unwrap();
                    writeln!(s, "            power = {};", power.as_test_case_value()).unwrap();
                    writeln!(s, "            multiplier = {};", if multiplier.to_string().contains('.') { multiplier.to_string() } else { format!("{}.0", multiplier) }).unwrap();
                }
                crate::tbc::SpellLog::AddExtraAttacks {
                    extra_attacks,
                    target4,
                } => {
                    writeln!(s, "            target4 = {};", target4.guid()).unwrap();
                    writeln!(s, "            extra_attacks = {};", extra_attacks).unwrap();
                }
                crate::tbc::SpellLog::CreateItem {
                    item,
                } => {
                    writeln!(s, "            item = {};", item).unwrap();
                }
                crate::tbc::SpellLog::Summon {
                    summon_target,
                } => {
                    writeln!(s, "            summon_target = {};", summon_target.guid()).unwrap();
                }
                crate::tbc::SpellLog::OpenLock {
                    lock_target,
                } => {
                    writeln!(s, "            lock_target = {};", lock_target.guid()).unwrap();
                }
                crate::tbc::SpellLog::TransDoor {
                    summon_target,
                } => {
                    writeln!(s, "            summon_target = {};", summon_target.guid()).unwrap();
                }
                crate::tbc::SpellLog::SummonPet {
                    summon_target,
                } => {
                    writeln!(s, "            summon_target = {};", summon_target.guid()).unwrap();
                }
                crate::tbc::SpellLog::OpenLockItem {
                    lock_target,
                } => {
                    writeln!(s, "            lock_target = {};", lock_target.guid()).unwrap();
                }
                crate::tbc::SpellLog::InterruptCast {
                    interrupted_spell,
                    target5,
                } => {
                    writeln!(s, "            target5 = {};", target5.guid()).unwrap();
                    writeln!(s, "            interrupted_spell = {};", interrupted_spell).unwrap();
                }
                crate::tbc::SpellLog::SummonObjectWild {
                    summon_target,
                } => {
                    writeln!(s, "            summon_target = {};", summon_target.guid()).unwrap();
                }
                crate::tbc::SpellLog::CreateHouse {
                    summon_target,
                } => {
                    writeln!(s, "            summon_target = {};", summon_target.guid()).unwrap();
                }
                crate::tbc::SpellLog::Duel {
                    summon_target,
                } => {
                    writeln!(s, "            summon_target = {};", summon_target.guid()).unwrap();
                }
                crate::tbc::SpellLog::FeedPet {
                    pet_feed_guid,
                } => {
                    writeln!(s, "            pet_feed_guid = {};", pet_feed_guid.guid()).unwrap();
                }
                crate::tbc::SpellLog::DismissPet {
                    pet_dismiss_guid,
                } => {
                    writeln!(s, "            pet_dismiss_guid = {};", pet_dismiss_guid.guid()).unwrap();
                }
                crate::tbc::SpellLog::SummonObjectSlot1 {
                    summon_target,
                } => {
                    writeln!(s, "            summon_target = {};", summon_target.guid()).unwrap();
                }
                crate::tbc::SpellLog::SummonObjectSlot2 {
                    summon_target,
                } => {
                    writeln!(s, "            summon_target = {};", summon_target.guid()).unwrap();
                }
                crate::tbc::SpellLog::SummonObjectSlot3 {
                    summon_target,
                } => {
                    writeln!(s, "            summon_target = {};", summon_target.guid()).unwrap();
                }
                crate::tbc::SpellLog::SummonObjectSlot4 {
                    summon_target,
                } => {
                    writeln!(s, "            summon_target = {};", summon_target.guid()).unwrap();
                }
                crate::tbc::SpellLog::DurabilityDamage {
                    item_to_damage,
                    target6,
                    unknown5,
                } => {
                    writeln!(s, "            target6 = {};", target6.guid()).unwrap();
                    writeln!(s, "            item_to_damage = {};", item_to_damage).unwrap();
                    writeln!(s, "            unknown5 = {};", unknown5).unwrap();
                }
                _ => {}
            }


            writeln!(s, "        }},").unwrap();
        }
        writeln!(s, "    ];").unwrap();

        writeln!(s, "}} [").unwrap();

        let [a, b] = (u16::try_from(self.size() + 2).unwrap()).to_be_bytes();
        writeln!(s, "    {a:#04X}, {b:#04X}, /* size */").unwrap();
        let [a, b] = 588_u16.to_le_bytes();
        writeln!(s, "    {a:#04X}, {b:#04X}, /* opcode */").unwrap();
        let mut bytes: Vec<u8> = Vec::new();
        self.write_into_vec(&mut bytes).unwrap();
        let mut bytes = bytes.into_iter();

        crate::util::write_bytes(&mut s, &mut bytes, crate::util::packed_guid_size(&self.caster), "caster", "    ");
        crate::util::write_bytes(&mut s, &mut bytes, 4, "spell", "    ");
        crate::util::write_bytes(&mut s, &mut bytes, 4, "amount_of_effects", "    ");
        if !self.logs.is_empty() {
            writeln!(s, "    /* logs: SpellLog[amount_of_effects] start */").unwrap();
            for (i, v) in self.logs.iter().enumerate() {
                writeln!(s, "    /* logs: SpellLog[amount_of_effects] {i} start */").unwrap();
                crate::util::write_bytes(&mut s, &mut bytes, 4, "effect", "        ");
                crate::util::write_bytes(&mut s, &mut bytes, 4, "amount_of_logs", "        ");
                match &v {
                    crate::tbc::SpellLog::PowerDrain {
                        amount,
                        multiplier,
                        power,
                        target1,
                    } => {
                        crate::util::write_bytes(&mut s, &mut bytes, crate::util::packed_guid_size(&target1), "target1", "        ");
                        crate::util::write_bytes(&mut s, &mut bytes, 4, "amount", "        ");
                        crate::util::write_bytes(&mut s, &mut bytes, 4, "power", "        ");
                        crate::util::write_bytes(&mut s, &mut bytes, 4, "multiplier", "        ");
                    }
                    crate::tbc::SpellLog::AddExtraAttacks {
                        extra_attacks,
                        target4,
                    } => {
                        crate::util::write_bytes(&mut s, &mut bytes, crate::util::packed_guid_size(&target4), "target4", "        ");
                        crate::util::write_bytes(&mut s, &mut bytes, 4, "extra_attacks", "        ");
                    }
                    crate::tbc::SpellLog::CreateItem {
                        item,
                    } => {
                        crate::util::write_bytes(&mut s, &mut bytes, 4, "item", "        ");
                    }
                    crate::tbc::SpellLog::Summon {
                        summon_target,
                    } => {
                        crate::util::write_bytes(&mut s, &mut bytes, crate::util::packed_guid_size(&summon_target), "summon_target", "        ");
                    }
                    crate::tbc::SpellLog::OpenLock {
                        lock_target,
                    } => {
                        crate::util::write_bytes(&mut s, &mut bytes, crate::util::packed_guid_size(&lock_target), "lock_target", "        ");
                    }
                    crate::tbc::SpellLog::TransDoor {
                        summon_target,
                    } => {
                        crate::util::write_bytes(&mut s, &mut bytes, crate::util::packed_guid_size(&summon_target), "summon_target", "        ");
                    }
                    crate::tbc::SpellLog::SummonPet {
                        summon_target,
                    } => {
                        crate::util::write_bytes(&mut s, &mut bytes, crate::util::packed_guid_size(&summon_target), "summon_target", "        ");
                    }
                    crate::tbc::SpellLog::OpenLockItem {
                        lock_target,
                    } => {
                        crate::util::write_bytes(&mut s, &mut bytes, crate::util::packed_guid_size(&lock_target), "lock_target", "        ");
                    }
                    crate::tbc::SpellLog::InterruptCast {
                        interrupted_spell,
                        target5,
                    } => {
                        crate::util::write_bytes(&mut s, &mut bytes, crate::util::packed_guid_size(&target5), "target5", "        ");
                        crate::util::write_bytes(&mut s, &mut bytes, 4, "interrupted_spell", "        ");
                    }
                    crate::tbc::SpellLog::SummonObjectWild {
                        summon_target,
                    } => {
                        crate::util::write_bytes(&mut s, &mut bytes, crate::util::packed_guid_size(&summon_target), "summon_target", "        ");
                    }
                    crate::tbc::SpellLog::CreateHouse {
                        summon_target,
                    } => {
                        crate::util::write_bytes(&mut s, &mut bytes, crate::util::packed_guid_size(&summon_target), "summon_target", "        ");
                    }
                    crate::tbc::SpellLog::Duel {
                        summon_target,
                    } => {
                        crate::util::write_bytes(&mut s, &mut bytes, crate::util::packed_guid_size(&summon_target), "summon_target", "        ");
                    }
                    crate::tbc::SpellLog::FeedPet {
                        pet_feed_guid,
                    } => {
                        crate::util::write_bytes(&mut s, &mut bytes, crate::util::packed_guid_size(&pet_feed_guid), "pet_feed_guid", "        ");
                    }
                    crate::tbc::SpellLog::DismissPet {
                        pet_dismiss_guid,
                    } => {
                        crate::util::write_bytes(&mut s, &mut bytes, crate::util::packed_guid_size(&pet_dismiss_guid), "pet_dismiss_guid", "        ");
                    }
                    crate::tbc::SpellLog::SummonObjectSlot1 {
                        summon_target,
                    } => {
                        crate::util::write_bytes(&mut s, &mut bytes, crate::util::packed_guid_size(&summon_target), "summon_target", "        ");
                    }
                    crate::tbc::SpellLog::SummonObjectSlot2 {
                        summon_target,
                    } => {
                        crate::util::write_bytes(&mut s, &mut bytes, crate::util::packed_guid_size(&summon_target), "summon_target", "        ");
                    }
                    crate::tbc::SpellLog::SummonObjectSlot3 {
                        summon_target,
                    } => {
                        crate::util::write_bytes(&mut s, &mut bytes, crate::util::packed_guid_size(&summon_target), "summon_target", "        ");
                    }
                    crate::tbc::SpellLog::SummonObjectSlot4 {
                        summon_target,
                    } => {
                        crate::util::write_bytes(&mut s, &mut bytes, crate::util::packed_guid_size(&summon_target), "summon_target", "        ");
                    }
                    crate::tbc::SpellLog::DurabilityDamage {
                        item_to_damage,
                        target6,
                        unknown5,
                    } => {
                        crate::util::write_bytes(&mut s, &mut bytes, crate::util::packed_guid_size(&target6), "target6", "        ");
                        crate::util::write_bytes(&mut s, &mut bytes, 4, "item_to_damage", "        ");
                        crate::util::write_bytes(&mut s, &mut bytes, 4, "unknown5", "        ");
                    }
                    _ => {}
                }

                writeln!(s, "    /* logs: SpellLog[amount_of_effects] {i} end */").unwrap();
            }
            writeln!(s, "    /* logs: SpellLog[amount_of_effects] end */").unwrap();
        }


        writeln!(s, "] {{").unwrap();
        writeln!(s, "    versions = \"{}\";", std::env::var("WOWM_TEST_CASE_WORLD_VERSION").unwrap_or("2.4.3".to_string())).unwrap();
        writeln!(s, "}}\n").unwrap();

        Some(s)
    }

    fn size_without_header(&self) -> u32 {
        self.size() as u32
    }

    fn write_into_vec(&self, mut w: impl Write) -> Result<(), std::io::Error> {
        // caster: PackedGuid
        crate::util::write_packed_guid(&self.caster, &mut w)?;

        // spell: Spell
        w.write_all(&self.spell.to_le_bytes())?;

        // amount_of_effects: u32
        w.write_all(&(self.logs.len() as u32).to_le_bytes())?;

        // logs: SpellLog[amount_of_effects]
        for i in self.logs.iter() {
            i.write_into_vec(&mut w)?;
        }

        Ok(())
    }

    fn read_body<S: crate::private::Sealed>(r: &mut &[u8], body_size: u32) -> Result<Self, crate::errors::ParseError> {
        Self::read_inner(r, body_size).map_err(|a| crate::errors::ParseError::new(588, "SMSG_SPELLLOGEXECUTE", body_size, a))
    }

}

#[cfg(feature = "tbc")]
impl crate::tbc::ServerMessage for SMSG_SPELLLOGEXECUTE {}

impl SMSG_SPELLLOGEXECUTE {
    pub(crate) fn size(&self) -> usize {
        crate::util::packed_guid_size(&self.caster) // caster: PackedGuid
        + 4 // spell: Spell
        + 4 // amount_of_effects: u32
        + self.logs.iter().fold(0, |acc, x| acc + x.size()) // logs: SpellLog[amount_of_effects]
    }
}