Flummi/amxmodx
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Improve messages.inc and message_stocks.inc documentation (#510)

Browse Source 
* Improve messages.inc and message_stocks.inc documentation

* Fix typos

* Fixed typos, added a bunch of @notes and better register_message callback function explanation

* Removed extra argument in set_msg_arg_string

* Creates => Sends
This commit is contained in:
OciXCrom
2018-08-20 19:49:47 +02:00
committed by Vincent Herbet
parent eff74fe862
commit 0765dc8a0d
2 changed files with 561 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
plugins/include/message_stocks.inc
View File

@ -16,7 +16,15 @@
#endif
#define _message_stocks_included
/* Creates a death message. */
/**
* Sends a death message.
*
* @param killer Killer id
* @param victim Victim id
* @param weaponNUM Weapon index
*
* @noreturn
*/
stock dod_make_deathmsg(killer, victim, weaponNUM)
{
static msgid = 0;
@ -33,7 +41,14 @@ stock dod_make_deathmsg(killer, victim, weaponNUM)
return 1;
}
/* Kills a user without a message. */
/**
* Kills a user without a message.
*
* @param index Client index
* @param flag If nonzero, the death will not affect the client's score
*
* @noreturn
*/
stock user_silentkill(index, flag = 1)
{
static msgid = 0;
@ -50,7 +65,16 @@ stock user_silentkill(index, flag = 1)
return 1;
}
/* Creates a death message. */
/**
* Creates a death message.
*
* @param killer Killer id
* @param victim Victim id
* @param headshot Headshot
* @param weapon Weapon
*
* @noreturn
*/
stock make_deathmsg(killer, victim, headshot, const weapon[])
{
static msgid = 0;