~ruther/NosSmooth

e6dbb1808400562a1ef146b2d7ce225349d13951 — Rutherther 3 years ago 844058d
docs: add documentation for missing fields
M Core/NosSmooth.Core/Commands/Control/ITakeControlCommand.cs => Core/NosSmooth.Core/Commands/Control/ITakeControlCommand.cs +2 -2
@@ 22,12 22,12 @@ public interface ITakeControlCommand : ICommand
    bool WaitForCancellation { get; }

    /// <summary>
    /// 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.
    /// </summary>
    bool AllowUserCancel { get; }

    /// <summary>
    /// Whether the command should be cancelled on map change.
    /// Gets whether the command should be cancelled on map change.
    /// </summary>
    bool CancelOnMapChange { get; }
}
\ No newline at end of file

M Core/NosSmooth.Core/Commands/Control/TakeControlCommand.cs => Core/NosSmooth.Core/Commands/Control/TakeControlCommand.cs +4 -0
@@ 21,6 21,10 @@ namespace NosSmooth.Core.Commands.Control;
/// <param name="HandleCallback">The callback to be called when control is granted.</param>
/// <param name="CancelledCallback">The callback to be called if the operation was cancelled and the control was revoked.</param>
/// <param name="Group">The group of the take control.</param>
/// <param name="CanBeCancelledByAnother">Whether the command may be cancelled by another task within the same group.</param>
/// <param name="WaitForCancellation">Whether to wait for finish of the previous task</param>
/// <param name="AllowUserCancel">Whether to allow the user to cancel by taking any walk/focus/unfollow action</param>
/// <param name="CancelOnMapChange">Whether the command should be cancelled on map change.</param>
public record TakeControlCommand
(
    Func<CancellationToken, Task<Result>> HandleCallback,

M Core/NosSmooth.Core/Commands/Walking/PetWalkCommand.cs => Core/NosSmooth.Core/Commands/Walking/PetWalkCommand.cs +5 -5
@@ 12,11 12,11 @@ namespace NosSmooth.Core.Commands.Walking;
/// Walk the given pet to the specified position.
/// </summary>
/// <param name="PetSelector">Index of the pet to move.</param>
/// <param name="TargetX"></param>
/// <param name="TargetY"></param>
/// <param name="CanBeCancelledByAnother"></param>
/// <param name="WaitForCancellation"></param>
/// <param name="AllowUserCancel"></param>
/// <param name="TargetX">The target x coordinate.</param>
/// <param name="TargetY">The target y coordinate.</param>
/// <param name="CanBeCancelledByAnother">Whether the command may be cancelled by another task within the same group.</param>
/// <param name="WaitForCancellation">Whether to wait for finish of the previous task</param>
/// <param name="AllowUserCancel">Whether to allow the user to cancel by taking any walk/focus/unfollow action</param>
public record PetWalkCommand
(
    int PetSelector,

M Core/NosSmooth.Core/Commands/Walking/PlayerWalkCommand.cs => Core/NosSmooth.Core/Commands/Walking/PlayerWalkCommand.cs +3 -0
@@ 14,6 14,9 @@ namespace NosSmooth.Core.Commands.Walking;
/// </summary>
/// <param name="TargetX">The x coordinate of the target position to move to.</param>
/// <param name="TargetY">The y coordinate of the target position to move to.</param>
/// <param name="CanBeCancelledByAnother">Whether the command may be cancelled by another task within the same group.</param>
/// <param name="WaitForCancellation">Whether to wait for finish of the previous task</param>
/// <param name="AllowUserCancel">Whether to allow the user to cancel by taking any walk/focus/unfollow action</param>
public record PlayerWalkCommand
(
    ushort TargetX,

M Core/NosSmooth.Core/Commands/Walking/WalkCommand.cs => Core/NosSmooth.Core/Commands/Walking/WalkCommand.cs +3 -3
@@ 14,9 14,9 @@ namespace NosSmooth.Core.Commands.Walking;
/// <param name="TargetX">The target x coordinate.</param>
/// <param name="TargetY">The target y coordinate.</param>
/// <param name="PetSelectors">The pet indices.</param>
/// <param name="CanBeCancelledByAnother"></param>
/// <param name="WaitForCancellation"></param>
/// <param name="AllowUserCancel"></param>
/// <param name="CanBeCancelledByAnother">Whether the command may be cancelled by another task within the same group.</param>
/// <param name="WaitForCancellation">Whether to wait for finish of the previous task</param>
/// <param name="AllowUserCancel">Whether to allow the user to cancel by taking any walk/focus/unfollow action</param>
public record WalkCommand
(
    ushort TargetX,

M Packets/NosSmooth.Packets/Server/Skills/SkiSubPacket.cs => Packets/NosSmooth.Packets/Server/Skills/SkiSubPacket.cs +1 -1
@@ 11,7 11,7 @@ namespace NosSmooth.Packets.Server.Skills;
/// <summary>
/// Sub packet for <see cref="SkiPacket"/> containing information about a skill.
/// </summary>
/// <param name="SkillId">The vnum of the skill.</param>
/// <param name="SkillVNum">The vnum of the skill.</param>
/// <param name="Rank">The rank of the skill.</param>
[PacketHeader(null, PacketSource.Server)]
[GenerateSerializer(true)]