Skip to content

Commit 5d8cb7d

Browse files
committed
UPD docs
1 parent 96bef0d commit 5d8cb7d

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

docs/JSON_DOC.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,13 @@ Value | Type | Description
4141
`flags`<br/><sup class="internal">*Only used by editor*</sup><br/> ![Generic badge](https://img.shields.io/badge/Added_0.8.0-gray.svg) | Array&nbsp;of&nbsp;Enum | An array containing various advanced flags (ie. options or other states).<br/> Possible values: `DiscardPreCsvIntGrid`, `ExportOldTableOfContentData`, `ExportPreCsvIntGridFormat`, `IgnoreBackupSuggest`, `PrependIndexToLevelFileNames`, `MultiWorlds`, `UseMultilinesType`
4242
`identifierStyle`<br/><sup class="internal">*Only used by editor*</sup><br/> ![Generic badge](https://img.shields.io/badge/Added_1.0.0-gray.svg) | Enum | Naming convention for Identifiers (first-letter uppercase, full uppercase etc.)<br/> Possible values: `Capitalize`, `Uppercase`, `Lowercase`, `Free`
4343
`imageExportMode`<br/><sup class="internal">*Only used by editor*</sup><br/> ![Generic badge](https://img.shields.io/badge/Added_0.9.3-gray.svg) | Enum | "Image export" option when saving project.<br/> Possible values: `None`, `OneImagePerLayer`, `OneImagePerLevel`, `LayersAndLevels`
44+
`jsonStyle`<br/><sup class="internal">*Only used by editor*</sup> | Enum | JSON style<br/> Possible values: `Minified`, `Compact`, `Full`
4445
`levelNamePattern`<br/><sup class="internal">*Only used by editor*</sup><br/> ![Generic badge](https://img.shields.io/badge/Added_0.9.0-gray.svg) | String | The default naming convention for level identifiers.
45-
`minifyJson`<br/><sup class="internal">*Only used by editor*</sup> | Bool | If TRUE, the Json is partially minified (no indentation, nor line breaks, default is FALSE)
4646
`nextUid`<br/><sup class="internal">*Only used by editor*</sup> | Int | Next Unique integer ID available
4747
`pngFilePattern`<br/><sup class="internal">*Only used by editor*</sup><br/> ![Generic badge](https://img.shields.io/badge/Added_0.7.2-gray.svg) | String&nbsp;*(can&nbsp;be&nbsp;`null`)* | File naming pattern for exported PNGs
4848
`simplifiedExport`<br/><sup class="internal">*Only used by editor*</sup><br/> ![Generic badge](https://img.shields.io/badge/Added_1.1.0-gray.svg) | Bool | If TRUE, a very simplified will be generated on saving, for quicker & easier engine integration.
4949
`tutorialDesc`<br/><sup class="internal">*Only used by editor*</sup><br/> ![Generic badge](https://img.shields.io/badge/Added_1.0.0-gray.svg) | String&nbsp;*(can&nbsp;be&nbsp;`null`)* | This optional description is used by LDtk Samples to show up some informations and instructions.
50+
~~`minifyJson`~~<br/><sup class="internal">*Only used by editor*</sup><br/><sup class="deprecated">*DEPRECATED!*</sup><br/> | Bool | **WARNING**: this deprecated value will be *removed* completely on version 1.7.0+<br/> <br/> Replaced by: `jsonStyle`
5051
~~`exportPng`~~<br/><sup class="internal">*Only used by editor*</sup><br/><sup class="deprecated">*DEPRECATED!*</sup><br/> ![Generic badge](https://img.shields.io/badge/Removed_0.9.3-gray.svg) | Bool&nbsp;*(can&nbsp;be&nbsp;`null`)* | **WARNING**: this deprecated value is no longer exported since version 0.9.3<br/> <br/> Replaced by: `imageExportMode`
5152

5253
<a id="ldtk-WorldJson" name="ldtk-WorldJson"></a>

docs/JSON_SCHEMA.json

+10-2
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@
3232
"flags",
3333
"identifierStyle",
3434
"imageExportMode",
35+
"jsonStyle",
3536
"levelNamePattern",
36-
"minifyJson",
3737
"nextUid",
3838
"simplifiedExport"
3939
],
@@ -328,6 +328,14 @@
328328
"array"
329329
]
330330
},
331+
"jsonStyle": {
332+
"description": "JSON style Possible values: `Minified`, `Compact`, `Full`",
333+
"enum": [
334+
"Minified",
335+
"Compact",
336+
"Full"
337+
]
338+
},
331339
"jsonVersion": {
332340
"description": "File format version",
333341
"type": [
@@ -373,7 +381,7 @@
373381
]
374382
},
375383
"minifyJson": {
376-
"description": "If TRUE, the Json is partially minified (no indentation, nor line breaks, default is FALSE)",
384+
"description": "**WARNING**: this deprecated value will be *removed* completely on version 1.7.0+ Replaced by: `jsonStyle`",
377385
"type": [
378386
"boolean"
379387
]

0 commit comments

Comments
 (0)