fixes.inc

Community patches for buggy SA:MP functions.

Introduction

SA:MP is beta software written by a small team in their spare time, thus it has bugs (as does all software). Some of these have been known for a long time but are low priority due to their minor effects, others go undiscovered for a long time. Many of these bugs have solutions which can be implemented in PAWN (and this may be simpler than implementing them in the SA:MP source code). This include aims to collect fixes for as many of these bugs as possible from the community (i.e. anyone who has a fix) together in to one easy to use place for everyone's benefit.

Use

To use this, simply include it after the default SA:MP functions, but before third party includes:

#include <a_samp> 
// Any default re-definitions should go here. 
//#undef MAX_PLAYERS 
//#define MAX_PLAYERS 10 
#include <fixes> 
#include <other> 

To disable any fix for whatever reason simply do:

#define FIX_<name> 0

For example, to disable all the file.inc fixes if you always correctly check the file handle, do:

#include <a_samp> 
#define FIX_file_inc 0 
#include <fixes> 
#include <other> 

All the names of the fixes are single words, and are all listed with their fix descriptions below.

If you only have one script running on your server (i.e. no FilterScripts), you can use this define to improve the fixes.inc code:

#include <a_samp> 
#define FIXES_Single 1 
#include <fixes> 
#include <other> 

Fixes

