GitHub/amxmodx
2
0
Fork 0
mirror of https://github.com/alliedmodders/amxmodx.git synced 2024-12-25 06:15:37 +03:00
Code Issues Projects Releases Wiki Activity

inc-doc2 nits/finishing touches

Browse Source
This commit is contained in:
Valentin Grünbacher 2015-02-24 22:51:36 +01:00
parent 902cecb0c3
commit bc9710e8f2
11 changed files with 73 additions and 77 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
plugins/include/amxconst.inc
View File

@ -8,7 +8,7 @@
// https://alliedmods.net/amxmodx-license // https://alliedmods.net/amxmodx-license
#if defined _amxconst_included #if defined _amxconst_included
#endinput #endinput
#endif #endif
#define _amxconst_included #define _amxconst_included

2
plugins/include/amxmisc.inc
View File

@ -8,7 +8,7 @@
// https://alliedmods.net/amxmodx-license // https://alliedmods.net/amxmodx-license
#if defined _amxmisc_included #if defined _amxmisc_included
#endinput #endinput
#endif #endif
#define _amxmisc_included #define _amxmisc_included

19
plugins/include/amxmodx.inc
View File

@ -8,7 +8,7 @@
// https://alliedmods.net/amxmodx-license // https://alliedmods.net/amxmodx-license
#if defined _amxmodx_included #if defined _amxmodx_included
#endinput #endinput
#endif #endif
#define _amxmodx_included #define _amxmodx_included
@ -100,8 +100,8 @@ forward plugin_end();
/** /**
* Called when a message is about to be logged. * Called when a message is about to be logged.
* *
* @note Message data and information can be retrieved using the read_log set of * @note Message data and information can be retrieved using the read_log* set
* functions. * of functions.
* *
* @return PLUGIN_CONTINUE to let the log message through * @return PLUGIN_CONTINUE to let the log message through
* PLUGIN_HANDLED or higher to stop the log message * PLUGIN_HANDLED or higher to stop the log message
@ -687,40 +687,34 @@ native read_datatype();
/** /**
* Retrieves current log message. * Retrieves current log message.
* *
* @note Can only be used inside of the plugin_log() forward. * @note Should only be used inside of the plugin_log() forward.
* *
* @param output Buffer to copy log message to * @param output Buffer to copy log message to
* @param len Maximum buffer size * @param len Maximum buffer size
* *
* @return Number of cells written to buffer * @return Number of cells written to buffer
* @error If called outside of the plugin_log() forward, an error is
* thrown.
*/ */
native read_logdata(output[], len); native read_logdata(output[], len);
/** /**
* Returns number of log message arguments. * Returns number of log message arguments.
* *
* @note Can only be used inside of the plugin_log() forward. * @note Should only be used inside of the plugin_log() forward.
* *
* @return Number of arguments in the log message * @return Number of arguments in the log message
* @error If called outside of the plugin_log() forward, an error is
* thrown.
*/ */
native read_logargc(); native read_logargc();
/** /**
* Retrieves argument of log message. * Retrieves argument of log message.
* *
* @note Can only be used inside of the plugin_log() forward. * @note Should only be used inside of the plugin_log() forward.
* *
* @param id Argument index, starting from 0 * @param id Argument index, starting from 0
* @param output Buffer to copy log argument to * @param output Buffer to copy log argument to
* @param len Maximum buffer size * @param len Maximum buffer size
* *
* @return Number of cells written to buffer * @return Number of cells written to buffer
* @error If called outside of the plugin_log() forward, an error is
* thrown.
*/ */
native read_logargv(id, output[], len); native read_logargv(id, output[], len);
@ -871,7 +865,6 @@ native get_amxx_verstring(buffer[], length);
* @error If the client index is not within the range of 1 to * @error If the client index is not within the range of 1 to
* MaxClients an error will be thrown. * MaxClients an error will be thrown.
*/ */
native get_user_attacker(index, ...); native get_user_attacker(index, ...);
/** /**

2
plugins/include/amxmodx_version.inc
View File

@ -8,7 +8,7 @@
// https://alliedmods.net/amxmodx-license // https://alliedmods.net/amxmodx-license
#if defined _amxmodx_version_included #if defined _amxmodx_version_included
#endinput #endinput
#endif #endif
#define _amxmodx_version_included #define _amxmodx_version_included

2
plugins/include/celltrie.inc
View File

@ -8,7 +8,7 @@
// https://alliedmods.net/amxmodx-license // https://alliedmods.net/amxmodx-license
#if defined _celltrie_included #if defined _celltrie_included
#endinput #endinput
#endif #endif
#define _celltrie_included #define _celltrie_included

4
plugins/include/core.inc
View File

@ -6,7 +6,7 @@
*/ */
#if defined _core_included #if defined _core_included
#endinput #endinput
#endif #endif
#define _core_included #define _core_included
@ -198,5 +198,5 @@ native tickcount(&granularity = 0);
*/ */
stock abs(x) stock abs(x)
{ {
return x > 0 ? x : -x; return x > 0 ? x : -x;
} }

