Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: clearer documentation on item events #191

Merged
merged 10 commits into from
Nov 25, 2024
8 changes: 6 additions & 2 deletions EXILED/Exiled.Events/Handlers/Player.cs
Original file line number Diff line number Diff line change
Expand Up @@ -70,12 +70,16 @@ public class Player
public static Event<EarningAchievementEventArgs> EarningAchievement { get; set; } = new();

/// <summary>
/// Invoked before using an <see cref="API.Features.Items.Item"/>.
/// Invoked before the player starts to use an <see cref="API.Features.Items.Item"/>. In other words, it is invoked just before the animation starts.
JayXTQ marked this conversation as resolved.
Show resolved Hide resolved
/// </summary>
/// <remarks>
/// Will be invoked even if the <see cref="API.Features.Items.Item"/> is on cooldown.
/// Items that will invoke this event: SCP-1853, SCP-207, Anti-Cola, all medical, SCP-244, SCP-1576 and SCP-268. Candies are not included.
JayXTQ marked this conversation as resolved.
Show resolved Hide resolved
/// </remarks>
public static Event<UsingItemEventArgs> UsingItem { get; set; } = new();

/// <summary>
/// Invoked after a <see cref="API.Features.Player"/> uses an <see cref="API.Features.Items.Usable"/>.
/// Invoked before a <see cref="API.Features.Player"/> finishes using a <see cref="API.Features.Items.Usable"/>. In other words, it is invoked after the animation finishes but before the <see cref="API.Features.Items.Usable"/> is actually used.
/// </summary>
public static Event<UsingItemCompletedEventArgs> UsingItemCompleted { get; set; } = new ();

Expand Down