ShowPlayerDialog

From SA-MP Wiki

Revision as of 21:02, 4 July 2012; view current revision
←Older revision | Newer revision→
Jump to: navigation, search


ShowPlayerDialog was added in SA-MP 0.3a This function was added in SA-MP 0.3a and will not work in earlier versions!


Shows the player a synchronous (only one at a time) dialog box.


Parameters:
(playerid, dialogid, style, caption[], info[], button1[], button2[])
playeridThe ID of the player to show the dialog to.
dialogidAn ID to assign this dialog to, so responses can be processed. Max dialogid is 32767. Using negative values will close any open dialog.
styleThe style of the dialog.
caption[]The title at the top of the dialog. The length of the caption can not exceed more than 64 characters before it starts to cut off.
info[]The text to display in the dialog. Use \n to start a new line and \t to tabulate.
button1[]The text on the left button.
button2[]The text on the right button. Leave it blank to hide it.


ReturnsThis function doesn't return a specific value


// Define the dialog IDs either with an enum:
enum
{
    DIALOG_LOGIN,
    DIALOG_WELCOME,
    DIALOG_WEAPONS
}
 
// or with the more common method, defines:
#define DIALOG_LOGIN 1
#define DIALOG_WELCOME 2
#define DIALOG_WEAPONS 3
 
// Enums are recommended.
 
//example for DIALOG_STYLE_MSGBOX
ShowPlayerDialog(playerid, DIALOG_WELCOME, DIALOG_STYLE_MSGBOX, "Notice", "You connected to the server", "Close", "");
 
//example for DIALOG_STYLE_INPUT
ShowPlayerDialog(playerid,DIALOG_LOGIN, DIALOG_STYLE_INPUT, "Login", "Enter your password below:", "Login", "Cancel");
 
//example for DIALOG_STYLE_LIST
ShowPlayerDialog(playerid, DIALOG_WEAPONS, DIALOG_STYLE_LIST, "Weapons", "AK47\nM4\nSniper Rifle", "Option 1", "Option 2");
 
//example for DIALOG_STYLE_PASSWORD
ShowPlayerDialog(playerid, DIALOG_LOGIN, DIALOG_STYLE_PASSWORD, "Login", "Enter your password below:", "Login", "Cancel");
Image:32px-Ambox_warning_orange.png Note: Using -1 as dialogid closes all dialogs currently shown on the client's screen.


Image:32px-Ambox_warning_orange.png Note: It is recommended to use enumerations (see above) or definitions to determine which IDs dialogs have, to avoid confusion in the future.


Image:32px-Ambox_warning_orange.png Note: Use color embedding for multiple colors in the text.


Related Functions

The following functions may be useful, as they are related to this function in one way or another.


Related Callbacks

The following callbacks might be useful, as they're related to this function in one way or another.

Personal tools
In other languages