General purpose modules for Roblox development. [Read-only Codeberg mirror]
1# TextTransform
2
3Transform 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
11Transforms a `TextLabel` into a `Frame` for easy manipulation of letters.
12Letter index is stored in `LayoutOrder` for each `Frame`.
13Stores 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
33Creates a `Frame` from a `TextLabel` for easy manipulation of letters.
34Intended 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
54Inserts a new letter (`Frame`) into the `listFrame` at the specified index.
55Adjusts `LayoutOrder` of subsequent letters.
56Returns 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?` |