10
plugins/include/csstats.inc
View File

@ -8,7 +8,7 @@
// https://alliedmods.net/amxmodx-license // https://alliedmods.net/amxmodx-license
#if defined _csstats_included #if defined _csstats_included
#endinput #endinput
#endif #endif
#define _csstats_included #define _csstats_included
@ -75,7 +75,9 @@ native get_user_wrstats(index, wpnindex, stats[8], bodyhits[8]);
* server. * server.
* *
* @note The permanent storage is updated on every respawn or client disconnect. * @note The permanent storage is updated on every respawn or client disconnect.
* @note Player rank is determined by the difference of kills to deaths. * @note Player rank is determined by the customizable "get_score" function in
* "data/csstats.amxx". By default it uses the difference of kills to
* deaths/teamkills.
* @note For a list of possible body hitplaces see the HIT_* constants in * @note For a list of possible body hitplaces see the HIT_* constants in
* amxconst.inc * amxconst.inc
* @note The fields in the statistics are: * @note The fields in the statistics are:
@ -199,7 +201,9 @@ native reset_user_wstats(index);
* incremental access. * incremental access.
* *
* @note The permanent storage is updated on every respawn or client disconnect. * @note The permanent storage is updated on every respawn or client disconnect.
* @note Player rank is determined by the difference of kills to deaths. * @note Player rank is determined by the customizable "get_score" function in
* "data/csstats.amxx". By default it uses the difference of kills to
* deaths/teamkills.
* @note For a list of possible body hitplaces see the HIT_* constants in * @note For a list of possible body hitplaces see the HIT_* constants in
* amxconst.inc * amxconst.inc
* @note The fields in the statistics are: * @note The fields in the statistics are:

80
plugins/include/cstrike.inc
View File

