h1. Prefab -------------------------------------------------- h2. 개요 - 프리팹 이름과 경로 정보들을 정리해놓는 데이터시트다. - 데이터시트에서 프리팹 정보를 연결하는 곳은 다양하지만, 문제는 프리팹 연결정보가 필드 하나로 표현하기가 부족하다는 점이다. : 때로는 프리팹의 이름만 필요할 수도 있고, 이런 이름들은 보통 검색 키로 자주 쓰인다. 그래서 이름과 중간 경로 정보를 별도의 필드로 분리하는 게 더 낫다. - 개발을 하다보면 리소스 파일들의 경로를 더 적합한 형태로 정리하기 위해 디렉토리 구조를 바꾸는 경우가 종종 있는데, 이러면 데이터시트들에서 프리팹 경로가 있는 필드들을 전부 뒤져서 바뀐 경로에 맞춰줘야 한다. 당연히 이런 작업은 실수도 많고, 번거롭기 그지없다. 가급적 처음 디렉토리 구조를 바꾸지 않는게 좋지만, 모든 일이 그렇듯, 처음부터 완벽할 수가 없다. 디렉토리 구조 변경을 지나치게 회피하면 결과적으로 거의 알아볼 수 없는 리소스 파일 적재 구조를 가지게 될 가능성이 높다. - 이 데이터시트는 그런 관리 문제를 해결하기 위한 목적으로 도입하였다. : 프리팹의 경로 정보에 대한 사항들을 전부 이 데이터시트에서 관리할 수 있도록 몰아넣고, 다른 데이터시트에서는 변하지 않을 GTC만 링크할 수 있게 함으로써, 경로 정보가 어떤 이유로 변경되더라도 대응하기가 좀 더 쉬워진다. -------------------------------------------------- h2. [1] Read h3. 형식 - 적용 대상 : 툴 - 자료형 : bool h3. 설명 툴에서 해당 줄의 데이터들을 읽어들일지 아닐지 결정한다. 다음 값들을 사용할 수 있다. *TRUE* : 툴은 그 줄의 데이터를 읽는다. *FALSE* : 툴은 그 줄의 데이터를 읽어들이지 않는다. 툴은 데이터시트에서 읽어들인 줄의 데이터들로만 데이터 스크립트를 제작한다. 따라서, 이 필드를 이용해서 특정한 줄의 데이터들을 선택적으로 게임에 적용하거나, 혹은 적용하지 않게 만드는 데 쓸 수 있다. 예를 들어, 데이터시트에 테스트를 위해 임시로 넣은 데이터가 많은데, 이런 기능이 없는 경우, 게임에 빌드를 하기 위해서는 테스트 데이터를 그대로 사용하든가 아니면 제거해야 한다. 그런데 작업 경과에 따라 이제까지의 작업이 아깝거나, 게임 빌드 이후에 또 실험하던 데이터를 써야하는 등의 갖가지 이유 때문에 게임 빌드에 적용할 동안만 '잠시 툴이 특정 줄들의 데이터를 읽지 못하게' 하고 싶을 수 있다. 이 필드는 그런 경우에 사용할 수 있다. -------------------------------------------------- h2. [2] Comment h3. 형식 - 적용 대상 : 툴 - 자료형 : string h3. 설명 편집하는 사용자에게, 현재 편집하는 줄이 무엇을 위한 데이터인지 알려주는 주석을 적는 공간이다. 따라서 대부분은 순전히 데이터시트를 편집하는 사람의 편의를 위한 필드이기 때문에, 툴에서 데이터 스크립트로 변환할 때 이 필드의 값은 무시한다. 이 필드에 들어가야 하는 값에 대한 규칙도 특별히 존재하지 않는다. 다만, 소스 파일에 데이터 값을 상수로 정의하여 내보내는 경우, Comment 필드의 값은, 소스 코드에서 해당 상수의 역할을 설명하는 주석문으로 사용한다. -------------------------------------------------- h2. [3] General_Type_Code h3. 형식 - 적용 대상 : 공통 - 자료형 : EodGTC(primitive) h3. 설명 현재 줄의 GTC의 값을 정의하는 필드다. 일반 타입 식별 코드(General Type Code)는 게임 내에서 종류를 구분할 필요가 있는 객체들 사이에서, 종류를 식별하는 키로써 사용하는 번호다. 종종 GTC라는 약어로써 표현한다. GTC를 정의하는 본래의 형식은 32비트 정수 타입이다. 따라서 이 필드에는 숫자로 GTC를 정의해야 한다. GTC와 관련한 상세한 내용은 프로젝트의 명세서에서 참고하기 바란다. -------------------------------------------------- h2. [4] GTC_Key h3. 형식 - 적용 대상 : 툴 - 자료형 : EodGTC(key define) h3. 설명 필드의 문자열 식별키를 정의한다. GTC는 숫자이기 때문에, 컴퓨터의 입장에서는 처리가 쉽고 속도도 빠르지만, 사람이 알아보기에는 쉽지 않다. 특히, 숫자가 많은 자릿수를 가지고 있을수록 더욱 그렇다. 이런 문제를 해소하기 위한 가장 좋은 방법은, 같은 GTC에 대해 사람은 문자열로, 컴퓨터는 숫자로 처리할 수 있도록 "자동으로" 연결해주는 기능을 만드는 것이다. 필드는 그러한 기능을 제공하기 위해 추가한 필드이다. 즉, 이 필드가 있기 때문에, 사람이 데이터시트를 편집하면서 다른 데이터시트의 GTC 참조 값을 필드에 넣어야 할 경우, 에서 정의하는 숫자 값으로 참조하는 대신, 이 필드의 문자 값으로 참조 값을 넣을 수 있다. 데이터 스크립트 생성 툴에서 이 데이터시트를 읽을 때, 이 필드에 정의한 문자열 값과 필드의 GTC 값을 연관짓는 사전(Dictionary) 객체를 생성한다. 이 사전 객체는 데이터시트 -> 데이터 스크립트 (+ 소스 파일) 변환 과정이 일어나는 동안 지워지지 않고 유지한다. 툴이 데이터시트들을 변환할 때, GTC를 (본래의 값인)숫자 대신 [4] GTC_Key에 정의한 문자열 값으로 링크하는 필드들을 발견하면, 그 GTC 문자열 키를 GTC의 본래 값인 숫자형으로 변환해서 데이터 스크립트를 작성해야 한다. 그 때, GTC 숫자 <-> GTC 문자 관계를 정의한 사전 객체를 이용해서 GTC 문자 키 -> GTC 숫자 변환을 수행한다. 데이터시트만 봐서는 GTC의 참조를 문자열 키로 하는 셈이지만, 실제로 게임에 탑재하는 데이터 스크립트에는 GTC의 본래 타입인 32비트 정수 값으로 툴이 자동으로 변환해서 넣어준다. -------------------------------------------------- h2. [5] Resource_Path h3. 형식 - 적용 대상 : 클라이언트 - 자료형 : string h3. 설명 중간 디렉토리 경로명. 리소스 파일들은 사용 목적에 따라 특정한 디렉토리에 모아두는 것이 일반적이지만, 리소스 데이터가 지나치게 많거나, 혹은 추가적인 하위 분류가 필요한 경우에는 하위 디렉토리로 분산해서 보관하기도 한다. 그런 경우에 파일 이름을 제외하고 중간 디렉토리 경로만 따로 이 필드에 설정해서 다른 하위 경로에 있는 리소스 파일을 링크하게 할 수 있다. *디렉토리 구분 문자는 반드시 슬래쉬('/') 문자만 사용해야 한다.* 역슬래쉬('\')는 윈도우 플랫폼에서만 사용하기 때문에, 윈도우가 아닌 플랫폼에서는 파일 경로를 찾는 데 문제가 될 수 있다. -------------------------------------------------- h2. [6] File_Name h3. 형식 - 적용 대상 : 클라이언트 - 자료형 : string h3. 설명 리소스 파일의 이름. 확장자는 포함하지 않는다. Unity 엔진에서 알려진 미디어 파일은 확장자를 사용하지 않아도 읽어올 수 있기 때문이다.