Skip to content

Commit 887a6da

Browse files
jcs090218jcs090218
committed
docs: Update UI dialogue system
1 parent a1a9e56 commit 887a6da

File tree

1 file changed

+19
-18
lines changed

1 file changed

+19
-18
lines changed

‎docs/ScriptReference/UI/Dialogue/JCS_DialogueSystem.md‎

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,25 @@ Dialogue system core implementation.
44

55
## Variables
66

7-
| Name | Description |
8-
|:----------------------------------|:---------------------------------------------------|
9-
| onDispose | Callback when successfully dispose the dialogue. |
10-
| mMakeHoverSelect | If the mouse hover then select the selection. |
11-
| mCenterImage | Image displayed at the center. |
12-
| mLeftImage | Image displayed at the left. |
13-
| mRightImage | Image displayed at the right. |
14-
| mNameTag | Text box to display names. |
15-
| mTextBox | Text box to display content messages. |
16-
| mScrollTime | Speed of scrolling the text. |
17-
| mProgressOnHidden | Allow progress dialogue even the it is hidden. |
18-
| mButtonSelectionGroup | Make control from the gamepad. |
19-
| mCompleteTextBeforeAction | Complete text before run action. |
20-
| mCompleteTextBeforeActionOnButton | Complete text before run action on button's event. |
21-
| mAutoProgress | If true, auto progress the dialgoue. |
22-
| mAutoDelay | Delay before start the next text popup. |
23-
| mActiveSound | Sound plays when active dialogue. |
24-
| mDisposeSound | Sound plays when dispose dialogue. |
7+
| Name | Description |
8+
|:----------------------------------|:----------------------------------------------------------------------------------------------------------------|
9+
| onDispose | Callback when successfully dispose the dialogue. |
10+
| onNextOrDisposeCondition | Callback determine when the dialogue system suppose to be disposed when executing the function `NextOrDispose`. |
11+
| mMakeHoverSelect | If the mouse hover then select the selection. |
12+
| mCenterImage | Image displayed at the center. |
13+
| mLeftImage | Image displayed at the left. |
14+
| mRightImage | Image displayed at the right. |
15+
| mNameTag | Text box to display names. |
16+
| mTextBox | Text box to display content messages. |
17+
| mScrollTime | Speed of scrolling the text. |
18+
| mProgressOnHidden | Allow progress dialogue even the it is hidden. |
19+
| mButtonSelectionGroup | Make control from the gamepad. |
20+
| mCompleteTextBeforeAction | Complete text before run action. |
21+
| mCompleteTextBeforeActionOnButton | Complete text before run action on button's event. |
22+
| mAutoProgress | If true, auto progress the dialgoue. |
23+
| mAutoDelay | Delay before start the next text popup. |
24+
| mActiveSound | Sound plays when active dialogue. |
25+
| mDisposeSound | Sound plays when dispose dialogue. |
2526

2627
## Functions
2728

0 commit comments

Comments
 (0)