anth64/CommandHook
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(CommandDelegate): add XML doc comments to CommandBeforeDelegate and CommandAfterDelegate

Browse Source
This commit is contained in:
anth64
2026-06-21 12:18:19 +02:00
parent 47f123ba9a
commit beedb8db5b
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CommandHook/CommandDelegate.cs
+11
View File
@@ -2,5 +2,16 @@ using Vintagestory.API.Common;
namespace CommandHook; 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); 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); public delegate void CommandAfterDelegate(ref CommandData data, TextCommandResult result);