Unity - Scripting API를 참고하는 법

유니티 버전 - 2022.3.48f1

Scripting API 버전 - 2022.3

 

 

 

 

 

목차

---

• 들어가며
• Scripting API
  • 기본적인 구성
  • Properties (속성)
  • Static Properties (정적 속성)
  • Constructors (생성자)
  • Inherited Members (상속된 멤버들)
  • Public Methods (공개 메서드)
  • Static Methods (정적 메서드)
  • Operators (연산자)
  • Messages (메시지)
• 마치며

 

 

 

 

 

들어가며

---

Vector2를 이용하여 무엇인가 구현하려고 할때, Vector2에서 사용 가능한 옵션들을 알아보기 위한 방법으로, 유튜브나 구글링 등의 방법이 있겠지만 유니티에서 제공하는 공식 Scripting API를 이용하여 궁금한 내용에 대하여 찾아보는 법을 알아보겠습니다

 

 

 

 

 

Scripting API

---

 

 

 

기본적인 구성

---

1. 좌측 상단에서 현재 프로젝트에 적용중인 유니티의 버전을 참고하여 알맞는 버전을 클릭해줍니다

2. 좌측 스크롤을 내려서 Classes를 열고 원하는 섹션을 찾아 클릭하여 줍니다

3. 선택한 섹션과 간략한 설명을 확인할 수 있습니다

 

 

 

Properties (속성)

---

클래스나 객체가 가진 특정 값이나 상태를 의미합니다, 속성을 읽거나 수정할때 사용합니다

BoxCollider2D boxCollider = gameObject.GetComponent<BoxCollider2D>();
boxCollider.size = new Vector2(2, 3);

// size는 BoxCollider2D의 속성

 

 

 

Static Properties (정적 속성)

---

해당 속성들은 객체를 생성하지 않고도 클래스 명을 통하여 접근할 수 있습니다

Vector2 moveUp = Vector2.up;
// Vector2.up은 (0, 1)로 설정된 정적 속성


Vector2 moveRight = Vector2.right;
// Vector2.right은 (1, 0)로 설정된 정적 속성

 

 

 

Constructors (생성자)

---

객체가 생성될 때 호출되는 메서드로, 객체 초기화를 담당합니다

Vector3 position = new Vector3(1.0f, 2.0f, 3.0f);

// 좌표 (1, 2, 3)로 벡터 초기화
// new뒤의 Vector3이 여기서 생성자 역할을 함

 

 

 

Inherited Members (상속된 멤버들)

---

부모 클래스에서 상속된 속성이나 메서드로, 자식 클래스에서 그대로 사용할 수 있습니다

BoxCollider2D boxCollider = gameObject.GetComponent<BoxCollider2D>();
boxCollider.enabled = false;  // Collider 비활성화

// BoxCollider2D는 Collider2D를 상속받으며, Collider2D.enabled는 상속된 속성입니다.

 

 

 

Public Methods (공개 메서드)

---

객체의 기능을 수행하는 함수입니다. 다른 클래스나 객체에서 이 메서드를 호출하여 특정 동작을 수행할 수 있습니다.

Vector2 vector = new Vector2(3.0f, 4.0f);

vector.Normalize(); // 벡터를 정규화하여 크기를 1로 설정

 

 

 

Static Methods (정적 메서드)

---

클래스 자체에 속해 있으며, 객체를 생성하지 않고도 사용할 수 있습니다, 주로 입력값만으로 결과를 계산하거나, 공통된 작업을 수행할 때 사용됩니다

Vector2 pointA = new Vector2(1.0f, 2.0f);
Vector2 pointB = new Vector2(4.0f, 6.0f);

float distance = Vector2.Distance(pointA, pointB);  // 객체 상태 변화 없이 결과만 계산

 

 

 

Operators (연산자)

---

객체 간 비교나 수학적 연산에 사용됩니다, 객체들이 기본적인 연산자로 처리될 수 있게 만듭니다, 사용가능한 연산자를 제공해줍니다

Vector2 pointA = new Vector2(1, 2);
Vector2 pointB = new Vector2(3, 4);

Vector2 result = pointA + pointB; // '+' 연산자

 

 

 

Messages (메시지)

---

Unity에서 특정 이벤트가 발생했을 때 호출되는 메서드들입니다, Start()나 Update()도 이에 포함됩니다

void Start()
{
    // 게임 오브젝트가 생성될 때 호출됨
}

void OnCollisionEnter2D(Collision2D collision)
{
    // 충돌 발생 시 호출됨
}

 

 

 

 

 

마치며

---

여기까지 유니티가 제공하는 Scripting API의 요소들이 의미하는 것과 어떤 상황에서 사용할 수 있는지 알아보았습니다

 

아래는 2022.3버전의 Scripting API입니다

https://docs.unity3d.com/2022.3/Documentation/ScriptReference/BoxCollider2D.html 

Unity - Scripting API: BoxCollider2D

 

 

이상입니다