Skip to content

Commit

Permalink
Adds profile cheat sheet
Browse files Browse the repository at this point in the history
  • Loading branch information
F0lak authored Oct 30, 2024
1 parent 77d248e commit 129a28b
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion ref/world/proc/Profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,16 @@
+ type: A type of profile to use, other than proc profiling.
+ format: Optional format for output data

### Cheat Sheet:
The Profile gives information for the following data:
```json
"name": proc path
"self": how long the proc takes to run, not including subordinate calls
"total": total time the proc takes to run, including subordinate calls
"real": real time the proc takes (start time - end time)
"over": how far over a tick the total usage runs
"calls": how many times the proc was called during profile
```

Interacts with the built-in server profiler without requiring
the host to do so via Dream Daemon, or an authorized player via Dream
Expand Down Expand Up @@ -60,4 +70,4 @@ profiling this only has three data columns: `"name"`, `"value"`, and
on what\'s being measured.

The JSON format will include a
`unit` property data that is not a raw number, such as a time value.
`unit` property data that is not a raw number, such as a time value.

0 comments on commit 129a28b

Please sign in to comment.