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
Merged

Conversation

JayXTQ
Copy link

@JayXTQ JayXTQ commented Nov 22, 2024

Description

Describe the changes
@Mikihero and I were discussing what all 3 of the item events do (Using, Used and UsingComplete) and it was confusing what did what, so Miki did some testing and this PR is to include all items that trigger what event and clearer documentation of what each event does exactly, as it currently looks like Used and UsingComplete are the same thing.


Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentations

Submission checklist

  • I have checked the project can be compiled
  • I have tested my changes and it worked as expected

Patches (if there are any changes related to Harmony patches)

  • I have checked no IL patching errors in the console

Other

  • Still requires more testing

EXILED/Exiled.Events/Handlers/Player.cs Outdated Show resolved Hide resolved
EXILED/Exiled.Events/Handlers/Player.cs Outdated Show resolved Hide resolved
EXILED/Exiled.Events/Handlers/Player.cs Outdated Show resolved Hide resolved
EXILED/Exiled.Events/Handlers/Player.cs Outdated Show resolved Hide resolved
@JayXTQ
Copy link
Author

JayXTQ commented Nov 22, 2024

fyi the CI failed on getting references, so not my fault :3

EXILED/Exiled.Events/Handlers/Player.cs Outdated Show resolved Hide resolved
@JayXTQ
Copy link
Author

JayXTQ commented Nov 22, 2024

@Mikihero done

@JayXTQ JayXTQ requested a review from Mikihero November 22, 2024 11:07
@MikeSus1
Copy link

💀🙏

EXILED/Exiled.Events/Handlers/Player.cs Outdated Show resolved Hide resolved
@JayXTQ JayXTQ requested a review from Mikihero November 22, 2024 11:24
@Misaka-ZeroTwo Misaka-ZeroTwo added documentation Improvements or additions to documentation and removed Events labels Nov 23, 2024
Copy link

@VALERA771 VALERA771 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK if that's true

@JayXTQ
Copy link
Author

JayXTQ commented Nov 24, 2024

@VALERA771 due to nobody else giving any negatives, you can probably merge this

@VALERA771 VALERA771 merged commit 9ab44bd into ExMod-Team:dev Nov 25, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants