Skip to content

Add example usage function for pcall() #1114

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
merged 5 commits into from
Jun 2, 2025
Merged

Add example usage function for pcall() #1114

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1f26389
Update LuaGlobals.yaml
sammygrey May 25, 2025
d270c5e
Update LuaGlobals.yaml
sammygrey May 25, 2025
7acdbb7
Update LuaGlobals.yaml
sammygrey May 27, 2025
e4bd25b
Update content/en-us/reference/engine/globals/LuaGlobals.yaml
IgnisRBX Jun 2, 2025
517ae5d
Merge branch 'main' into patch-19
IgnisRBX Jun 2, 2025
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
14 changes: 14 additions & 0 deletions content/en-us/reference/engine/globals/LuaGlobals.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,6 +346,20 @@ functions:
errors. In such case, `pcall()` also returns all results from the call,
after this first result. In case of any error, `pcall()` returns false
plus the error message.
```lua
local function divideByFive(n: number): number
return n / 5
end
local success, errorMessage = pcall(divideByFive, "notANumber") -- Results in error...
if success then
-- Handle successful response...
else
warn("Error message:", errorMessage)
end
```
parameters:
- name: func
type: function
Expand Down