From 6e97f92fc355eea1a07fde3960926012c9d29854 Mon Sep 17 00:00:00 2001 From: Rutherther Date: Sat, 7 Jan 2023 22:09:45 +0100 Subject: [PATCH] docs: add not in range, nullable wrapper docs --- Core/NosSmooth.Game/Errors/NotInRangeError.cs | 7 +++++++ .../NullableWrapper.cs | 5 +++++ .../Client/Battle/UsePartnerSkillPacket.cs | 1 + 3 files changed, 13 insertions(+) diff --git a/Core/NosSmooth.Game/Errors/NotInRangeError.cs b/Core/NosSmooth.Game/Errors/NotInRangeError.cs index 070ddeb..f489bb0 100644 --- a/Core/NosSmooth.Game/Errors/NotInRangeError.cs +++ b/Core/NosSmooth.Game/Errors/NotInRangeError.cs @@ -9,6 +9,13 @@ using Remora.Results; namespace NosSmooth.Game.Errors; +/// +/// The given position is not in range of the entity. +/// +/// The entity. +/// The entity's position. +/// The target position. +/// The maximum range. public record NotInRangeError ( string Entity, diff --git a/Packets/NosSmooth.PacketSerializer.Abstractions/NullableWrapper.cs b/Packets/NosSmooth.PacketSerializer.Abstractions/NullableWrapper.cs index c555b2b..f79bad1 100644 --- a/Packets/NosSmooth.PacketSerializer.Abstractions/NullableWrapper.cs +++ b/Packets/NosSmooth.PacketSerializer.Abstractions/NullableWrapper.cs @@ -29,6 +29,11 @@ public record struct NullableWrapper(T? Value) return wrapper.Value; } + /// + /// Wrap the value in nullable wrapper. + /// + /// The value to wrap. + /// The wrapped value. public static implicit operator NullableWrapper(T? value) { return new NullableWrapper(value); diff --git a/Packets/NosSmooth.Packets/Client/Battle/UsePartnerSkillPacket.cs b/Packets/NosSmooth.Packets/Client/Battle/UsePartnerSkillPacket.cs index d7b5252..8c03623 100644 --- a/Packets/NosSmooth.Packets/Client/Battle/UsePartnerSkillPacket.cs +++ b/Packets/NosSmooth.Packets/Client/Battle/UsePartnerSkillPacket.cs @@ -15,6 +15,7 @@ namespace NosSmooth.Packets.Client.Battle; /// The pet skill id. /// The target entity type. /// The target id. +/// The slot of the skill. /// The x coordinate to target to, present if the skill is area skill. /// The y coordinate to target to, present if the skill is area skill. [PacketHeader("u_ps", PacketSource.Client)] -- 2.49.0