ShowPlayerDialog

ShowPlayerDialog

Description:

Function ShowPlayerDialog shows the player a synchronous (only one at a time) dialog box.

Max dialogid is 32767.

Function ShowPlayerDialog was added in 0.3a and will not work in earlier versions!

It is recommended to use enumerations (see above) or definitions (#define) to determine which IDs dialogs have, to avoid confusion in the future. You should never use literal numbers for IDs - it gets confusing.

Use color embedding for multiple colors in the text. Using -1 as dialogid closes all dialogs currently shown on the client's screen.

Parameters:

(playerid, dialogid, style, caption[], info[], button1[], button2[])

int

playerid

The ID of the player to show the dialog to.

int

dialogid

An ID to assign this dialog to, so responses can be processed. Max dialogid is 32767. Using negative values will close any open dialog.

int

style

The style of the dialog.

string

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.

string

info

The text to display in the main dialog. Use \n to start a new line and \t to tabulate.

string

button1

The text on the left button.

string

button2

The text on the right button. Leave it blank ( "" ) to hide it.

Return Values:

• 1: The function was executed successfully.
• 0: The function failed to execute. This means the player is not connected.

Examples:

Example 1

// Define the dialog IDs either with an enum:
enum
{
    DIALOG_LOGIN,
    DIALOG_WELCOME,
    DIALOG_WEAPONS
}
 
// Alternatively, using macros:
#define DIALOG_LOGIN 1
#define DIALOG_WELCOME 2
#define DIALOG_WEAPONS 3
 
// Enums are recommended, as you don't have to keep track of used IDs.
 
// Example for DIALOG_STYLE_MSGBOX:
ShowPlayerDialog(playerid, DIALOG_WELCOME, DIALOG_STYLE_MSGBOX, "Notice", "You are 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");
 
// Example for DIALOG_STYLE_TABLIST:
ShowPlayerDialog(playerid, DIALOG_WEAPONS, DIALOG_STYLE_TABLIST, "Buy Weapon", "Deagle\t$5000\t100\nSawnoff\t$5000\t100\nPistol\t$1000\t50", "Select", "Cancel");
 
// Example for DIALOG_STYLE_TABLIST_HEADERS:
ShowPlayerDialog(playerid, DIALOG_WEAPONS, DIALOG_STYLE_TABLIST_HEADERS, "Buy Weapon", "Weapon\tPrice\tAmmo\nDeagle\t$5000\t100\nSawnoff\t$5000\t100\nPistol\t$1000\t50", "Select", "Cancel");

Related Functions

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

• TextDrawShowForPlayer: Show a textdraw for a certain player.

Related Callbacks

The following callbacks might be useful as well, as they are related to this callback in one way or another.

• OnDialogResponse: Called when a player responds to a dialog.