@ -12,7 +12,7 @@
// //
#if defined _cstrike_included #if defined _cstrike_included
#endinput #endinput
#endif #endif
#define _cstrike_included #define _cstrike_included
@ -36,18 +36,18 @@
*/ */
enum CsInternalModel enum CsInternalModel
{ {
CS_DONTCHANGE = 0, CS_DONTCHANGE = 0,
CS_CT_URBAN = 1, CS_CT_URBAN = 1,
CS_T_TERROR = 2, CS_T_TERROR = 2,
CS_T_LEET = 3, CS_T_LEET = 3,
CS_T_ARCTIC = 4, CS_T_ARCTIC = 4,
CS_CT_GSG9 = 5, CS_CT_GSG9 = 5,
CS_CT_GIGN = 6, CS_CT_GIGN = 6,
CS_CT_SAS = 7, CS_CT_SAS = 7,
CS_T_GUERILLA = 8, CS_T_GUERILLA = 8,
CS_CT_VIP = 9, CS_CT_VIP = 9,
CZ_T_MILITIA = 10, CZ_T_MILITIA = 10,
CZ_CT_SPETSNAZ = 11, CZ_CT_SPETSNAZ = 11,
}; };
/** /**
@ -55,10 +55,10 @@ enum CsInternalModel
*/ */
enum CsTeams enum CsTeams
{ {
CS_TEAM_UNASSIGNED = 0, CS_TEAM_UNASSIGNED = 0,
CS_TEAM_T = 1, CS_TEAM_T = 1,
CS_TEAM_CT = 2, CS_TEAM_CT = 2,
CS_TEAM_SPECTATOR = 3, CS_TEAM_SPECTATOR = 3,
}; };
/** /**
@ -70,9 +70,9 @@ enum CsTeams
*/ */
enum CsArmorType enum CsArmorType
{ {
CS_ARMOR_NONE = 0, // no armor CS_ARMOR_NONE = 0, // no armor
CS_ARMOR_KEVLAR = 1, // body vest only CS_ARMOR_KEVLAR = 1, // body vest only
CS_ARMOR_VESTHELM = 2, // vest and helmet CS_ARMOR_VESTHELM = 2, // vest and helmet
}; };
/** /**
@ -89,11 +89,11 @@ enum CsArmorType
*/ */
enum enum
{ {
CS_RESET_ZOOM = 0, // Reset any zoom blocking (mode has no effect) CS_RESET_ZOOM = 0, // Reset any zoom blocking (mode has no effect)
CS_SET_NO_ZOOM, // Disable any sort of zoom CS_SET_NO_ZOOM, // Disable any sort of zoom
CS_SET_FIRST_ZOOM, // Set first zoom level (AWP style) CS_SET_FIRST_ZOOM, // Set first zoom level (AWP style)
CS_SET_SECOND_ZOOM, // Set second zoom level (AWP style) CS_SET_SECOND_ZOOM, // Set second zoom level (AWP style)
CS_SET_AUGSG552_ZOOM, // Set AUG/SG552 zoom style CS_SET_AUGSG552_ZOOM, // Set AUG/SG552 zoom style
}; };
/** /**
@ -246,19 +246,19 @@ native cs_get_user_bpammo(index, weapon);
* amxconst.inc * amxconst.inc
* @note Some weapons share ammo types and therefore ammo backpack pools. List * @note Some weapons share ammo types and therefore ammo backpack pools. List
* of ammo types: * of ammo types:
* awp - ammo_338magnum * ammo_338magnum - awp
* scout, ak47, g3sg1 - ammo_762nato * ammo_762nato - scout, ak47, g3sg1
* m249 - ammo_556natobox * ammo_556natobox - m249
* famas, m4a1, aug, sg550, galil, sg552 - ammo_556nato * ammo_556nato - famas, m4a1, aug, sg550, galil, sg552
* m3, xm1014 - ammo_buckshot * ammo_buckshot - m3, xm1014
* usp, ump45, mac10 - ammo_45acp * ammo_45acp - usp, ump45, mac10
* fiveseven, p90 - ammo_57mm * ammo_57mm - fiveseven, p90
* deagle - ammo_50ae * ammo_50ae - deagle
* p228 - ammo_357sig * ammo_357sig - p228
* glock, mp5, tmp, elites - ammo_9mm * ammo_9mm - glock, mp5, tmp, elites
* hegrenade - / * / - hegrenade
* flashbang - / * / - flashbang
* smokegrenade - / * / - smokegrenade
* *
* @param index Client index * @param index Client index
* @param weapon Weapon id * @param weapon Weapon id
@ -1061,7 +1061,7 @@ native cs_set_c4_explode_time(index, Float:value);
/** /**
* Returns if the bomb is being defused. * Returns if the bomb is being defused.
* *
* @param index C4 entity * @param c4index C4 entity
* *
* @return 1 if the bomb is being defused, 0 otherwise * @return 1 if the bomb is being defused, 0 otherwise
* @error If the provided entity index is not a bomb, an error will be * @error If the provided entity index is not a bomb, an error will be
@ -1072,7 +1072,7 @@ native bool:cs_get_c4_defusing(c4index);
/** /**
* Sets if the bomb is being defused. * Sets if the bomb is being defused.
* *
* @param index C4 entity * @param c4index C4 entity
* @param defusing True if the bomb should be defused, false otherwise * @param defusing True if the bomb should be defused, false otherwise
* *
* @noreturn * @noreturn

16
plugins/include/csx.inc
View File

@ -12,7 +12,7 @@
// //
#if defined _csx_included #if defined _csx_included
#endinput #endinput
#endif #endif
#define _csx_included #define _csx_included
@ -32,10 +32,10 @@
*/ */
enum MapObjective enum MapObjective
{ {
MapObjective_Bomb = (1<<0), MapObjective_Bomb = (1<<0),
MapObjective_Hostage = (1<<1), MapObjective_Hostage = (1<<1),
MapObjective_Vip = (1<<2), MapObjective_Vip = (1<<2),
MapObjective_Escape = (1<<3), MapObjective_Escape = (1<<3),
}; };
/** /**
@ -154,7 +154,7 @@ forward bomb_defused(defuser);
native custom_weapon_add(const wpnname[], melee = 0, const logname[] = ""); native custom_weapon_add(const wpnname[], melee = 0, const logname[] = "");
/** /**
* Trigger a damage event on a custom weapon, adding it to the internal stats. * Triggers a damage event on a custom weapon, adding it to the internal stats.
* *
* @note This will also call the client_damage() and client_kill() forwards if * @note This will also call the client_damage() and client_kill() forwards if
* applicable. * applicable.
@ -175,7 +175,7 @@ native custom_weapon_add(const wpnname[], melee = 0, const logname[] = "");
native custom_weapon_dmg(weapon, att, vic, damage, hitplace = 0); native custom_weapon_dmg(weapon, att, vic, damage, hitplace = 0);
/** /**
* Add a shot event on a custom weapon to the internal stats. * Adds a shot event on a custom weapon to the internal stats.
* *
* @param weapon Custom weapon id * @param weapon Custom weapon id
* @param index Client index * @param index Client index
@ -184,7 +184,7 @@ native custom_weapon_dmg(weapon, att, vic, damage, hitplace = 0);
* @error If the weapon id is not a custom weapon or an invalid client * @error If the weapon id is not a custom weapon or an invalid client
* index is provided, an error will be thrown. * index is provided, an error will be thrown.
*/ */
native custom_weapon_shot(weapon, index); // weapon id , player id native custom_weapon_shot(weapon, index);
/** /**
* Returns if the weapon is considered a melee weapon. * Returns if the weapon is considered a melee weapon.

8
plugins/include/cvars.inc
View File

@ -8,7 +8,7 @@
// https://alliedmods.net/amxmodx-license // https://alliedmods.net/amxmodx-license
#if defined _cvars_included #if defined _cvars_included
#endinput #endinput
#endif #endif
#define _cvars_included #define _cvars_included
@ -32,8 +32,8 @@
*/ */
enum CvarBounds enum CvarBounds
{ {
CvarBound_Upper = 0, CvarBound_Upper = 0,
CvarBound_Lower CvarBound_Lower
}; };
/** /**
@ -156,7 +156,7 @@ native disable_cvar_hook(cvarhook:handle);
native enable_cvar_hook(cvarhook:handle); native enable_cvar_hook(cvarhook:handle);
/** /**
* Returns a flags of a cvar. The cvar is accessed by name. * Returns flags of a cvar. The cvar is accessed by name.
* *
* @note For a list of possible flags see the FCVAR_* constants in amxconst.inc * @note For a list of possible flags see the FCVAR_* constants in amxconst.inc
* @note Accessing a Cvar by name is slower than direct pointer access, which is * @note Accessing a Cvar by name is slower than direct pointer access, which is

5
plugins/include/datapack.inc
View File

@ -8,7 +8,7 @@
// https://alliedmods.net/amxmodx-license // https://alliedmods.net/amxmodx-license
#if defined _datapack_included #if defined _datapack_included
#endinput #endinput
#endif #endif
#define _datapack_included #define _datapack_included
@ -24,10 +24,9 @@
* Failing to free handles will result in the plugin and AMXX leaking * Failing to free handles will result in the plugin and AMXX leaking
* memory. * memory.
*/ */
enum DataPack enum DataPack
{ {
Invalid_DataPack = 0 Invalid_DataPack = 0
}; };
/** /**