General purpose modules for Roblox development. [Read-only Codeberg mirror]
add docs
Signed-off-by: ClaytonTDM <claytontdm@gmail.com>
+75
-2
+70
Docs/TextTransform.md
+70
Docs/TextTransform.md
···
1
+
# TextTransform
2
+
3
+
Transform text in a way that makes it easy to manipulate individual characters.
4
+
5
+
## Methods
6
+
7
+
### `TransformText`
8
+
9
+
`TransformText(labelToTransform: TextLabel)` → `Frame`
10
+
11
+
Transforms a `TextLabel` into a `Frame` for easy manipulation of letters.
12
+
Letter index is stored in `LayoutOrder` for each `Frame`.
13
+
Stores necessary style information as attributes on the returned `Frame`.
14
+
15
+
#### Parameters
16
+
17
+
| Name | Type | Required |
18
+
| ---------------- | ----------- | -------- |
19
+
| labelToTransform | `TextLabel` | Yes |
20
+
21
+
#### Returns
22
+
23
+
| Type |
24
+
| ------- |
25
+
| `Frame` |
26
+
27
+
---
28
+
29
+
### `CreateFrameFromLabel`
30
+
31
+
`CreateFrameFromLabel(labelTemplate: TextLabel)` → `Frame`
32
+
33
+
Creates a `Frame` from a `TextLabel` for easy manipulation of letters.
34
+
Intended to be used with [`InsertLetter`](#InsertLetter).
35
+
36
+
#### Parameters
37
+
38
+
| Name | Type | Required |
39
+
| ------------- | ----------- | -------- |
40
+
| labelTemplate | `TextLabel` | Yes |
41
+
42
+
#### Returns
43
+
44
+
| Type |
45
+
| ------- |
46
+
| `Frame` |
47
+
48
+
---
49
+
50
+
### `InsertLetter`
51
+
52
+
`InsertLetter(frame: Frame, letter: string, index: number)` → `Frame`
53
+
54
+
Inserts a new letter (`Frame`) into the `listFrame` at the specified index.
55
+
Adjusts `LayoutOrder` of subsequent letters.
56
+
Returns the newly created letter `Frame` or `nil` if attributes are missing.
57
+
58
+
#### Parameters
59
+
60
+
| Name | Type | Required |
61
+
| --------- | -------- | -------- |
62
+
| listFrame | `Frame` | Yes |
63
+
| letter | `string` | Yes |
64
+
| index | `number` | Yes |
65
+
66
+
#### Returns
67
+
68
+
| Type |
69
+
| -------- |
70
+
| `Frame?` |
+1
-2
README.md
+1
-2
README.md
···
4
4
5
5
## Modules
6
6
7
-
- TextTransform
8
-
- Transforms a `TextLabel` into a `Frame` with many children for easy manipulation of letters. Letter index is stored in `LayoutOrder` for each `Frame`.
7
+
- [TextTransform](Docs/TextTransform.md): Transform text in a way that makes it easy to manipulate individual characters.
9
8
10
9
---
11
10