개요
나이아가라(Niagara) 를 사용하면 나이아가라 스크립트(Niagara Script) 로 커스텀 모듈을 만들 수 있습니다. 커스텀 모듈을 만들어 팀과 공유하거나 여러 프로젝트에서 활용할 수 있습니다. 기능을 추가하거나 향상시키기 위해 모듈에 작업할 때, 이미 해당 모듈을 사용하고 있는 기존 에셋에 영향이 가지 않도록 주의해야 합니다.
버전 관리를 사용하지 않는 커스텀 모듈의 경우, 기본적으로 변경사항이 이 모듈을 사용하는 에셋에 바로 적용됩니다. 반대로 버전 관리를 활성화한 경우, 모듈을 사용할 수 있게 되면 사용자가 해당 모듈의 버전을 직접 새 버전으로 업그레이드해야 합니다.
이러한 이유로 이제 모듈의 버전을 나이아가라에서 직접 만들 수 있습니다. 버전 관리 기능은 깃(Git)이나 퍼포스(Perforce) 같은 버전 관리 툴의 대체용이 아닌, 나이아가라에 내장된 시스템입니다.
또한 이미터를 에셋으로 저장한 후 해당 이미터에 나이아가라 스크립트와 똑같은 방식으로 나이아가라 버전 관리를 적용할 수도 있습니다.
모듈 버전 관리
버전 관리 기능을 활성화하려면 우선 스크립트 에디터에서 모듈을 열어야 합니다. 나이아가라 에디터(Niagara Editor) 의 시스템 개요(System Overview) 에서 해당 모듈을 더블 클릭하거나, 콘텐츠 브라우저(Content Browser) 에서 나이아가라 스크립트를 더블 클릭하여 모듈을 열 수 있습니다.
툴바에서 버전 관리(Versioning) 버튼을 클릭합니다.
이미지를 클릭하면 최대 크기로 볼 수 있습니다.
이미터 버전 관리
모듈과 마찬가지로, 이미터에 버전 관리를 적용하여 다양한 프로젝트에서 재사용할 수 있습니다. 이 기능을 활용하려면 이미터를 에셋으로 저장해야 합니다. 저장하는 방법은 두 가지가 있습니다.
- 새 이미터를 생성합니다. 콘텐츠 브라우저에서 우클릭한 후 FX > 나이아가라 이미터(Niagara Emitter) 를 선택하여 새 이미터 에셋을 생성할 수 있습니다.
- 기존 이미터를 변환합니다. 나이아가라 시스템 내부에서 이미터를 우클릭하고 여기에서 에셋 생성(Create Asset From This) 을 선택합니다.
그런 다음 이미터 에셋에서 상단 툴바의 버전 관리(Versioning) 버튼을 찾아 버전 관리를 활성화할 수 있습니다. 이는 나이아가라 스크립트 에셋에서와 똑같은 방식으로 작동합니다.
이미지를 클릭하면 최대 크기로 볼 수 있습니다.
버전 관리 활성화 방법
해당 모듈의 버전 관리를 처음 세팅할 경우, 팝업 대화창이 나타납니다. 대화창은 버전 관리를 활성화한 후 모듈의 모든 사용자는 변경 사항이 적용될 때 새 버전으로 직접 업그레이드해야 한다는 사실을 알려 줍니다. 수락하려면 버전 관리 활성화(Enable Versioning) 를 누르세요.
이미지를 클릭하면 최대 크기로 볼 수 있습니다.
이제 기존 버전의 프로퍼티를 편집하거나 새 버전을 만들 수 있습니다.
버전 디테일
생성한 버전마다 설정 가능한 버전 디테일이 있습니다.
이미지를 클릭하면 최대 크기로 볼 수 있습니다.
| 파라미터 | 설명 |
|---|---|
| 노출된 버전 여부(Is Exposed Version) | 활성화할 경우, 해당 버전이 이 모듈을 언제 사용하든 항상 기본값이 되도록 설정합니다. 이 모듈을 사용하는 사람은 누구나 버전 선택 툴에서 이 버전을 볼 수 있습니다. |
| 변경사항 설명(Change Description) | 사용자가 이 버전의 새로운 점을 알기 쉽도록 텍스트를 작성합니다. |
| 버전 선택 툴에 표시 여부(Is Visible in Version Selector) | 사용자가 버전 선택 툴에서 이 버전을 사용할 수 있도록 합니다. 모듈의 새 버전을 반복작업하고 테스트할 때 다른 사람이 액세스하지 못하게 하려면, 이 옵션을 해제한 채로 두면 됩니다. |
새 버전 만들기
새 버전을 만들려면 나이아가라 스크립트 메뉴에서 버전 관리 버튼을 눌러 패널을 엽니다. 버전 추가(Add Version) 를 클릭합니다.
이미지를 클릭하면 최대 크기로 볼 수 있습니다.
버전을 생성할 때는 주 버전(Major Version) 과 부 버전(Minor Version) 부터 지정해야 합니다. 부 버전은 큰 영향을 끼치지 않는 작은 변경사항에 쓰여야 합니다. 주 버전은 해당 버전으로 이주한 뒤에는 이미 설정된 프로퍼티를 변경하지 않으면 구버전으로 돌아갈 수 없는 변경사항에 쓰여야 합니다.
사용자가 업그레이드에 포함된 위험성을 식별할 수 있도록 주 버전과 부 버전으로 구분하는 것이며, 두 버전에 내부적인 차이는 없습니다.
계속하려면 새 주 버전(New major version) 혹은 새 부 버전(New minor version) 을 선택합니다. 이후 버전 디테일(Version Details) 을 설정할 수 있습니다. 신규 버전을 세팅할 때는 노출된 버전 여부 를 해제된 상태로 두는 것이 좋습니다. 신규 버전을 작업 중이라는 사실을 남에게 알리고 싶지 않으면 버전 선택 툴에 표시 여부 를 해제해도 됩니다. 변경사항이 만족스럽다면 해당 옵션을 활성화하여 다른 사람들에게 알릴 수 있습니다.
새 버전을 만들었으면 창을 닫고 나이아가라 스크립트 에디터로 돌아가면 됩니다. 언제든 툴바의 점 세 개 메뉴(…)에서 편집할 활성 버전을 교체할 수 있습니다.
이미지를 클릭하면 최대 크기로 볼 수 있습니다.
여러 버전 사용하기
나이아가라 에디터 에서 버전 관리를 사용 중인 스택의 모듈을 선택하면, 선택(Selection) 패널에 버전 선택 툴 아이콘이 표시됩니다. 버전 관리가 활성화됐지만 새 버전이 없는 경우에는 아이콘이 회색으로 표시됩니다.
이미지를 클릭하면 최대 크기로 볼 수 있습니다.
새 부 버전을 사용할 수 있게 되면, 아이콘이 주황색으로 바뀝니다.
이미지를 클릭하면 최대 크기로 볼 수 있습니다.
새 주 버전을 사용할 수 있으면, 사용자들에게 새 버전을 알리는 메시지가 출력됩니다.
이미지를 클릭하면 최대 크기로 볼 수 있습니다.
모든 버전 설명 알림은 해제할 때까지 선택 패널에 표시됩니다.
이미지를 클릭하면 최대 크기로 볼 수 있습니다.
언제든 선택 패널에서 버전 버튼을 클릭해 모듈의 버전을 바꿀 수 있습니다. 버전 번호에 마우스를 대면 해당 버전의 설명을 포함한 툴팁이 나타납니다.
이미지를 클릭하면 최대 크기로 볼 수 있습니다.
새 주 버전이 활성화될 경우, 이미터 스택의 경고 아이콘으로도 알 수 있습니다. 경고 아이콘은 모듈과 모듈이 속한 그룹의 우측에 표시됩니다.
이미지를 클릭하면 최대 크기로 볼 수 있습니다.
모듈을 새 버전으로 전환한 후에는 되돌릴 수 없는 경우도 있습니다. 우선 프로젝트를 저장한 다음, 새 버전으로 바꿔서 문제가 없는지 확인하는 것이 좋습니다.
새 버전으로 바꾸려면 시스템 개요 에서 업데이트할 커스텀 모듈을 선택합니다. 버전 전환 툴을 클릭한 다음, 사용할 버전을 선택하면 됩니다. 새 버전이 주 버전일 경우, 선택 패널에서 이슈 고침(Fix Issue) 을 클릭해 해당 버전으로 직접 업그레이드할 수도 있습니다.
이미지를 클릭하면 최대 크기로 볼 수 있습니다.
Python 통합
이 기능은 실험단계이며 향후 변경될 수 있습니다.
모듈의 버전을 업그레이드할 때, 시스템에서는 기존 버전의 프로퍼티를 최대한 새 버전에 맞게 매핑하려고 합니다. 하지만 원하는 결과가 명확하지 않다면, 업그레이드 스크립트를 직접 작성하면 어떤 식으로 버전을 업그레이드하면 되는지를 시스템에 알려줄 수 있습니다. 이 기능을 이용하면 사용자가 버전을 업그레이드할 때마다 스크립트를 작성하는 과정을 반복하지 않아도 됩니다.
업데이트 스크립트를 전달하려면 나이아가라 스크립트 툴바의 버전 관리 버튼을 눌러 패널을 엽니다. 스크립팅(Scripting)이라는 패널이 있을 것입니다. 기본적으로 업데이트 스크립트 실행(Update Script Execution) 세팅은 스크립트를 전달하지 않는 None 으로 설정됩니다.
이미지를 클릭하면 최대 크기로 볼 수 있습니다.
스크립트를 입력하는 방법은 두 가지입니다.
- 텍스트를 버전 관리 패널에 직접 복사해서 붙여넣습니다.
- 외부 에셋에 연결합니다.
Direct Text Entry
텍스트를 직접 복사해서 붙여넣으려면 업데이트 스크립트 실행 을 클릭한 뒤, Direct Text Entry 를 선택합니다. 이제 Python 업데이트 스크립트(Python Update Script) 에 텍스트를 직접 복사해서 붙여넣으면 됩니다.
이미지를 클릭하면 최대 크기로 볼 수 있습니다.
외부 스크립트 추가하기
외부 스크립트에 연결하려면 업데이트 스크립트 실행 을 누른 뒤, Script Asset 을 선택합니다. 스크립트 에셋(Script Asset) 항목 우측의 점 세 개 메뉴(…)를 클릭하면 스크립트 파일을 탐색할 수 있습니다.
이미지를 클릭하면 최대 크기로 볼 수 있습니다.
Python 스크립트 작성하기
기존 나이아가라 스크립트를 새 버전에 어떻게 매핑할 지 확실하지 않다면, Python 스크립트를 사용하면 됩니다. 예를 들어 구버전에서 bool 입력을 가져와서 새 버전에서 값이 두 개 이상인 enum 열거형을 대신 사용할 경우, 업데이트 스크립트에서 기존 bool 입력을 두 개의 enum 값에 매핑할 수 있습니다. 다음은 예시 스크립트입니다.
bool 입력을 구해서 새 입력을 enum으로 설정
flying = upgrade_context.get_old_input("Is Flying")
if not flying.is_local_value():
print("Is Flying input used a dynamic input that could not be transferred to the new Movement Mode input")
elif flying.as_bool():
upgrade_context.set_enum_input("Movement Mode", "Flying")
else:
upgrade_context.set_enum_input("Movement Mode", "Walking")
upgrade_context 변수는 스크립트에 전달되며, 기존 및 새 입력을 모두 포함합니다.
여기서 get_old_input(string input_name) 을 호출할 경우, 현재 스택 값에 가져올 수 있는 입력 오브젝트를 반환합니다. 마찬가지로 set_XXX_input(string input_name, XXX value) 를 사용하여 새 입력에 값을 제공할 수 있습니다.
여기서 실행한 모든 print() 호출은 스크립트가 완료된 후 스택에서 경고로 나타납니다.
언리얼에서 Python으로 수행 가능한 작업에 관한 자세한 문서는 Python을 통한 에디터 스크립팅을 참조하세요.
Python API 목록
다음은 나이아가라 버전 관리 오브젝트 API입니다. 여기를 클릭하여 전체 언리얼 Python API 문서를 확인하세요.
upgrade_context API
get_old_input(string input_name)
해당 구문은 아래의 UNiagaraPythonScriptModuleInput 을 반환합니다. 입력이 존재하지 않을 경우, 해당 구문은 오류를 알리는 대신 빈 기본 오브젝트를 반환합니다.
유형에 따라 다음 구문으로 새 입력을 설정할 수 있습니다.
set_float_input(string input_name, float value);
set_int_input(string input_name, int value);
set_bool_input(string input_name, bool value);
set_vec2_input(string input_name, Vector2D value);
set_vec3_input(string input_name, Vector value);
set_vec4_input(string input_name, Vector4 value);
set_color_input(string input_name, LinearColor value);
set_quat_input(string input_name, Quat value);
set_enum_input(string input_name, string value);
UNiagaraPythonScriptModuleInput API
bool is_set()
사용자가 값을 설정하면 해당 구문은 true 를 반환합니다.
bool is_local_value()
입력이 로컬 값으로 세팅되고, 연결된 어트리뷰트나 다이내믹 입력이 아니면 true 를 반환합니다.
bool is_local_value() 가 true 를 반환할 경우, 사용자는 입력을 다음 Python 값으로 변환할 수 있습니다.
float as_float()
int as_int()
bool as_bool()
Vector2D as_vec2()
Vector as_vec3()
Vector4 as_vec4()
LinearColor as_color()
Quat as_quat()
string as_enum()