Skip to content

Commit b7a9f48

Browse files
Simplify the doc for textdumper.
Listing all the options to Dump() is rather redundant, the important documentation is command-dump.md and its just a maintenance burden to also list them here.
1 parent 849de7a commit b7a9f48

1 file changed

Lines changed: 3 additions & 8 deletions

File tree

Documentation/textdumper.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,9 @@ file (AssetBundle or SerializedFile) into human-readable yaml-style text file.
55

66
## How to use
77

8-
The library consists of a single class called [TextDumperTool](../TextDumper/TextDumperTool.cs). Call its `Dump` method, passing a `TextDumperTool.DumpOptions` object with the following properties:
9-
* `Format` (DumpFormat, optional): output format. Defaults to `Text`.
10-
* `Path` (string): path of the data file.
11-
* `OutputPath` (string): path where the output files will be created. Ignored when `ToStdout` is true.
12-
* `SkipLargeArrays` (bool): if true, the content of arrays larger than 1KB won't be dumped.
13-
* `ObjectId` (long, optional): if specified and not 0, only the object with this signed 64-bit id will be dumped. If 0 (default), all objects are dumped.
14-
* `TypeFilter` (string, optional): if specified, only objects matching this type are dumped. Accepts a numeric ClassID (e.g. 114) or a type name (e.g. MonoBehaviour, case-insensitive).
15-
* `ToStdout` (bool, optional): if true, the dump is written to standard output instead of a file. Refused for archives that contain more than one SerializedFile.
8+
The library consists of a single class called [TextDumperTool](../TextDumper/TextDumperTool.cs). Call its `Dump` method, passing a `TextDumperTool.DumpOptions` object that specify the path of the file to dump and various flags and options.
9+
10+
The library is used to implement the [`UnityDataTool dump` command](command-dump.md).
1611

1712
## How to interpret the output files
1813

0 commit comments

Comments
 (0)