diff options
author | follower <follower@rancidbacon.com> | 2020-05-12 13:28:12 +1200 |
---|---|---|
committer | follower <follower@rancidbacon.com> | 2020-09-29 10:04:46 +0200 |
commit | 2ef89e0b4358ff384a7262c422314cafbff48098 (patch) | |
tree | 51048bcb8ac50b485e026a02872c19431372c16c /doc/classes | |
parent | 2d14c7cb69769421e96e19f3a8b54de87e8660fc (diff) |
Doc clarity/detail for extra spacing properties
Re: Space spacing being in addition to character spacing see:
* <https://github.com/godotengine/godot/blob/d7b85fbaa1fc438effe406c9d7f973749eb4e527/scene/resources/dynamic_font.cpp#L858-L859>
Re: Value being able to be negative see example here:
* <https://github.com/godotengine/godot/issues/38630>
But also note that nodes other than `Label` may not currently render extra space spacing correctly.
Diffstat (limited to 'doc/classes')
-rw-r--r-- | doc/classes/DynamicFont.xml | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/classes/DynamicFont.xml b/doc/classes/DynamicFont.xml index b0635892be..0b9b97f54a 100644 --- a/doc/classes/DynamicFont.xml +++ b/doc/classes/DynamicFont.xml @@ -96,10 +96,12 @@ Extra spacing at the bottom in pixels. </member> <member name="extra_spacing_char" type="int" setter="set_spacing" getter="get_spacing" default="0"> - Extra character spacing in pixels. + Extra spacing for each character in pixels. + This can be a negative number to make the distance between characters smaller. </member> <member name="extra_spacing_space" type="int" setter="set_spacing" getter="get_spacing" default="0"> - Extra space spacing in pixels. + Extra spacing for the space character (in addition to [member extra_spacing_char]) in pixels. + This can be a negative number to make the distance between words smaller. </member> <member name="extra_spacing_top" type="int" setter="set_spacing" getter="get_spacing" default="0"> Extra spacing at the top in pixels. @@ -126,10 +128,10 @@ Spacing at the bottom. </constant> <constant name="SPACING_CHAR" value="2" enum="SpacingType"> - Character spacing. + Spacing for each character. </constant> <constant name="SPACING_SPACE" value="3" enum="SpacingType"> - Space spacing. + Spacing for the space character. </constant> </constants> </class> |