You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Documentation/textdumper.md
+8-6Lines changed: 8 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,12 +5,14 @@ file (AssetBundle or SerializedFile) into human-readable yaml-style text file.
5
5
6
6
## How to use
7
7
8
-
The library consists of a single class called [TextDumperTool](../TextDumper/TextDumperTool.cs). It has a method named Dump and takes five parameters:
9
-
* path (string): path of the data file.
10
-
* outputPath (string): path where the output files will be created.
11
-
* skipLargeArrays (bool): if true, the content of arrays larger than 1KB won't be dumped.
12
-
* 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.
13
-
* 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).
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.
0 commit comments