SetPanelButtonFlash(object, int, int)

Make a panel button in the player's client start or stop flashing.

void SetPanelButtonFlash(
    object oPlayer,
    int nButton,
    int bEnableFlash
);

Parameters

oPlayer

Target Player.

nButton

PANEL_BUTTON_*

bEnableFlash

TRUE or FALSE to start or stop flashing.

Description

Causes the panel button nButton in oPlayer's client start or stop flashing. The parameter bEnableFlash can be either TRUE or FALSE to start or stop flashing the panel button.

Remarks

Flashing panel buttons will stop flashing once a player clicks the panel button with the mouse, or opens the panel using the corresponding keystroke. Setting the bEnableFlash parameter to FALSE is usually unecessary.

Updating a PC's journal will automatically cause the journal button to start flashing.

Version

1.22

Example

void main()
{
    object oPlayer = GetFirstPC();

    // flash the journal panel button to indicate a new quest
    SetPanelButtonFlash(oPlayer, PANEL_BUTTON_JOURNAL, TRUE);

    // stop flashing the panel button
    SetPanelButtonFlash(oPlayer, PANEL_BUTTON_JOURNAL, FALSE);

}