-
Notifications
You must be signed in to change notification settings - Fork 177
Add missing documentation for all the shared hooks (and some other) + Fix some inaccuracies #482
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
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 Do not change or delete existing hook names; it can break a lot of code.
Will see what Alex will say because having two different hook names with completely same meaning is bad. |
Imagine developer writing plugin for Helix with use of area hooks and then updating his framework after your commit. What will be his reaction? |
Exactly. @Winkarst-cpu |
--- @realm client | ||
function OnAreaChanged(oldID, newID) | ||
end |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
--- @realm client | |
function OnAreaChanged(oldID, newID) | |
end | |
--- @realm client | |
--- @deprecated | |
function OnAreaChanged(oldID, newID) | |
end |
function PLUGIN:OnAreaChanged(oldID, newID) | ||
local client = LocalPlayer() | ||
function PLUGIN:OnPlayerAreaChanged(client, oldID, newID) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
function PLUGIN:OnAreaChanged(oldID, newID) | |
local client = LocalPlayer() | |
function PLUGIN:OnPlayerAreaChanged(client, oldID, newID) | |
function PLUGIN:OnAreaChanged(oldID, newID) | |
local client = LocalPlayer() | |
ErrorNoHaltWithStack("OnAreaChanged(oldID, newID) is deprecated, use OnPlayerAreaChanged(client, oldID, newID) instead") | |
PLUGIN:OnPlayerAreaChanged(client, oldID, newID) | |
end | |
function PLUGIN:OnPlayerAreaChanged(client, oldID, newID) |
No description provided.