From a889b8ce795fb1f81e72e533efb9c275c9331635 Mon Sep 17 00:00:00 2001
From: Rutherther <fandabohacek@gmail.com>
Date: Thu, 3 Feb 2022 18:55:16 +0100
Subject: [PATCH] docs(packets): add missing documentation

---
 .../Server/Battle/BsPacket.cs                 | 25 ++++++++++---------
 .../Server/Battle/SuPacket.cs                 |  1 +
 .../Server/Maps/InEquipmentSubPacket.cs       |  2 +-
 .../Server/Portals/GpPacket.cs                |  9 +++++++
 4 files changed, 24 insertions(+), 13 deletions(-)

diff --git a/Packets/NosSmooth.Packets/Server/Battle/BsPacket.cs b/Packets/NosSmooth.Packets/Server/Battle/BsPacket.cs
index b550e34..ea6114d 100644
--- a/Packets/NosSmooth.Packets/Server/Battle/BsPacket.cs
+++ b/Packets/NosSmooth.Packets/Server/Battle/BsPacket.cs
@@ -14,18 +14,19 @@ namespace NosSmooth.Packets.Server.Battle;
 /// </summary>
 /// <param name="CasterEntityType">The caster entity type.</param>
 /// <param name="CasterEntityId">The caster entity id.</param>
-/// <param name="X">The x coordinate of the skill.</param>
-/// <param name="Y"></param>
-/// <param name="Cooldown"></param>
-/// <param name="AttackAnimationId"></param>
-/// <param name="EffectId"></param>
-/// <param name="Unknown1"></param>
-/// <param name="Unknown2"></param>
-/// <param name="Unknown3"></param>
-/// <param name="Unknown4"></param>
-/// <param name="Unknown5"></param>
-/// <param name="Unknown6"></param>
-/// <param name="Unknown7"></param>
+/// <param name="X">The x coordinate where to use the skill.</param>
+/// <param name="Y">The y coordinate where to use the skill.</param>
+/// <param name="SkillVNum">The vnum of the AoE skill used.</param>
+/// <param name="Cooldown">The cooldown of the skill. (seconds time 10)</param>
+/// <param name="AttackAnimationId">The attack animation id.</param>
+/// <param name="EffectId">The effect id.</param>
+/// <param name="Unknown1">Unknown TODO.</param>
+/// <param name="Unknown2">Unknown TODO.</param>
+/// <param name="Unknown3">Unknown TODO.</param>
+/// <param name="Unknown4">Unknown TODO.</param>
+/// <param name="Unknown5">Unknown TODO.</param>
+/// <param name="Unknown6">Unknown TODO.</param>
+/// <param name="Unknown7">Unknown TODO.</param>
 [PacketHeader("bs", PacketSource.Server)]
 [GenerateSerializer(true)]
 public record BsPacket
diff --git a/Packets/NosSmooth.Packets/Server/Battle/SuPacket.cs b/Packets/NosSmooth.Packets/Server/Battle/SuPacket.cs
index 6cad3c7..37e825c 100644
--- a/Packets/NosSmooth.Packets/Server/Battle/SuPacket.cs
+++ b/Packets/NosSmooth.Packets/Server/Battle/SuPacket.cs
@@ -24,6 +24,7 @@ namespace NosSmooth.Packets.Server.Battle;
 /// <param name="PositionX">The x position where the skill target is.</param>
 /// <param name="PositionY">The y position where the skill target is.</param>
 /// <param name="TargetIsAlive">Whether the target of the skill is alive.</param>
+/// <param name="HpPercentage">The hp percentage of the entity after the attack.</param>
 /// <param name="Damage">The damage the entity has taken.</param>
 /// <param name="HitMode">The hit mode.</param>
 /// <param name="SkillTypeMinusOne">The skill type of the skill.</param>
diff --git a/Packets/NosSmooth.Packets/Server/Maps/InEquipmentSubPacket.cs b/Packets/NosSmooth.Packets/Server/Maps/InEquipmentSubPacket.cs
index 73f28e9..40f6608 100644
--- a/Packets/NosSmooth.Packets/Server/Maps/InEquipmentSubPacket.cs
+++ b/Packets/NosSmooth.Packets/Server/Maps/InEquipmentSubPacket.cs
@@ -18,7 +18,7 @@ namespace NosSmooth.Packets.Server.Maps;
 /// <param name="MainWeaponVNum">The VNum of the main weapon.</param>
 /// <param name="SecondaryWeaponVNum">The VNum of the secondary weapon.</param>
 /// <param name="MaskVNum">The VNum of the mask.</param>
-/// <param name="Fairy">Unknown TODO.</param>
+/// <param name="FairyVNum">The VNum of the fairy item.</param>
 /// <param name="CostumeSuitVNum">The VNum of the costume suit.</param>
 /// <param name="CostumeHatVNum">The VNum of the costume hat.</param>
 /// <param name="WeaponSkin">The skin of the weapon.</param>
diff --git a/Packets/NosSmooth.Packets/Server/Portals/GpPacket.cs b/Packets/NosSmooth.Packets/Server/Portals/GpPacket.cs
index 2dbba53..dbaf4fc 100644
--- a/Packets/NosSmooth.Packets/Server/Portals/GpPacket.cs
+++ b/Packets/NosSmooth.Packets/Server/Portals/GpPacket.cs
@@ -9,6 +9,15 @@ using NosSmooth.PacketSerializer.Abstractions.Attributes;
 
 namespace NosSmooth.Packets.Server.Portals;
 
+/// <summary>
+/// Packet sent when joining a map with one portal that is on the map.
+/// </summary>
+/// <param name="X">The x coordinate of the portal.</param>
+/// <param name="Y">The y coordinate of the portal.</param>
+/// <param name="TargetMapId">The map the portal leads to.</param>
+/// <param name="PortalType">The type of the portal.</param>
+/// <param name="PortalId">The id of the portal entity.</param>
+/// <param name="IsDisabled">Whether the portal is disabled/locked.</param>
 [PacketHeader("gp", PacketSource.Server)]
 [GenerateSerializer(true)]
 public record GpPacket
-- 
2.49.0