Skip to content

Commit 7f51098

Browse files
committed
Breakpoints Tab documentation with image updates
1 parent c65aa50 commit 7f51098

File tree

6 files changed

+25
-0
lines changed

6 files changed

+25
-0
lines changed

docs/en/manuals/debugging-game-logic.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,11 @@ Setting and clearing breakpoints
8787

8888
To set or clear a breakpoint, click in the column just right of the line numbers in the code editor. You can also select <kbd>Edit ▸ Toggle Breakpoint</kbd> from the menu.
8989

90+
Disabling and enabling breakpoints
91+
: Breakpoints can be temporarily disabled without removing them. When disabled, they are ignored during execution but can be re-enabled at any time. Right-click it in the code editor gutter, then toggle the Enabled checkbox. Disabled breakpoints appear hollowed out to indicate they are inactive.
92+
93+
![disable breakpoint](images/debugging/disable_breakpoint.png)
94+
9095
Setting conditional breakpoints
9196
: You can configure your breakpoint to contain a condition that needs to evaluate to true for the breakpoint to trigger. The condition can access local variables available at the line during code execution.
9297

@@ -104,6 +109,26 @@ Evaluating Lua expressions
104109
Detaching the debugger
105110
: Select <kbd>Debug ▸ Detach Debugger</kbd> to detach the debugger from the game. It will continue running immediately.
106111

112+
## Breakpoints Tab
113+
114+
![breakpoints tab](images/debugging/breakpoints_tab.png)
115+
116+
When working with multiple breakpoints across different scripts, the Breakpoints tab provides a centralized view for managing all your breakpoints in one place.
117+
118+
##### Individual Breakpoint Controls
119+
120+
For working with individual breakpoints:
121+
- Click the red trash icon to remove a breakpoint
122+
- Double-click the row (outside the condition area) to navigate to that line in the Code View
123+
- Double-click the condition cell or click the pen icon to edit conditional breakpoints
124+
- Click the X clear button when hovering over a condition cell to clear the condition
125+
126+
##### Batch Operations
127+
128+
Select multiple breakpoints using Ctrl/Cmd+click or Shift+click, then right-click to perform bulk actions. You can edit conditions across several breakpoints simultaneously, toggle their active state, or remove them entirely.
129+
130+
The toolbar buttons allow you to enable, disable, or toggle all breakpoints at once, useful when you want to run your game without stopping but don't want to lose their positions. You can also remove all when you're done with your debugging session.
131+
107132
## Lua debug library
108133

109134
Lua comes with a debug library that is useful in some situations, particularly if you need to inspect the innards of your Lua environment. You can find more information about it in [the chapter about the Debug Library in the Lua manual](http://www.lua.org/pil/contents.html#23).
99.7 KB
Loading
42.8 KB
Loading
51.8 KB
Loading
5.08 KB
Loading
2.94 KB
Loading

0 commit comments

Comments
 (0)