liangsheng8708
/
ruffle
mirror of https://mirror.ghproxy.com/https://github.com/ruffle-rs/ruffle.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: note how to print trace statements

This commit is contained in:
Chris Midgley 2021-05-01 19:47:05 +01:00 committed by Mike Welsh
parent d8b144e972
commit 0f1dbb9f2a
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
CONTRIBUTING.md
View File

@ -52,13 +52,16 @@ Ruffle is a young project, and there is still much Flash functionality that is u
## Debugging ActionScript Content
If you build Ruffle with `--features avm_debug` and enable debug logging (`RUST_LOG="warn,ruffle_core=debug"`) then you will
If you build Ruffle with `--features avm_debug` and enable debug logging (`RUST_LOG="warn,ruffle_core=debug,avm_trace=trace"`) then you will
activate a few built-in debugging utilities inside Ruffle, listed below.
### Warnings and Errors
All AVM errors and warnings will print their stack trace so that you can view where they are in relation to the
ActionScript inside the movie. This requires no extra configuration and will be visible by default.
### Trace statements
With `avm_trace=trace`, `trace()` statements will print to stderr.
### Step-By-Step Output
If you use the hotkey `CTRL + ALT + D` you will toggle verbose AVM debugging output on and off (default off).
You will be able to follow the flow of ActionScript inside of a SWF movie, as each action is performed.