docs(CommandDelegate): add XML doc comments to CommandBeforeDelegate and CommandAfterDelegate
This commit is contained in:
@@ -2,5 +2,16 @@ using Vintagestory.API.Common;
|
||||
|
||||
namespace CommandHook;
|
||||
|
||||
/// <summary>
|
||||
/// Invoked before a watched command runs. Set <c>data.Cancel = true</c> to stop
|
||||
/// the command from executing.
|
||||
/// </summary>
|
||||
/// <param name="data">The command data, passed by ref so you can read or cancel it.</param>
|
||||
public delegate void CommandBeforeDelegate(ref CommandData data);
|
||||
|
||||
/// <summary>
|
||||
/// Invoked after a watched command has run. Not invoked if a Before listener cancelled it.
|
||||
/// </summary>
|
||||
/// <param name="data">The command data, passed by ref for consistency with <see cref="CommandBeforeDelegate"/>.</param>
|
||||
/// <param name="result">The result the command produced.</param>
|
||||
public delegate void CommandAfterDelegate(ref CommandData data, TextCommandResult result);
|
||||
|
||||
Reference in New Issue
Block a user