OnPlayerClickPlayer

From SA-MP Wiki

(Difference between revisions)
Jump to: navigation, search
Revision as of 19:46, 23 April 2014
Ikkentim (Talk | contribs)
(Added return value)
← Previous diff
Current revision
OstGot (Talk | contribs)

Line 10: Line 10:
{{Param|source|The [[Click Sources|source]] of the player's click.}} {{Param|source|The [[Click Sources|source]] of the player's click.}}
-{{NoReturnCallback}}+{{Returns|
 +* '''1''' - Will prevent other filterscripts from receiving this callback.
 +* '''0''' - Indicates that this callback will be passed to the next filterscript.
 +* It is always called first in filterscripts.}}
{{note|There is currently only one 'source' (0 - CLICK_SOURCE_SCOREBOARD). The existence of this argument suggests that more sources may be supported in the future.}} {{note|There is currently only one 'source' (0 - CLICK_SOURCE_SCOREBOARD). The existence of this argument suggests that more sources may be supported in the future.}}

Current revision



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


Description:

Called when a player double-clicks on a player on the scoreboard.


Parameters:
(playerid, clickedplayerid, source)
playeridThe ID of the player that clicked on a player on the scoreboard.
clickedplayeridThe ID of the player that was clicked on.
sourceThe source of the player's click.


Return Values:

  • 1 - Will prevent other filterscripts from receiving this callback.
  • 0 - Indicates that this callback will be passed to the next filterscript.
  • It is always called first in filterscripts.


Image:32px-Ambox_warning_orange.png

Note

There is currently only one 'source' (0 - CLICK_SOURCE_SCOREBOARD). The existence of this argument suggests that more sources may be supported in the future.


Example Usage:

public OnPlayerClickPlayer(playerid, clickedplayerid, source)
{
    new message[32];
    format(message, sizeof(message), "You clicked on player %d", clickedplayerid);
    SendClientMessage(playerid, 0xFFFFFFFF, message);
    return 1;
}

Related Functions

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

Personal tools
In other languages