Unity 사용자 매뉴얼 - UI 툴킷의 HelpBox
이 문서는 Unity의 UI 툴킷에서 HelpBox 컴포넌트를 사용하는 방법을 설명합니다. HelpBox는 정보를 전달하는 데 유용한 UI 요소이며, 특정 메시지 유형에 따라 다르게 표시할 수 있습니다.
UXML 요소: HelpBox
HelpBox는 다음과 같은 속성을 가지고 있습니다:
| 이름 | 타입 | 설명 |
|---|---|---|
| message-type | UIElements.HelpBoxMessageType | 메시지의 타입을 결정합니다. |
| text | string | 나타내고자 하는 메시지 텍스트입니다. |
상속된 속성
HelpBox는 기본 클래스인 VisualElement로부터 여러 속성을 상속받습니다:
| 이름 | 타입 | 설명 |
|---|---|---|
| focusable | boolean | 요소가 포커스를 받을 수 있는지 여부를 나타냅니다. |
| tabindex | int | 포커스를 맞출 수 있는 항목의 순서를 정합니다. |
| content-container | string | 자식 요소가 추가됩니다. |
| name | string | 특정 요소를 타겟팅하는 USS 선택자 작성을 위한 이름입니다. |
| styles | string | 요소의 스타일 객체에 대한 참조입니다. |
| tooltip | string | 요소 위에 마우스를 두었을 때 표시되는 텍스트입니다. |
| usage-hints | UsageHints | 고수준의 사용 패턴을 지정하는 힌트입니다. |
| view-data-key | string | 보기 데이터 지속성에 사용되는 키입니다. |
C# 클래스: HelpBox
HelpBox는 UnityEngine.UIElements 네임스페이스 내에 포함되어 있으며, VisualElement의 구성원으로서 여러 유용한 기능을 제공합니다.
코드 예제
다음은 C#에서 HelpBox를 생성하고 사용하는 방법에 대한 간단한 예제입니다:
using UnityEngine;
using UnityEngine.UIElements;
public class Example : MonoBehaviour
{
void Start()
{
VisualElement root = GetComponent<UIDocument>().rootVisualElement;
HelpBox helpBox = new HelpBox("이곳은 도움이 필요할 때 사용하는 박스입니다.", HelpBoxMessageType.Info);
root.Add(helpBox);
}
}
사용 예제
- 일반 정보 제공: 사용자에게 중요한 정보를 명확히 전달하고 싶을 때 사용합니다.
- 오류 메시지 안내: 사용자에게 오류가 발생했음을 알리고 이를 해결하는 방법을 안내합니다.
- 경고 알림: 특정 조치가 필요함을 사용자가 인지하도록 돕습니다.
USS 클래스
아래는 HelpBox에 대해 정의된 C# 공용 프로퍼티와 관련된 USS 선택자의 목록입니다:
| C# 프로퍼티 | USS 선택자 | 설명 |
|---|---|---|
| ussClassName | .unity-help-box | 이 타입 요소의 USS 클래스명입니다. |
| label | .unity-help-box__label | 레이블의 USS 클래스명입니다. |
| icon | .unity-help-box__icon | 이미지를 위한 USS 클래스명입니다. |
| iconInfo | .unity-help-box__icon--info | 정보 상태를 위한 USS 클래스명입니다. |
| iconWarning | .unity-help-box__icon--warning | 경고 상태를 위한 USS 클래스명입니다. |
| iconError | .unity-help-box__icon--error | 오류 상태를 위한 USS 클래스명입니다. |
| disabled | .unity-disabled | 비활성화된 요소의 USS 클래스명입니다. |
이렇게 HelpBox는 다양한 메시지를 사용자에게 효과적으로 전달할 수 있는 유용한 UI 요소입니다. Unity의 UI 툴킷을 활용하여 더욱 향상된 사용자 경험을 제공할 수 있습니다.