Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

Godot API를 읽는 방법

이 페이지에서는 Godot API에 대한 클래스 참조를 읽는 방법을 배우게 됩니다.

API, 즉 응용 프로그래밍 인터페이스는 Godot가 사용자에게 제공하는 것의 색인입니다. 어떤 클래스가 존재하는지, 서로 어떻게 연관되어 있는지, 어떤 기능이 있는지, 어떻게 사용하는지에 대한 간략한 요약을 제공합니다.

상속

../../_images/class_api_inheritance.webp

각 파일 상단에 클래스 이름이 표시됩니다.

"상속" 섹션에는 현재 클래스가 상속하는 각 클래스가 나열됩니다. 여기서 ``CanvasItem``는 ``Node``를 상속하고 ``Node``는 ``Object``를 상속합니다.

"상속자" 섹션에는 현재 클래스를 직접 상속하는 각 클래스가 나열됩니다. 여기서 Control 및 ``Node2D``는 모두 ``CanvasItem``를 상속합니다.

설명

../../_images/class_api_brief_description.webp

다음으로 수업에 대한 간략한 설명입니다. 이 텍스트는 노드, 리소스 및 기타 유형을 생성하기 위한 Godot 편집기 팝업에 나타납니다.

설명

../../_images/class_api_description.webp

다음으로 클래스, 해당 기능 및 사용 사례에 대해 더 자세히 설명합니다.

여기에서 찾을 수 있는 항목:

  1. 수업 진행 방식에 대한 구체적인 내용입니다.

  2. 일반적인 사용 사례의 코드 샘플입니다.

  3. 각 클래스의 메서드 간에 공유되는 사용 세부 정보입니다.

  4. 필수 종속성 또는 구성에 대한 경고입니다.

  5. Godot API의 다른 관련 부분에 대한 링크입니다.

튜토리얼

../../_images/class_api_tutorials.webp

그런 다음 페이지에서는 현재 클래스를 언급하거나 활용하는 매뉴얼 부분에 대한 링크를 제공합니다.

속성

../../_images/class_api_properties_table.webp

속성 테이블에는 클래스의 각 인스턴스에 속하는 변수("속성"이라고도 함)가 나열되어 있습니다.

왼쪽 열에는 속성의 데이터 유형이 포함됩니다. 텍스트는 해당 데이터 유형의 Godot API 페이지에 대한 링크이기도 합니다.

중앙 열에는 속성 이름이 포함됩니다. 텍스트는 페이지에 있는 해당 부동산의 전체 설명에 대한 링크이기도 합니다. 이 이름을 사용하여 속성의 데이터를 가져오거나 속성에 새 값을 설정하세요.

오른쪽 열에는 속성의 기본값이 포함되어 있습니다. 다른 값으로 초기화하려면 스크립트 또는 인스펙터를 통해 다른 값을 설정해야 합니다.

메서드

../../_images/class_api_methods_table.webp

메소드 테이블에는 클래스의 각 인스턴스에 속하는 함수("메서드"라고도 함)가 나열되어 있습니다.

왼쪽 열에는 메서드 반환 값의 데이터 유형이 포함됩니다.

오른쪽 열에는 메소드의 이름, 매개변수 및 한정자가 포함됩니다. 이름은 여는 괄호 앞의 텍스트입니다. 또한 페이지에 있는 메소드의 전체 설명에 대한 링크이기도 합니다. 이 이름을 사용하여 메서드를 호출합니다.

각 매개변수에 대해 페이지에는 해당 데이터 유형, 이름 및 기본값(있는 경우)이 자세히 설명되어 있습니다.

가능한 한정자는 다음과 같습니다.

  • const: 이 메소드는 클래스 인스턴스의 데이터를 변경하지 않습니다.

  • virtual: 이 메소드는 스크립트가 이를 대체할 때까지 기다리는 것 외에는 아무것도 수행하지 않습니다.

  • vararg: 이 메소드는 임의 개수의 인수를 허용할 수 있습니다.

시그널

../../_images/class_api_signals.webp

시그널 목록에는 게임 상태가 다른 클래스 인스턴스로 변경되는 "시그널" 이벤트의 이름과 매개변수가 자세히 설명되어 있습니다.

메소드 테이블과 마찬가지로 모든 매개변수에는 해당 데이터 유형과 이름이 포함됩니다.

각 시그널에는 시그널가 방출되는 시기에 대한 자세한 설명도 있습니다.

열거형

../../_images/class_api_enumerations.webp

열거 목록은 현재 클래스와 연관된 열거 가능한 데이터 유형을 자세히 설명합니다.

각 열거에 대해 페이지에는 해당 이름이 표시된 다음 가능한 값이 나열됩니다.

각 열거 값에 대해 페이지에는 해당 이름, 정수 값, 사용 사례 및/또는 영향에 대한 설명이 나와 있습니다.

상수

../../_images/class_api_constants.webp

상수 목록에는 현재 클래스의 명명된 정수 상수가 자세히 나와 있습니다.

각 상수에 대해 페이지에는 해당 이름, 정수 값, 사용 사례 및/또는 영향에 대한 설명이 나와 있습니다.

NOTIFICATION_* 상수의 설명에는 어떤 엔진 이벤트가 알림을 트리거하는지 명시되어 있습니다.

설명

../../_images/class_api_property_descriptions.webp

속성 설명 목록에는 각 속성에 대한 모든 내용이 자세히 설명되어 있습니다.

name은 인스펙터에 추가할 카테고리의 이름입니다.

Godot API의 모든 속성은 한 쌍의 setter 및 getter 함수에 바인딩됩니다. 둘 중 하나를 사용하는 것은 동일합니다. 여기에 나열되어 있습니다.

아래에는 속성 데이터가 나타내는 내용, 사용 사례 및/또는 속성 변경에 따른 영향에 대한 자세한 요약이 나와 있습니다. 여기에는 Godot API의 관련 부분에 대한 코드 샘플 및/또는 링크가 포함될 수 있습니다.

참고

setter 및 getter 이름을 아는 것은 메소드 이름 또는 :ref:`Callable<class_Callable>`를 무언가에 바인딩해야 할 때 유용합니다.

설명

../../_images/class_api_method_descriptions.webp

방법 설명 목록에는 각 방법에 대한 모든 내용이 자세히 설명되어 있습니다.

메소드의 반환 데이터 유형, 매개변수 이름/유형/기본값 및 한정자를 다시 지정합니다.

아래에는 해당 메서드의 기능과 사용 사례에 대한 자세한 요약이 나와 있습니다. 여기에는 Godot API의 관련 부분에 대한 코드 샘플 및/또는 링크가 포함될 수 있습니다.