Skip to content

Commit 57ceaf0

Browse files
committed
Fixed README
1 parent 2e854e2 commit 57ceaf0

File tree

2 files changed

+38
-40
lines changed

2 files changed

+38
-40
lines changed

README.md

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,38 @@
1-
# Unity_TextLimiter
2-
1+
# Unity Text Limiter
2+
3+
## Описание
4+
Репозиторий [`Unity_TextLimiter`](https://github.com/RimuruDev/Unity_TextLimiter) содержит скрипты для ограничения количества символов в текстовых компонентах Unity. Эти скрипты предназначены для использования с двумя разными типами текстовых компонентов: стандартным компонентом `Text` из Unity UI и компонентом `TMP_Text` от TextMesh Pro.
5+
6+
## Скрипты
7+
8+
### LegacyTextLimiter
9+
- **Назначение**: Ограничивает количество символов в компоненте `Text` (Unity UI).
10+
- **Ключевые особенности**:
11+
- `maxLength`: Максимальное количество символов, которое может быть отображено.
12+
- `editorMode`: Позволяет тестировать ограничение символов прямо в редакторе Unity.
13+
14+
### TMPTextLimiter
15+
- **Назначение**: Ограничивает количество символов в компоненте `TMP_Text` (TextMesh Pro).
16+
- **Ключевые особенности**:
17+
- `maxLength`: Максимальное количество символов, которое может быть отображено.
18+
- `editorMode`: Позволяет тестировать ограничение символов прямо в редакторе Unity.
19+
20+
## Как использовать
21+
1. **Выбор нужного скрипта**: В зависимости от того, какой текстовый компонент вы используете (`Text` или `TMP_Text`), выберите соответствующий скрипт (`LegacyTextLimiter` или `TMPTextLimiter`).
22+
23+
2. **Добавление скрипта к объекту**: Перетащите выбранный скрипт на GameObject, который содержит текстовый компонент, к которому вы хотите применить ограничение символов.
24+
25+
3. **Настройка параметров**: В инспекторе Unity настройте параметры скрипта, такие как `maxLength` для задания максимального количества символов и `editorMode` для включения тестирования в редакторе.
26+
27+
4. **Тестирование**: Если `editorMode` включен, вы можете начать ввод текста прямо в редакторе Unity, чтобы увидеть, как работает ограничение символов. В режиме игры скрипт будет автоматически применять ограничение к вводимому тексту.
28+
29+
## Начало работы
30+
Для начала работы с этими скриптами, склонируйте репозиторий или загрузите его содержимое, а затем добавьте необходимые скрипты к вашим текстовым компонентам в проекте Unity. Настройте параметры в соответствии с вашими требованиями, и вы будете готовы к использованию ограничений символов в ваших текстовых полях.
31+
32+
## Автор
33+
[RimuruDev](https://github.com/RimuruDev)
34+
35+
### Написал для
36+
[MaksimSazanovich](https://github.com/MaksimSazanovich)
37+
38+
---

TextLimiter/README.md

Lines changed: 0 additions & 38 deletions
This file was deleted.

0 commit comments

Comments
 (0)