Skip to content

docs: clearer documentation on item events #191

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.

Sign up for GitHub

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

Merged
VALERA771 merged 10 commits into from
Nov 25, 2024
Merged

docs: clearer documentation on item events #191

Changes from 6 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
2c0cbfe
docs: clearer documentation on item events
Nov 22, 2024
fc3a0c5
docs: grammatical mistake
Nov 22, 2024
ec30a0e
docs: more clarification
Nov 22, 2024
6cb93aa
docs: usable cref > item
Nov 22, 2024
cb297a9
docs: clarification on UsingItem
Nov 22, 2024
bd15798
docs: add remark to say that user may be in cooldown
Nov 22, 2024
ba80f7f
docs: item > user
Nov 22, 2024
754bdf6
docs: remove useless remarks
Nov 22, 2024
8383e9d
docs: edit remark to say only the important parts
Nov 22, 2024
bc73be4
docs: UsingItem doesn't invoke on Items.Item
Nov 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions EXILED/Exiled.Events/Handlers/Player.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,13 +70,20 @@ 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.
Comment thread
LumiFae marked this conversation as resolved.
Outdated
/// </summary>
/// <remarks>
/// Will be invoked even if the user is on cooldown.
Comment thread
LumiFae marked this conversation as resolved.
Outdated
/// 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.
Comment thread
LumiFae marked this conversation as resolved.
Outdated
/// </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>
/// <remarks>
/// Items that will invoke this event: SCP-1853, SCP-207, Anti-Cola, all medical, SCP-244, SCP-1576, SCP-268 and all candies.
Comment thread
LumiFae marked this conversation as resolved.
Outdated
/// </remarks>
public static Event<UsingItemCompletedEventArgs> UsingItemCompleted { get; set; } = new ();

/// <summary>
Expand All @@ -85,6 +92,7 @@ public class Player
/// <remarks>
/// Invoked after <see cref="UsingItem"/>, if a player's class has
/// changed during their health increase, won't fire.
/// Items that will invoke this event: SCP-1853, SCP-207, Anti-Cola, all medical, SCP-244, SCP-1576, SCP-268 and all candies.
Comment thread
LumiFae marked this conversation as resolved.
Outdated
/// </remarks>
public static Event<UsedItemEventArgs> UsedItem { get; set; } = new();

Expand Down