전제조건 개발자 모드 활성화
자동 완성을 세팅하기에 앞서 언리얼 엔진(UE) Python 플러그인 이 필요한 스텁을 생성하도록 지시해야 합니다. 그렇게 하려면 에디터 개인설정(Editor Preferences) > 플러그인(Plugins) > Python 에서 개발자 모드(Developer Mode) 에 체크하고 에디터를 재시작합니다. 생성된 스텁 파일의 위치는 PROJECT_DIRECTORY/Intermediate/PythonStub 입니다.
PyCharm
세팅(Settings) 창을 열고 프로젝트(Project) > Python 인터프리터(Python Interpreter) 로 가서 톱니바퀴 아이콘을 클릭한 후 모두 표시(Show all) 를 선택합니다. Python 인터프리터(Python Interpreter) 창에서 경로(Paths) 버튼을 클릭하고 + 표시를 클릭하여 스텁 파일의 위치를 추가합니다.
또한 Intellisense 파일의 최대 크기를 늘리기 위해 도움말(Help) > 커스텀 프로퍼티 편집(Edit Custom Properties) 으로 가서 다음을 추가해야 합니다.
idea.max.intellisense.filesize = 25000
PyCharm을 재시작한 후 UE API의 자동 완성 메뉴에서 함수를 볼 수 있습니다.
VSCode
설정(Settings) > 확장(Extension) > Python 으로 이동하여 자동 완성: 추가 경로 (Auto Complete: Extra Paths) 를 찾습니다. 링크를 클릭하여 settings.json 파일을 열고 python.autoComplete.extraPaths 아래에 스텁 파일의 경로를 추가합니다.
Visual Studio Code (VSCode) 를 재시작한 후 UE API의 자동 완성 메뉴에서 함수를 볼 수 있습니다.
타입 힌팅
이제 Python 플러그인은 타입 힌팅으로 스텁을 생성할 수 있습니다. 타입 힌팅에 관한 자세한 내용은 PEP 484를 참조하세요. 타입 힌트는 Python IDE 자동 완성 메뉴에 표시됩니다. 타입 힌트를 환경설정하려면, 우선 언리얼 에디터 메뉴 바에서 편집(Edit) > 에디터 개인설정(Editor Preferences) 을 클릭합니다. 그러면 에디터 개인설정 탭이 열립니다. 플러그인(Plugins) > Python 으로 이동하여 사용 가능한 Python 스크립트 플러그인 사용자 세팅을 확인합니다. 타입 힌팅을 사용하려면 개발자 모드(Developer Mode) 를 활성화해야 합니다. 다음은 이용 가능한 타입 힌팅 모드와 설명이 담긴 표입니다.
| 타입 힌팅 모드 | 설명 |
|---|---|
| 자동 완성(Auto-Completion) | 정확한 파라미터를 힌팅하고 메서드의 타입을 반환합니다. |
| 타입 체커(Type Checker) | 가능한 모든 타입 강제를 추가합니다. 예를 들어 unreal.Name 대신 Python 스트링을 전달할 수 있습니다. 이렇게 하면 자동 완성 메뉴가 복잡해지고 읽기 어려워지지만, IDE에서 타입 확인을 켜면 이 옵션이 더욱 잘 작동합니다. |
| 끔(Off) | 타입 힌팅을 끕니다. |
기본적으로 타입 힌팅 모드(Type Hinting Mode) 는 자동 완성(Auto-Completion) 으로 설정됩니다.
힌팅은 완벽하지 않다는 점에 유의하세요. 스텁을 생성할 때 타입을 알 수 없는 경우도 있습니다. 한편 메서드의 반환 값 또는 파라미터가 None 일 수 있는 경우, C++ 리플렉션 API는 정확한 힌트를 주기에 충분한 정보를 제공하지 않습니다.
스텁 파일은 에디터가 시작될 때마다 재생성됩니다. 결과적으로 새 함수를 Python에 노출하거나 새 플러그인을 활성화한 후 에디터를 재시작하여 스텁 파일을 최신 상태로 유지할 수 있습니다.