From e6dbb1808400562a1ef146b2d7ce225349d13951 Mon Sep 17 00:00:00 2001 From: Rutherther Date: Thu, 27 Jan 2022 23:18:30 +0100 Subject: [PATCH] docs: add documentation for missing fields --- .../Commands/Control/ITakeControlCommand.cs | 4 ++-- .../Commands/Control/TakeControlCommand.cs | 4 ++++ Core/NosSmooth.Core/Commands/Walking/PetWalkCommand.cs | 10 +++++----- .../Commands/Walking/PlayerWalkCommand.cs | 3 +++ Core/NosSmooth.Core/Commands/Walking/WalkCommand.cs | 6 +++--- .../NosSmooth.Packets/Server/Skills/SkiSubPacket.cs | 2 +- 6 files changed, 18 insertions(+), 11 deletions(-) diff --git a/Core/NosSmooth.Core/Commands/Control/ITakeControlCommand.cs b/Core/NosSmooth.Core/Commands/Control/ITakeControlCommand.cs index 5d0e11088b4f110c6c91750a680710eb0b421528..5d2960f95da5ca4bdbdfe028ac5cee4cf72e7f36 100644 --- a/Core/NosSmooth.Core/Commands/Control/ITakeControlCommand.cs +++ b/Core/NosSmooth.Core/Commands/Control/ITakeControlCommand.cs @@ -22,12 +22,12 @@ public interface ITakeControlCommand : ICommand bool WaitForCancellation { get; } /// - /// Whether to allow the user to cancel by taking any walk/focus/unfollow action. + /// Gets whether to allow the user to cancel by taking any walk/focus/unfollow action. /// bool AllowUserCancel { get; } /// - /// Whether the command should be cancelled on map change. + /// Gets whether the command should be cancelled on map change. /// bool CancelOnMapChange { get; } } \ No newline at end of file diff --git a/Core/NosSmooth.Core/Commands/Control/TakeControlCommand.cs b/Core/NosSmooth.Core/Commands/Control/TakeControlCommand.cs index 705b49c99a25cfef6086ee37be90a7d1d63405fd..c15c4fcee3aee568a5236490248404421578f0b6 100644 --- a/Core/NosSmooth.Core/Commands/Control/TakeControlCommand.cs +++ b/Core/NosSmooth.Core/Commands/Control/TakeControlCommand.cs @@ -21,6 +21,10 @@ namespace NosSmooth.Core.Commands.Control; /// The callback to be called when control is granted. /// The callback to be called if the operation was cancelled and the control was revoked. /// The group of the take control. +/// Whether the command may be cancelled by another task within the same group. +/// Whether to wait for finish of the previous task +/// Whether to allow the user to cancel by taking any walk/focus/unfollow action +/// Whether the command should be cancelled on map change. public record TakeControlCommand ( Func> HandleCallback, diff --git a/Core/NosSmooth.Core/Commands/Walking/PetWalkCommand.cs b/Core/NosSmooth.Core/Commands/Walking/PetWalkCommand.cs index 1d6560de236139537882f87b811a5ce4b1fb6a24..667d2355b87cbd3793be17253e8b3552e7322a29 100644 --- a/Core/NosSmooth.Core/Commands/Walking/PetWalkCommand.cs +++ b/Core/NosSmooth.Core/Commands/Walking/PetWalkCommand.cs @@ -12,11 +12,11 @@ namespace NosSmooth.Core.Commands.Walking; /// Walk the given pet to the specified position. /// /// Index of the pet to move. -/// -/// -/// -/// -/// +/// The target x coordinate. +/// The target y coordinate. +/// Whether the command may be cancelled by another task within the same group. +/// Whether to wait for finish of the previous task +/// Whether to allow the user to cancel by taking any walk/focus/unfollow action public record PetWalkCommand ( int PetSelector, diff --git a/Core/NosSmooth.Core/Commands/Walking/PlayerWalkCommand.cs b/Core/NosSmooth.Core/Commands/Walking/PlayerWalkCommand.cs index a8ed710490f6bad65b34ab3b02cecf190794445c..37aa8f44d273b9995d1e9aa543973a1fd6bdd489 100644 --- a/Core/NosSmooth.Core/Commands/Walking/PlayerWalkCommand.cs +++ b/Core/NosSmooth.Core/Commands/Walking/PlayerWalkCommand.cs @@ -14,6 +14,9 @@ namespace NosSmooth.Core.Commands.Walking; /// /// The x coordinate of the target position to move to. /// The y coordinate of the target position to move to. +/// Whether the command may be cancelled by another task within the same group. +/// Whether to wait for finish of the previous task +/// Whether to allow the user to cancel by taking any walk/focus/unfollow action public record PlayerWalkCommand ( ushort TargetX, diff --git a/Core/NosSmooth.Core/Commands/Walking/WalkCommand.cs b/Core/NosSmooth.Core/Commands/Walking/WalkCommand.cs index 5c40d516e7717b911be7b7fa5b1b9e13034a4966..75a207d888bb679dda8d5a374a96bacfb8e2032b 100644 --- a/Core/NosSmooth.Core/Commands/Walking/WalkCommand.cs +++ b/Core/NosSmooth.Core/Commands/Walking/WalkCommand.cs @@ -14,9 +14,9 @@ namespace NosSmooth.Core.Commands.Walking; /// The target x coordinate. /// The target y coordinate. /// The pet indices. -/// -/// -/// +/// Whether the command may be cancelled by another task within the same group. +/// Whether to wait for finish of the previous task +/// Whether to allow the user to cancel by taking any walk/focus/unfollow action public record WalkCommand ( ushort TargetX, diff --git a/Packets/NosSmooth.Packets/Server/Skills/SkiSubPacket.cs b/Packets/NosSmooth.Packets/Server/Skills/SkiSubPacket.cs index 581c6f1e0f6d2d0ce78320a572b96f69b8f2face..9395b54d8a8daa7875abc15f1a68875472395e3d 100644 --- a/Packets/NosSmooth.Packets/Server/Skills/SkiSubPacket.cs +++ b/Packets/NosSmooth.Packets/Server/Skills/SkiSubPacket.cs @@ -11,7 +11,7 @@ namespace NosSmooth.Packets.Server.Skills; /// /// Sub packet for containing information about a skill. /// -/// The vnum of the skill. +/// The vnum of the skill. /// The rank of the skill. [PacketHeader(null, PacketSource.Server)] [GenerateSerializer(true)]