Merge pull request #6493 from dotCooCoo/fix/pattern-options-null-docs

Docs: pattern.options keeps a pattern's current values for omitted params
This commit is contained in:
BFlat
2026-11-11 10:09:23 +07:00
committed by GitHub
+10 -2
View File
@@ -3109,8 +3109,16 @@ The pattern commands (`object.pattern.make`, `object.pattern.edit`, `object.patt
`object.repeat.options`) reject a param of the wrong type, such as `"instances": "8"`, `"edit": "false"` or
`"tileType": 2`, and change nothing. `pattern.options` also rejects an `overlap` that is not an object, and an
`overlap.h` other than `left` or `right` or an `overlap.v` other than `top` or `bottom`. `object.repeat.options` rejects
a `center` that is not `[x, y]`, and `object.repeat.radial` rejects a negative `radius`. Omitting a param or giving null
keeps its default.
a `center` that is not `[x, y]`, and `object.repeat.radial` rejects a negative `radius`. In `object.pattern.make`,
`object.pattern.saveCopy`, `object.repeat.radial`, `object.repeat.grid` and `object.repeat.mirror`, omitting a param or
giving null keeps its default. In `pattern.options` and `object.repeat.options`, omitting a param or giving null keeps
the pattern's or the repeat's current value, with two exceptions. A brick `tileType` in `pattern.options` or a brick
`gridType` in `object.repeat.options` with `brickOffset` omitted or null sets the offset to 0.5. While `sizeTileToArt`
is on, each `pattern.options` call sizes the tile to the art plus `hSpacing` and `vSpacing` again and ignores `width`
and `height`, so a new `hSpacing` changes the tile's width. `pattern.options` still rejects a non-null `width` or
`height` that is not a positive number, such as `"width": 0`, and changes nothing. Without a `name`,
`object.pattern.edit` edits the pattern that fills or strokes a selected object, and `pattern.options` changes the
pattern being edited; each returns an error when there is no such pattern. `pattern.delete` requires `name`.
```json
{"name":"run_command","arguments":{"command":"pattern.options","params":{"showSwatchBounds":true}}}