├── README.md
├── YSI
├── YSI-Includes-5.x.zip
├── amx_assembly-master.zip
├── code-parse.inc-master.zip
└── indirection-master.zip
├── dialog-pages(v2.1).inc
├── dialogpages-test.pwn
├── example.pwn
└── zeex Compilator 3.10.10
└── pawnc-3.10.10-windows.zip
/README.md:
--------------------------------------------------------------------------------
1 | # 🥇 Dynamic Dialog-Pages for San Andreas MultiPlayer
2 |
3 | Using this library you will can create pages in dialogs with a few lines of code. You can display many more lines in the dialog aside from the 4096 character limit using pages.
4 |
5 | 
6 |
7 | > Let's see how it's working.
8 |
9 | ### First of all init include for your gamemode.
10 | ```pawn
11 | #include "dialog-pages.inc"
12 | ```
13 | > The addition of the YSI library is required for Dialog-Pages to function properly. YSI has been added to the repository and the necessary files (compilator etc.)
14 |
15 | To create dialog-pages you must use this function. This function have more arguments than the orginal. Additional arguments add library hints how the dialog exactly should look.
16 | ```pawn
17 | ShowPlayerDialogPages(playerid, dialogid, dialogstyle, caption[], info[], button1[], button2[], maxitemslist = 15, nextbutton[] = "Next page", lastbutton[] = "Previous page", bool:dynamic = false);
18 | ```
19 | - **playerid** - player ID.
20 | - **dialogid** - dialog ID to check action.
21 | - **dialogstyle** - dialog format: *DIALOG_STYLE_LIST, DIALOG_STYLE_TABLIST, DIALOG_STYLE_TABLIST_HEADERS*
22 | - **caption[]** - title string dialog.
23 | - **info[]** - main string content dialog.
24 | - **button1[]** - string content for first button.
25 | - **button2[]** - string content for last button.
26 | - **maxitemlist** - number of lines for one page.
27 | - **nextbutton[]** - string content for next page button.
28 | - **lastbutton[]** - string content for previous page button.
29 | - **bool:dynamic** - if you would control dialog manualy (mainly buttons for page changes) you can set this boolean to true. If you use dynamic dialog-pages you must assign the action by yourself to the buttons chaning pages. If set to false, the include assign the page change button itself without your interference. You can learn more about dynamic dialogs below.
30 |
31 | Dialog-Pages cooperates with large strings which means you can enter whatever you want. Now you can fit a lot of content into one dialog.
32 |
33 | To check the action for dialog-pages use the initialized function in the library:
34 |
35 | ```pawn
36 | public OnDialogPagesResponse(playerid, dialogid, response, listitem, inputtext[], btn_next_index, btn_previous_index)
37 | ```
38 | - **playerid** - player ID.
39 | - **dialogid** - dialog ID for check specific dialog.
40 | - **response** - returns true/false depending on which button is clicked in the dialog box.
41 | - **listitem** - return the index of the row clicked depending on the page.
42 | - **inputtext[]** - return a content of clicked listitem.
43 | - **btn_next_index** - return the index of the next button that changes page.
44 | - **btn_previous_index** - return the index of the previous button that changes page.
45 |
46 | **The last two arguments of this public are only useful when you indicate that the selecyed dialog is dynamic. With two arguments, you are able to check if one of the page change buttons has been clicked.**
47 |
48 | ## 📄 Let's see how to create a dialog which isn't dynamic. 📄
49 | > Let's create a loop which will generate for example 100 lines and put it into dialog. Let's make dialog which designate that there're only 10 lines per page. We can estimate that if we have 100 lines and divide it into 10 possible lines in one page in dialog there will be 10 pages - because **10 * 10 = 100**
50 | ```pawn
51 | new string[4096], tmp_str[64];
52 | for(new i = 0; i < 100; i++)
53 | {
54 | format(tmp_str, sizeof tmp_str, "Random number: %i\n", random(999));
55 | strcat(string, tmp_str);
56 | }
57 | ShowPlayerDialogPages(playerid, 9812, DIALOG_STYLE_LIST, "Dialog-Pages - Test.", string, "Select", "Cancel", 10, "Next page", "Previous Page", false);
58 | ```
59 | > If your intention isn't to create a dynamic dialog, you don't need to set the last argument because the default value is false.
60 | ```pawn
61 | ShowPlayerDialogPages(playerid, 9812, DIALOG_STYLE_LIST, "Dialog-Pages - Test.", string, "Select", "Cancel", 10, "Next page", "Previous Page");
62 | ```
63 | > The same goes for the buttons chaning pages. If you don't want to change them, you can just skip the arguments last three arguments:
64 | ```pawn
65 | ShowPlayerDialogPages(playerid, 9812, DIALOG_STYLE_LIST, "Dialog-Pages - Test.", string, "Select", "Cancel", 10);
66 | ```
67 | > Also, you don't need to enter the number of lines per page. The default is 15.
68 | ```pawn
69 | ShowPlayerDialogPages(playerid, 9812, DIALOG_STYLE_LIST, "Dialog-Pages - Test.", string, "Select", "Cancel");
70 | ```
71 | See how easy it is to use this library!
72 |
73 | #### Let's check how to refer to the dialog. Let us make that after clicking the "Select" button then server send message for player with the index that was selected on the page in the dialog when will be displayed.
74 | ```pawn
75 | public OnDialogPagesResponse(playerid, dialogid, response, listitem, inputtext[], btn_next_index, btn_previous_index)
76 | {
77 | switch(dialogid)
78 | {
79 | case 9812: //ID of dialog which we checking.
80 | {
81 | if(response)
82 | {
83 | new string[128];
84 | format(string, sizeof string, "You selected row: %i", listitem);
85 | SendClientMessage(playerid, -1, string);
86 | }
87 | }
88 | }
89 | return 1;
90 | }
91 | ```
92 |
93 | Ready. In this way, we have created a dialog with the pages that sends a message to the client who exactly clicked the index with the "Select" button.
94 |
95 | ## 📑 Let's see how to create a dialog which is dynamic. 📑
96 | > We will create the same dialog as above, only that it will be dynamic. We set ``bool:dynamic`` to **true** (in this case we have to give all the arguments in the function).
97 | ```pawn
98 | new string[4096], tmp_str[64];
99 | for(new i = 0; i < 100; i++)
100 | {
101 | format(tmp_str, sizeof tmp_str, "Random number: %i\n", random(999));
102 | strcat(string, tmp_str);
103 | }
104 | ShowPlayerDialogPages(playerid, 9700, DIALOG_STYLE_LIST, "Dialog-Pages - Test.", string, "Select", "Cancel", 10, "Next page", "Previous Page", true);
105 | ```
106 | When you using dynamic dialogs, you are forced to add an action for page buttons on the your code. To give them an action, you need to use the OnDialogPagesResponse callback and check which button has been clicked. For this condition, you will need the last two callback parameters. Just see 109 line:
107 | ```pawn
108 | public OnDialogPagesResponse(playerid, dialogid, response, listitem, inputtext[], btn_next_index, btn_previous_index)
109 | {
110 | switch(dialogid)
111 | {
112 | case 9700:
113 | {
114 | if(listitem == btn_next_index || listitem == btn_previous_index) //line 109
115 | {
116 | if(listitem == btn_next_index)
117 | ShowPlayerDialogNextPage(playerid);
118 | else ShowPlayerDialogPreviousPage(playerid);
119 | }
120 | else ClearDialogPagesData(playerid); //line 115
121 | }
122 | }
123 | return 1;
124 | }
125 | ```
126 | This code above checks to see if one of the page change buttons is clicked and gives them the same action that the include gives by default.
127 |
128 | > Functions for manage a dynamic dialogs below:
129 | ```pawn
130 | ShowPlayerDialogNextPage(playerid); //- open a next page if the next page exist.
131 | ShowPlayerDialogPreviousPage(playerid); //- open a previous page if previous page exist.
132 | ShowPlayerDialogCurrentPage(playerid); //- open a current page.
133 | ClearDialogPagesData(playerid); //- clearing all data dialog-pages for player.
134 | ```
135 |
136 | > Definitions:
137 | ```pawn
138 | #define INVALID_BUTTON_ID -1
139 | ```
140 |
141 | > An important element is the reset of dialog data. If you are using dynamic dialogs you are forced to reset the data after the dialog is completely closed. You must always keep this in mind as data cleansing is only required in dynamic dialogs.
142 |
143 | > Look at 115 line, if player wasn't clicked button for changing pages he must clicked a normal list so you will be forced to reset dialog data for player because if player click on the normal list, the dialog is completely closed.
144 |
145 | If we wanted to do exactly the same as in the static dialog above, we should code it this way in OnDialogPagesResponse.
146 | ```pawn
147 | public OnDialogPagesResponse(playerid, dialogid, response, listitem, inputtext[], btn_next_index, btn_previous_index)
148 | {
149 | switch(dialogid)
150 | {
151 | case 9700:
152 | {
153 | if(listitem == btn_next_index || listitem == btn_previous_index)
154 | {
155 | if(listitem == btn_next_index)
156 | ShowPlayerDialogNextPage(playerid);
157 | else ShowPlayerDialogPreviousPage(playerid);
158 | }
159 | else
160 | {
161 | if(response)
162 | {
163 | new string[128];
164 | format(string, sizeof string, "You selected row: %i", listitem);
165 | SendClientMessage(playerid, -1, string);
166 | }
167 | ClearDialogPagesData(playerid); //remember to reset player data if dialog completely closed.
168 | }
169 | }
170 | }
171 | return 1;
172 | }
173 | ```
174 |
175 | > Creating dynamic dialogs is very important for people who want to change actions for buttons that change page. Coding them is very simple and simple to operate. This way you can edit the action of the buttons.
176 |
177 | ## Display of the current page or the maximum number of pages in caption or info.
178 | > By placing the appropriate phrases, which are given below in the title or in the main text, you are able to display the current page viewed or the number of all generated pages by Dialog-Pages.
179 | ```
180 | #currentpage - display a current page.
181 | #pagelist - display a all list of pages.
182 | ```
183 |
184 | Example:
185 | ```pawn
186 | ShowPlayerDialogPages(playerid, 9812, DIALOG_STYLE_LIST, "Test dialog. (Page: #currentpage/#pagelist)", string, "Select", "Cancel");
187 | ```
188 |
189 |
190 |
191 |
192 |