Skip to content

Commit a36dab8

Browse files
committed
docs : update shape
1 parent 4e30d75 commit a36dab8

File tree

2 files changed

+17
-1
lines changed

2 files changed

+17
-1
lines changed

lua/docs/content/reference/shape.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,22 @@ properties:
165165
type: "string"
166166
description: |
167167
Original item name of this shape. If it was created programmatically, item name is `nil`.
168+
169+
- name: "DrawMode"
170+
type: "table"
171+
description: |
172+
Enable and configure draw modes using this property. Setting this to `nil` disables all draw modes.
173+
174+
Currently, one draw mode is supported: `{ color=<Color or table of options> }`,
175+
- `color` as a [Color](/reference/color), applied multiplicatively to the whole shape. Alternatively, it can be set to a table of options (see below).
176+
177+
Color options are,
178+
- `multiplicative` as a [Color](/reference/color), applied multiplicatively to the whole shape.
179+
- `additive` as a [Color](/reference/color), applied additively to the whole shape.
180+
181+
The additive and multiplicative colors are a shortcut to modify shape colors as a whole, but it could also be done by adding or multiplying each colors of the shape palette.
182+
183+
All these options can be set at runtime or animated individually.
168184
169185
functions:
170186
- name: "GetBlock"

lua/docs/content/reference/text.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ properties:
177177
178178
Outline options are,
179179
- `weight` as a number between 0.0 and 1.0, disabling the outline at 0.0 to the maximum weight allowed by the font at 1.0.
180-
- `color` as a [Color](/reference/color) object.
180+
- `color` as a [Color](/reference/color).
181181
182182
All these options can be set at runtime or animated individually.
183183

0 commit comments

Comments
 (0)