Skip to content

nut.playerInteract documentated #119

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
TovarischPootis merged 1 commit into from
Jan 3, 2023
Merged

nut.playerInteract documentated #119

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
49 changes: 48 additions & 1 deletion gamemode/core/libs/cl_playerinteract.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
-- @module nut.playerInteract
-- @moduleCommentStart
-- player interaction menu library
-- @moduleCommentEnd

nut.playerInteract = nut.playerInteract or {}
nut.playerInteract.funcs = {}

Expand All @@ -11,10 +16,39 @@ local isInteracting = false
local interfaceScale = 0
local selectedFunction = nil

-- @type function nut.playerInteract.addFunc(name, data)
-- @typeCommentStart
-- adding a player interaction button
-- @typeCommentEnd
-- @realm client
-- @string name Name of interact function
-- @table data Data for interaction button callback
-- @usageStart
-- nut.playerInteract.addFunc("recognize", {
-- nameLocalized = "recognize",
-- callback = function(target)
-- netstream.Start("rgnDirect", target)
-- end,
-- canSee = function(target)
-- return true
-- end
-- })
-- @usageEnd
function nut.playerInteract.addFunc(name, data)
nut.playerInteract.funcs[name] = data
end

-- @type function nut.playerInteract.interact(entity, time)
-- @typeCommentStart
-- reproduce the interaction with the player
-- @typeCommentEnd
-- @realm client
-- @entity entity Entity to interact with
-- @number time The time it takes to open the menu
-- @internal
-- @usageStart
-- nut.playerInteract.interact(entity, nut.config.get("playerInteractSpeed", 1))
-- @usageEnd
function nut.playerInteract.interact(entity, time)
nut.playerInteract.currentEnt = entity

Expand All @@ -23,6 +57,19 @@ function nut.playerInteract.interact(entity, time)
isInteracting = true
end

-- @type function nut.playerInteract.clear()
-- @typeCommentStart
-- remove player interaction menu
-- @typeCommentEnd
-- @realm client
-- @internal
-- @usageStart
-- hook.Add("KeyRelease", "nut.playerInteract", function(client, key)
-- if (key == IN_USE and isInteracting) then
-- nut.playerInteract.clear()
-- end
-- end)
-- @usageEnd
function nut.playerInteract.clear()
isInteracting = false
cachedPitch = 0
Expand Down Expand Up @@ -130,4 +177,4 @@ hook.Add("PlayerBindPress", "nut.playerInteract", function(_, bind)

return true
end
end)
end)