Skip to content

Commit 2a52268

Browse files
committed
Update Documents
1 parent dbf6410 commit 2a52268

3 files changed

Lines changed: 29 additions & 8 deletions

File tree

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,30 @@
11
# Debugging
22

3-
To enable and disable debug mode, click `debug` button in the upper right corner.
3+
Ceres provides powerful debugging capabilities to help you troubleshoot your visual scripts.
44

5-
Then, you can click `Next Frame` to execute the graph node by node.
5+
### Enable Debug Mode
6+
To enable and disable debug mode, click the `debug` button in the upper right corner. Then, you can click `Next Frame` to execute the graph node by node.
67

7-
## Use Breakpoint
8-
9-
You can right click node and `Add Breakpoint`, and click `Next Breakpoint` in toolbar to execute the graph breakpoint by breakpoint.
8+
### Breakpoints
9+
You can right click any node and select `Add Breakpoint`, then click `Next Breakpoint` in the toolbar to execute the graph breakpoint by breakpoint.
1010

1111
![Debug](../resources/Images/flow_debugger.png)
1212

13-
## Use Graph Tracker
13+
### Port Debugging
14+
15+
Ceres editor can display the current value of an input port when the mouse hovers over the port of the node at the current breakpoint.
16+
17+
![Port Debug](../resources/Images/port_debug.png)
18+
19+
### Graph Tracker
20+
`FlowGraphTracker` is a class that can be used to track the execution of the graph for advanced debugging scenarios.
21+
22+
For more details, you can see the sample [FlowGraphDependencyTracker](https://github.com/AkiKurisu/Ceres/blob/main/Runtime/Flow/Models/FlowGraphTracker.cs).
23+
24+
### Hot Reload
25+
26+
Ceres supports hot reloading of `FlowGraphObject`. When you modify a `FlowGraphObject` in playing mode, the changes can be reflected immediately.
1427

15-
`FlowGraphTracker` is a class that can be used to track the execution of the graph.
28+
To enable hot reload, you need toggle the `Hot Reload` option in Flow Editor's toolbar and then try to save your graph in playing mode.
1629

17-
For more details, you can see the sample [FlowGraphDependencyTracker](https://github.com/AkiKurisu/Ceres/blob/main/Runtime/Flow/Models/FlowGraphTracker.cs).
30+
![Hot Reload](../resources/Images/hot_reload.png)
75.9 KB
Loading

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -288,6 +288,14 @@ Ceres editor can display the current value of an input port when the mouse hover
288288
### Graph Tracker
289289
`FlowGraphTracker` is a class that can be used to track the execution of the graph for advanced debugging scenarios.
290290

291+
### Hot Reload
292+
293+
Ceres supports hot reloading of `FlowGraphObject`. When you modify a `FlowGraphObject` in playing mode, the changes can be reflected immediately.
294+
295+
To enable hot reload, you need toggle the `Hot Reload` option in Flow Editor's toolbar and then try to save your graph in playing mode.
296+
297+
![Hot Reload](./Documentation~/resources/Images/hot_reload.png)
298+
291299
## Advanced Features
292300

293301
### Port Implicit Conversion

0 commit comments

Comments
 (0)