Skip to content

Commit 97f1c08

Browse files
committed
Add warning to TextDocument.tsume
1 parent eba00c5 commit 97f1c08

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/other/textdocument.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -723,11 +723,13 @@ TextDocument.tsume
723723

724724
**Description**
725725

726-
This text layer's tsume value.
726+
This text layer's tsume value as a normalized percentage, from 0.0 -> 1.0.
727727

728728
.. warning::
729729
This value only reflects the first character in the text layer at the current time.
730730

731+
This property accepts values from 0.0 -> 100.0, however the value IS expecting a normalized value from 0.0 -> 1.0. Using a value higher than 1.0 will produce unexpected results; AE's Character Panel will clamp the value at 100%, despite the higher value set by scripting (ie ``TextDocument.tsume = 100`` _really_ sets a value of 10,000%)
732+
731733
**Type**
732734

733735
Floating-point value; read-only.

0 commit comments

Comments
 (0)