Name	Problem	Solution	Author(s)	Post(s)	Notes
GetPlayerColor	Returns "0" if "SetPlayerColor" has never been called.	Call "SetPlayerColor" in "OnPlayerConnect".	KoczkaHUN
FILTERSCRIPT	Despite the fact that is in every new script, many people dont' define "FILTERSCRIPT" where appropriate.	Provide an "IS_FILTERSCRIPT" variable (note the naming to match the original macro).	Y_Less
SpawnPlayer	Kills the player if they are in a vehicle.	Remove player from the vehicle.	Y_Less
SetPlayerName	Using "SetPlayerName" when the new name only differs from the old name in case does not alter the name at all.	Change their name twice - once to "_FIXES TEMP NAME" and then to the actual required name.	Y_Less Slice simonepri
GetPlayerSkin	Returns the new skin after "SetSpawnInfo" is called but before the player actually respawns to get the new skin.	Record the skin in "OnPlayerSpawn" and always return that one.	Y_Less
GetWeaponName	Returns nothing for 18, 44, and 45.	Return the correct names (Molotov Cocktail, Thermal Goggles, and Night vision Goggles).	Y_Less		Fixed in 0.3.7
SetPlayerWorldBounds	Aiming can bypass the edge.	Check for the player leaving the area and reset them to their last good position if they leave the area (aiming or not).	Y_Less
TogglePlayerControllable	Other players see you moving on the spot.	Return 0 in OnPlayerUpdate.	Slice	Link
HydraSniper	Entering military aircraft with a sniper rifle messes up views.	Set their armed weapon to fists.	funky1234	Link
IsPlayerInCheckpoint	Function returns an undefined value if it is called before any other checkpoint functions are called to initialise the value.	Call "DisablePlayerCheckpoint" when they connect.	Y_Less
IsPlayerInRaceCheckpoint	Function returns an undefined value if it is called before any other race checkpoint functions are called to initialise the value.	Call "DisablePlayerRaceCheckpoint" when they connect.	Y_Less
GetPlayerWeapon	Returns the old value after entering in a vehicle.	If "SetPlayerArmedWeapon" and other similar functions is called in a vehicle, store the new value and return that instead.	Y_Less ronixtey
PutPlayerInVehicle	If this is used on a passenger the driver of their old vehicle doesn't see them in their new vehicle.	Remove them from the vehicle first.	leong124 Y_Less	Link
KEY_AIM	"KEY_AIM" isn't defined by default.	Define it.	Y_Less
SetPlayerCheckpoint	If a checkpoint is already set it will use the size of that checkpoint instead of the new one.	Call "DisablePlayerCheckpoint" before setting the checkpoint.	ziggi
SetPlayerRaceCheckpoint	If a checkpoint is already set it will use the size of that checkpoint instead of the new one.	Call "DisablePlayerRaceCheckpoint" before setting the checkpoint.	ziggi
TextDrawCreate	Crashes on a blank string.	Intercept blank strings.	wups
TextDrawCreate_2	If the last character in the text is a space (" "), the text will all be blank.	Remove space characters from the end of the string.	ziggi	Link
TextDrawSetString	Crashes on a blank string and size greater than 1024.	Intercept blank strings and truncate long strings.	TomTrox
TextDrawSetString_2	If the last character in the text is a space (" "), the text will all be blank.	Remove space characters from the end of the string.	ziggi	Link
CreatePlayerTextDraw	Crashes on a blank string.	Intercept blank strings.	wups Y_Less
CreatePlayerTextDraw_2	If the last character in the text is a space (" "), the text will all be blank.	Remove space characters from the end of the string.	ziggi	Link
PlayerTextDrawSetString	Crashes on a blank string and size greater than 1024.	Intercept blank strings and truncate long strings.	TomTrox Y_Less
PlayerTextDrawSetString_2	If the last character in the text is a space (" "), the text will all be blank.	Remove space characters from the end of the string.	ziggi	Link
AllowInteriorWeapons	Does nothing.	Set the player's weapon to fists in an interior.	KoczkaHUN
OnPlayerEnterVehicle	Crashes other players when people enter an invalid seat.	Desync the people with invalid seats.	RyDeR` Y_Less	Link
OnPlayerEnterVehicle_2	Crashes the server when hacks enter an invalid vehicle.	Desync the people with invalid vehicles.	im Y_Less
OnPlayerEnterVehicle_3	No player animation when trying to enter the driver door of a locked vehicle	Leave the door unlocked and activate an animation when the player attemps to enter a 'locked' vehicle.	ziggi rt-2	Link
AllowTeleport	0.3dRC9 removed "AllowPlayerTeleport" and "AllowAdminTeleport" in favour of "OnPlayerClickMap". Some scripts used the old code and.	Teleport the player in "OnPlayerClickMap".	Y_Less
SetPlayerSpecialAction	Removing jetpacks from players by setting their special action to 0 causes the sound to stay until death.	Call "ClearAnimations" before "SetPlayerSpecialAction".	MP2
OnDialogResponse	Cheaters can spoof the dialogid they are using to respond to ones they can't actually see.	Store the displayed dialogid and use that instead.	Y_Less		Fixed in 0.3e RC6
GetPlayerDialog	This function doesn't exist. Fixed for hidden dialogs.	Add it.	Y_Less simonepri		Disabled By Default
PlayerDialogResponse	A player's dialog doesn't hide when the gamemode restarts, causing the server to print "Warning: PlayerDialogResponse PlayerId: 0 dialog ID doesn't match last sent dialog ID".	Hide it.	simonepri
SetSpawnInfo	Kicks the player if "SpawnPlayer" is called before "SetSpawnInfo".	Call "SetSpawnInfo" at least once.	Y_Less
SetPlayerSkin	Breaks sitting on bikes.	Put them back in the vehicle after setting their skin.	CyNiC	Link
HideMenuForPlayer	Crashes when passed an invalid menu ID.	Don't hide it when passed an invalid menu.	Y_Less	Link
valstr	Crashes on large numbers.	Use "format" instead.	Slice
fclose	Crashes on an invalid handle.	Check for an invalid handle.	Slice
fwrite	Crashes on an invalid handle.	Check for an invalid handle.	Slice
fread	Crashes on an invalid handle.	Check for an invalid handle.	Slice
fputchar	Crashes on an invalid handle.	Check for an invalid handle.	Slice
fgetchar	Crashes on an invalid handle.	Check for an invalid handle.	Slice
fblockwrite	Crashes on an invalid handle.	Check for an invalid handle.	Slice
fblockread	Crashes on an invalid handle.	Check for an invalid handle.	Slice
fseek	Crashes on an invalid handle.	Check for an invalid handle.	Slice
flength	Crashes on an invalid handle.	Check for an invalid handle.	Slice
file_inc	Includes or excludes all the file function fixes together (can cause major overhead).	Optionally group them all under one define.	Y_Less		Disabled By Default
SetPlayerAttachedObject	Doesn't remove objects when the mode ends.	Remove them.	Y_Less
OnPlayerDeath	Clients get stuck when they die with an animation applied.	Clear their animations.	h02	Link
strins	Ignores the "maxlength" parameter causing possible crashes.	Manually check the length.	Slice Y_Less
IsPlayerConnected	Only uses the lower two bytes of a passed ID.	Mask the numbers.	Slice
TrainExit	When getting out of a train entered by "PutPlayerInVehicle", the camera does not reset properly.	Reset the camera.	Terminator3 Y_Less
Kick	Calling "Kick" in "OnPlayerConnect" doesn't work properly.	Defer it.	Y_Less	Link	Fixed in 0.3x
OnVehicleMod	Crashes other players when invalid mods are applied.	Desync the player.	JernejL Y_Less	Link
random	Doesn't work with negative numbers.	Invert then reinvert.	simonepri		Disabled By Default
sleep	Leaks bytes from the stack.	Call a function to store the correct value.	Y_Less
AddMenuItem	Crashes when passed an invalid menu ID.	Don't hide it when passed an invalid menu.	Y_Less
SetMenuColumnHeader	Crashes when passed an invalid menu ID.	Don't hide it when passed an invalid menu.	Y_Less
ShowMenuForPlayer	Crashes when passed an invalid menu ID.	Don't hide it when passed an invalid menu.	Y_Less
HideMenuForPlayer	Crashes when passed an invalid menu ID.	Don't hide it when passed an invalid menu.	Y_Less	Link
HideMenuForPlayer_2	Ignores the "menuid" parameter.	Only hide the correct menu.	Y_Less		Disabled By Default
DisableMenu	Crashes when passed an invalid menu ID.	Don't hide it when passed an invalid menu.	Y_Less
DisableMenuRow	Crashes when passed an invalid menu ID.	Don't hide it when passed an invalid menu.	Y_Less
Menus	All menu function fixes are included separately for major overhead.	Optionally group them all under one define.	Y_Less
GetPlayerMenu	Returns previous menu when none is displayed.	Return the correct value.	Y_Less
GetPlayerInterior	Always returns 0 for NPCs.	Return the correct value.	Y_Less simonepri
ClearAnimations	Use ClearAnimation while you are in a vehicle cause the player exit from it.	Apply an animation instead of clear animation.	simonepri
ClearAnimations_2	ClearAnimations doesn't do anything when the animation ends if we pass 1 for the freeze parameter in ApplyAnimation.	Apply an idle animation for stop and then use ClearAnimation.	simonepri
DriveBy	If you press KEY_CROUCH while you're passenger and if you are armed, the player start to aim; if you repress KEY_CROUCH the player don't return in vehicle.	Apply the animation to return the player in the vehicle.	simonepri
SilentTeleport	If a vehicle teleports either by SetVehiclePos or enters an original samp interior if someone tries to enter it he will teleport silently along.	Using 'ClearAnimation' to stop the player before the teleport happens.	RogueDrifter	Link
GangZoneCreate	Gang zones bug on the main map for players at certain angles relative to them.	Set a non floating value for the gang zone co-ordinate.	simonepri Y_Less
SPECIAL_ACTION_PISSING	"SPECIAL_ACTION_PISSING" isn't defined by default.	Define it.	simonepri
IsValidVehicle	"IsValidVehicle" isn't defined by default.	Define it.	simonepri
ApplyAnimation	Passing an invalid animation library in ApplyAnimation causes a client crash for streamed in players.	Block ApplyAnimation when an invalid library is passed.	simonepri
ApplyAnimation_2	First time a library is used, it does nothing.	Apply animations twice when first using a library.	simonepri Lordzy Y_Less
ApplyActorAnimation	Passing an invalid animation library in ApplyAnimation causes a client crash for streamed in players.	Block ApplyActorAnimation when an invalid library is passed.	simonepri ziggi
ApplyActorAnimation_2	First time a library is used, it does nothing.	Apply animations twice when first using a library.	simonepri Lordzy Y_Less ziggi
OnPlayerSpawn	San Andreas deducts $100 from players.	Give them it back.	Y_Less
GetGravity	"GetGravity" isn't defined by default.	Define it.	Whitetiger	Link
gpci	"gpci" isn't defined by default.	Define it.	simonepri	Link
Natives	Several natives are included by default, this enables or disables them all. Therefore this is an umbrella fix for several fixes.	Define them.	Y_Less
OnPlayerConnect	This function isn't called for players when a filterscript starts.	Call it for all connected players.	Y_Less
OnPlayerDisconnect	This function isn't called for players when a filterscript ends.	Call it for all connected players.	Y_Less
GameText	Several styles do not display for the time specified.	Recreate the styles in Text Draws and use those instead.	Y_Less
GameTextStyles	San Andreas has fixed styles for area and vehicle names, but they are not included in the GameText styles list.	Add them.	Y_Less		Disabled By Default
HideGameText	There is no "HideGameTextForXYZ" function.	Show a single space for a game text.	Y_Less
ClearPlayerWorldBounds	There is no "ClearPlayerWorldBounds" function.	Put the world bounds back to the default.	Y_Less
GetPlayerWorldBounds	There is no "GetPlayerWorldBounds" function.	Store them and retrieve them.	Y_Less
WEAPONS	Some weapons are not defined by default.	Define it.	ziggi
BODYPARTS	The bodyparts to be used in OnPlayer(Take/Give)Damage are not defined by default	Define it.	Whitetiger
CAMERAMODES	The camera modes for GetPlayerCameraMode are not defined by default.	Define it.	Whitetiger	Link
SetPlayerCamera	Using the camera functions directly after enabling spectator mode doesn't work.	Defer them.	Emmet_
SetPlayerTime	Using this function under "OnPlayerConnect" doesn't work.	Defer it.	Emmet_
OnPlayerRequestClass	Random blunts and bottles sometimes appear in class selection.	Call "RemoveBuildingForPlayer".	Y_Less
SetPlayerColor	If used under OnPlayerConnect, the affecting player will not see the color in the TAB menu.	Defer it.	Emmet_	Link
FileMaths	You can write gibberish like "File:a; ++a;".	Remove the operators.	Y_Less
GetPlayerWeaponData	Old weapons with no ammo left are still returned.	Set "weapons" to 0.	Y_Less	Link
strcmp	Return 0 if anyone of the string is empty.	Add a check for empty string.	Y_Less
GetPVarString	Wrong symbol code for symbols with code 128 and above.	Use logical conjunction on symbol and 0xFF.	ziggi Mutha_X Daniel_Cortez	Link Link
GetSVarString	Wrong symbol code for symbols with code 128 and above.	Use logical conjunction on symbol and 0xFF.	ziggi Mutha_X Daniel_Cortez	Link Link
toupper	Not working on Linux for symbols with code 128 and above.	Recreate the function.	ziggi	Link
tolower	Not working on Linux for symbols with code 128 and above.	Recreate the function.	ziggi	Link
PassengerSeating	Teleporting player to passenger seat after delay.	Call ClearAnimation after some delay.	ziggi
GogglesSync	Visual effects show for all players.	return 0 in OnPlayerUpdate after key pressed.	ziggi
GetPlayerPoolSize	Returns "0" even if there are no players on the server.	Return "-1" if PlayerPoolsize is 0 but Player 0 is not connected.	Bios-Marcel
SetPlayerPos	Using this function on skydiving players kills them.	Remove the parachute when the player is skydiving.	Freaksken
GetPlayerAmmo	Returns erroneous values over 32767 and under -32768 due to overflow.	Prevent setting or adding ammo above 32767 and setting or removing ammo below 0.	Freaksken
JIT	Can't easily determine if the script is JIT compiled.	Provide "IS_JIT" to the script for tests.	Y_Less
OS	Can't easily determine what OS the script is running on.	Provide "IS_WINDOWS" and "IS_LINUX" to the script for tests.	Y_Less
const	Some SA-MP natives don't use "const" when they could.	Redefine the natives.	Y_Less
VEHICLES	The vehicle models IDs are not defined by default.	Define them.	stuntman
GetPlayerWeather	This function doesn't exist.	Add it.	IstuntmanI ziggi		Disabled By Default
GetWeather	This function doesn't exist.	Add it.	IstuntmanI ziggi		Disabled By Default
GetWorldTime	This function doesn't exist.	Add it.	ziggi		Disabled By Default
GetServerVarAsString	Crashes on unknown string variables.	Read the file manually.	Y_Less	Link
GetServerVarAsInt	Crashes on unknown int variables.	Read the file manually.	Y_Less	Link
GetServerVarAsBool	Crashes on unknown boolean variables.	Read the file manually.	Y_Less	Link
GetServerVarAsFloat	Doesn't even exist.	Read the file manually.	Y_Less	Link
tabsize	Some people still use tabsize 0.	Break the pragma.	Y_Less	Link
OnRconCommand	Is not called in the gamemode unless first called in a filterscript.	Load a minimal (embedded) FS to bootstrap it.	Y_Less
OnClientCheckResponse	Is not called in the gamemode ever.	Load a minimal (embedded) FS to bootstrap it.	Y_Less

Options

There are a few options for improved execution of this script. Define these symbols as 1 before you include fixes.inc (remove them or set them to 0 to disable them):

• FIXES_Single: You only have one script running (no filterscripts), simplify the code.
• FIXES_SilentKick: When a player is kicked for illegal mods/vehicles, don't send them a message.
• FIXES_Debug: Additional information in the server console.

A few fixes are disabled by default, to enable them all do:

#define GetPlayerDialog 1 
#define file_inc 1 
#define random 1 
#define HideMenuForPlayer_2 1 
#define GameTextStyles 1 
#define GetPlayerWeather 1 
#define GetWeather 1 
#define GetWorldTime 1 

Or more simply (and future-proof-ly):

#define FIXES_EnableAll 
#define FIXES_EnableDeprecated 

Expansion

The file is fairly well documented, with a list of the currently (hopefully) fixed bugs at the top. If you know of others, or have solutions for others, it would be greatly appreciated if you could post them as issues on this repository. The fixes also need extensive testing to find bugs in the fixes themselves.

Again, this is a community project, merely managed by Y_Less and others - if anyone has comments, contributions, criticisms etc. please again post them as issues on the repository. This includes additions to source code, documentation, presentation, translations (mainly of this documentation - multiple versions of the include should be avoided to reduce fragmentation), or any other related area you can think of.

Other Fixes

There are a few other includes which aim to fix issues too large to be included here:

• Timerfix - udan11 (Dan..) 's fixes to make "SetTimer" and "SetTimerEx" vastly more accurate in their delays.
• SQLitei - Slice 's fixes and improvements for many SQLite functions.

Bugs

Originally Posted by Y_Less :

[This] is beta software written by a small team in their spare time, thus it has bugs (as does all software). This software is explicitly designed to solve bugs, not cause them, but there may still be bugs.

The most likely cause of bugs is certain combinations of disabled fixes. Some fixes are inter-mixed and while they SHOULD work when the fixes they are combined with are disabled, not every combination has been tested. There are literally billions of possible combinations - if you find one that doesn't compile or work, please tell us.

Style Rules

• All globals should be static stock whenever possible (so they can only be accessed from this one file).
• Statics must start with FIXES_gs, and all other globals with FIXES_g.
• All functions not overriding existing functions must start with FIXES_.
• Macros must be upper case, use underscores, and start FIXES_: FIXES_LIKE_THIS.
• Functions should be upper camel case (as the original functions are) FIXES_LikeThis.
• Globals (after the prefix) should be upper camel case LikeThis, and locals lower camel case likeThis.
• ALS should be used to hook functions and callbacks. See this topic for more details: http://forum.sa-mp.com/showthread.php?t=570910
• The ALS prefix for chaining is FIXES_.
• When redefining a native, add a BAD_ external name declaration with the _ALS_ definition so that others may use the original native if they so desire (with the caveat that it may break all fixes). Note the BAD_ name is meant to indicate the possibility of breaking the fix, not a comment on the original native function.
• The ALS hook defines used here are a little different to the normal ones as this file assumes that it is always first. The pattern is:

#if defined _ALS_NameOfFixHere 
     #error _ALS_NameOfFixHere defined 
#endif 
native BAD_NameOfFixHere(params) = NameOfFixHere; 

#if FIX_NameOfFixHere 
     stock FIXES_NameOfFixHere(params) 
     { 
         return 0; 
     } 

     #define _ALS_NameOfFixHere 
     #define NameOfFixHere( FIXES_NameOfFixHere( 
#endif 

A copyable version of this pattern is at the end of the file.

• Enums start with E_ or e_ depending on type, then follow rules for macros.
• NO libraries should be included - not even the default SA:MP ones. Let the user do it.
• Due to the above rule, you cannot assume any third party libraries AT ALL, so do not use them. This can lead to some code duplication, but also means that the version of the code used here can be tailored for optimisations.
• Certain terms may be shortened when dealing with long callback names to avoid compile truncation warnings (max symbol length is 31). Current list:
• Checkpoint: CP
• Update : Upd
• TextDraw : TD
• Object : Obj
• Player : P
• Document all fixes at the top of the file, and highlight code.
• 4 space TABS - do not edit this file in PAWNO unless you know how to correct the indentation.
• All rules have exceptions, but they must be justifiable. For example IS_FILTERSCRIPT is a global variable, but is not called FIXES_gIsFilterscript to better match the FILTERSCRIPT macro it replaces. Now a macro for _FIXES_gIsFilterscript.
• Variables which need to be fully global (i.e. not static), but should not actually be used by other people (e.g. appear inside a macro) should be prefixed with _FIXES instead of FIXES to indicate their private use.
• No comments beyond the end of column 80 (where the line in PAWNO is).
• If a bug is fixed in some version of the server it can be conditionally included here. This is done by checking for the existance of a native function introduced in the same server version. For example TogglePlayerControllable was fixed in 0.3eRC6, the same time as the SetObjectMaterial native was introduced, thus the inclusion becomes:

#if !defined FIX_TogglePlayerControllable 
     #if defined SetObjectMaterial 
         #define FIX_TogglePlayerControllable (0) 
     #else 
         #define FIX_TogglePlayerControllable (1) 
     #endif 
#elseif _FIXES_IS_UNSET(FIX_TogglePlayerControllable) 
     #undef FIX_TogglePlayerControllable 
     #define FIX_TogglePlayerControllable (2) 
#endif 

This only includes this fix if that native doesn't exist. A copyable version of this pattern is at the end of the file.

• To reduce general memory consumption, strings in this include are stored globally in constant arrays and referenced. This is EXACTLY as fast as using the string constants directly, but means that strings are not stored in the assembly multiple times (unless the string is only used once, in which case it's more work for no gain). See this post for more details: http://forum.sa-mp.com/showpost.php?p=1795601
• DO NOT EDIT THIS FILE IN PAWNO OR ON GITHUB. Both mess up the spacing - GitHub in an almost irreversible way (except for the fact that nothing is irreversible in source control. Pawno spacing is less tricky to solve, and can be worked around if you know when it uses spaces and tabs - in short, always write code first THEN indent and you won't have a problem (in that editor at least, that is normally a bad way to write code).

Documentation Explanation

The fixes.inc code itself now contains all of the documentation in its header, formatted using the compiler's natively supported pawn-doc, plus some custom XSL. Previously README.md and the header had to be kept in sync manually. Now you can just compile a script with -r and get a large amount of XML documentation, including all of this header in a <library></library> pair. The repository comes with a file called markdown.xsl that, when saved as pawno/xml/pawndoc.xsl, will transform that XML to markdown to keep README.md fully up-to-data almost automatically.

The descriptions of the fixes all look like:

<fix name="Short Name" disabled="true" fixed="Optional server version of official fix where applicable"> 
     <problem> 
     Description of problem. 
         </problem> 
     <solution> 
         Description of solution. 
     </solution> 
     <see>Relevant functions.</see> 
     <author href="Optional address of their profile">Person who wrote the fix</author> 
     <post href="Optional link to the original post where applicable." /> 
</fix> 

Thanks

A huge thanks to all the community members that have reported and fixed bugs, this include would not be anywhere near the level of quality it is right now without all of you. Fix writers are all listed above by their contributions. Fix reporters can be seen by browsing the github issues. A special thanks also to @ziggi for hosting this repo for a long time.