Component Guides

Component Guide는 팀 멤버들이 라이브러리의 Component를 사용할 때 참고할 수 있는 문서입니다. 기본적으로 Component에 대한 설명을 작성할 수 있으며, Override 가능한 Variable 혹은 외부와 통신하는 Send/Receive가 사용된 경우 각 항목이 자동으로 추가됩니다

Editing Component Guides

프로토파이 우측 Property Panel에서 Component Guide의 Edit 버튼을 눌러 내용을 수정할 수 있습니다. Component Guide는 Markdown 문법을 지원합니다. (Hyperlink, Image, Table, 문법 제외)

[object Object]

Description

Component에 대한 설명을 적습니다.

Variables

Make Overridable 옵션이 켜진 Variable이 있을 경우, Component Guide 항목에 자동으로 추가됩니다. Variable Type과 Initial Value가 함께 표시됩니다.

[object Object]

Message Out

Send Response에서 Send to Parent 및 Send to Current Scene 채널을 사용할 경우 자동으로 추가됩니다. Message와 Channel 정보가 함께 표시됩니다.

[object Object]

Message In

Receive Trigger에서 Receive from Parent 및 Receive from Current Scene 채널을 사용할 경우 자동으로 추가됩니다. Message와 Channel 정보가 함께 표시됩니다.

[object Object]

Previewing

Instance의 Property panel에서 Component Guide 아이콘을 눌러 작성된 내용을 확인할 수 있습니다.

[object Object]

Minimizing

우측 상단의 Minimize/Maximize 토글 버튼을 누르면 Component Guide를 우측 상단에 고정 할 수 있습니다.

[object Object]
Back To Top