/
GetTextBoundsParams.yaml
95 lines (94 loc) · 2.4 KB
/
GetTextBoundsParams.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
name: GetTextBoundsParams
type: class
category:
memory_category: Instances
summary: |
Use with `Class.TextService:GetTextBoundsAsync()` to measure the size of text.
description: |
Pass this instance to `Class.TextService:GetTextBoundsAsync()` to measure the
size of text.
code_samples:
- TextService-GetTextBoundsAsync-1
inherits:
- Instance
tags:
- NotReplicated
deprecation_message: ''
properties:
- name: GetTextBoundsParams.Font
summary: |
The `Datatype.Font` of the text being measured.
description: |
The `Datatype.Font` of the text being measured. Corresponds to the
`Class.TextLabel.FontFace` property on text objects.
Not to be confused with `Enum.Font`. This is an object that you can create
using `Datatype.Font.new()`.
code_samples: []
type: Font
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Data
serialization:
can_load: true
can_save: true
- name: GetTextBoundsParams.Size
summary: |
The size of the text being measured.
description: |
The size of the text that is being measured. Corresponds to the
`Class.TextLabel.TextSize` property.
code_samples: []
type: float
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Data
serialization:
can_load: true
can_save: true
- name: GetTextBoundsParams.Text
summary: |
The text being measured.
description: |
The text being measured.
code_samples: []
type: string
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Data
serialization:
can_load: true
can_save: true
- name: GetTextBoundsParams.Width
summary: |
The width of the container for line breaking.
description: |
The width of the container for line breaking. By default, the value is 0,
which means no line breaking will be performed. You can set it to the
width of the container that you'll be putting the text into.
code_samples: []
type: float
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Data
serialization:
can_load: true
can_save: true
methods: []
events: []
callbacks: []