Useful Functions
From SA-MP Wiki
Useful Functions (uf.inc)
Here you can find useful functions for your pawno scripts. They are mostly copied from an older version of the useful functions topic on the SA-MP Forums, these can all be implemented with the Useful Functions include file.
AddStaticPickup2
Description:
Allows the saving of models, types and pickup positions, it is essential for OnPlayerPickupItem
Parameters:(model, type, Float:X, Float:Y, Float:Z)
| model | The modelid of the pickup to spawn |
| type | The typeid of the pickup to spawn |
| Float:X | The x value of the spawn position |
| Float:Y | The y value of the spawn position |
| Float:Z | The z value of the spawn position |
AddStaticPickup2(50,2,29.5,36.5,49.8);
By: Sacky
AddStaticVehicle2
Description:
Enables saving of vehicleclasses to a script (Alot of vehicle functions rely on this)
Parameters:(modelid, Float:spawn_x, Float:spawn_y, Float:spawn_z, Float:z_angle, color1, color2)
| modelid | The modelid of the vehicle to spawn |
| Float:spawn_x | The x value of the spawn position |
| Float:spawn_y | The y value of the spawn position |
| Float:spawn_z | The z value of the spawn position |
| Float:z_angle | The angle value of the spawn position |
| color1 | The first colour of the vehicle |
| color1 | The second colour of the vehicle |
AddStaticVehicle2(50,2.6,29.5,36.5,49.8,6,7);
By: Sacky
AddStaticVehicleEx2
Description:
Allows the saving of models to the AddStaticVehicleEx function, for people who prefer this function to AddStaticVehicle
Parameters:(modelid, Float:spawn_x, Float:spawn_y, Float:spawn_z, Float:z_angle, color1, color2,respawn_delay)
| modelid | The modelid of the vehicle to spawn |
| Float:spawn_x | The x value of the spawn position |
| Float:spawn_y | The y value of the spawn position |
| Float:spawn_z | The z value of the spawn position |
| Float:z_angle | The angle value of the spawn position |
| color1 | The first colour of the vehicle |
| color1 | The second colour of the vehicle |
| respawn_delay | The amount of time in miliseconds the vehicle will wait before respawning when it dies |
AddStaticVehicleEx2(50,2.6,29.5,36.5,49.8,6,7,7000);
By: Sacky
AddStaticVehicleLine
Description:
Makes a line of vehicle's
Parameters:(Modelid, Float:Start[2], Float:Rate[2], Float:Z, Float:Z_Angle, MaxAmount)
| Modelid | The modelid of the vehicles to spawn |
| Float:Start[2] | The x value of the starting position |
| Float:Rate[2] | The y value of the starting position |
| Float:Z | The z value of the starting position |
| Float:Z_Angle | The angle value of the spawn position for the cars in the line |
| MaxAmount | The amount of cars in the line |
AddStaticVehicleLine(50,2.6,3.8,7.4,270.0,5);
By: Sacky
BanTeam
Description:
Bans all the players in an entire team
Parameters:(team)
| team | The teamid to ban |
BanTeam(1);
By: dyraXon
ConvertSeconds
Description:
Converts an integer of seconds into a string that will display hours,minutes and seconds
Parameters:(time)
| time | The amount of seconds as an integer |
Return Values:
The converted amount of seconds into hours, minutes, and seconds (Displays like: x hours, x minutes and x seconds
ConvertSeconds(12000);
By: El Presy
DegreesToRadians
Description:
Converts degree's to radians
Parameters:(Float:degrees)
| Float:degrees | The degree you want to convert |
Return Values:
The conversion of the degree to a radian
DegreesToRadians(270);
By: Sacky
encrypt
Description:
This function allows you to encrypt strings, very useful for storing passwords without fear of someone cracking them
Parameters:(string[])
| string[] | The string you want to encrypt |
Return Values:
The encrypted string
encrypt("User Password");
Note: This function requires you to set a unique key to use with it. This is so no-one elses use of the function generates the same hashes as you. This key must contain ALL the letters and digits you want to make valid in a password or it will produce wierd results. They don't have to be listed only once but must be listed at least once, in any random order. The location of the key is clearly documented within the function. Don't change your key or no-one will be able to log in.
There is also a PHP version here.
By: Y_Less
floatrand
Description:
Generates a random number with 2 decimal places
Parameters:(Float:min, Float:max)
| Float:min | The minimum the random float can be |
| Float:max | The maximum the random float can be |
Return Values:
The random float between the minimum and maximum values
floatrand(1.2,5.6);
By: Y_Less
GameTextCheck
Description:
Returns 1 if the text won't crash your server, 0 if it will
Parameters:(string[])
| string[] | The string to be checked |
Return Values:
The 1 if the text is ok, 0 if it isn't
GameTextCheck("Hello World");
By: Kamazy
GameTextForTeam
Description:
Sends GameText to all the players in the specified team, the same as GameTextForPlayer except you can specify the team
Parameters:(team, text[], time, style)
| team | The team you want the message sent to |
| text[] | The text to be sent |
| time | The time for the text to remain on the screen |
| style | The style of the text |
GameTextForTeam(1,"Hello",1000,3);
By: Y_Less
GetClosestCar
Description:
Returns the ID of the closest car
Parameters:(playerid)
| playerid | The first playerid to parse into the function |
Return Values:
The closest vehicle to the player
GetClosestCar(1);
By: Darkrealm
GetClosestPlayer
Description:
Returns the ID of the closest player
Parameters:(playerid)
| playerid | The first playerid to parse into the function |
Return Values:
The closest player to the specified player
GetClosestPlayer(1);
By: Slick
GetCurrentPosition
Description:
Returns the current position as a string
Parameters:(playerid)
| playerid | The playerid to get the position from |
Return Values:
The current position in string format
GetCurrentPosition(1);
By: Sacky
GetDistanceBetweenPlayers
Description:
Returns the distance between players as an integer
 Important | This function is no longer useable |
(playerid,playerid2)
| playerid | The first playerid to parse into the function |
| playerid2 | The second playerid to parse into the function |
Return Values:
The distance between the players in meters as an integer
GetDistanceBetweenPlayers(1,2);
By: Slick
GetDistanceToCar
Description:
Returns the distance between the player and the car as an integer (Note: This doesnt fully work properly due to the GetVehiclePos not working properly, instead it will give you the distance to the car spawn)
Parameters:(playerid,carid)
| playerid | The player to parse |
| carid | The vehicleid to parse |
Return Values:
The distance between the player and the vehicle
GetDistanceToCar(1,2);
By: Darkrealm
GetPickups
Description:
Returns the number of pickups on the server
Return Values:
The number of pickups present on the server
GetPickups();
By: Sacky
GetPlayerAcceleration
Description:
Returns the player accelaration in MPH as an integer, it requires the uftimer to be implemented in the gamemode
Parameters:(playerid)
| playerid | The player you want to get the speed from |
Return Values:
The acceleration of the player
GetPlayerAcceleration(5);
By: Sacky
GetPlayerDistanceToPoint
Description:
Returns the player distance to a 2D point
Parameters:(playerid,Float:x,Float:y)
| playerid | The player you wish to query |
| Float:x | The x value of the point |
| Float:y | The y value of the point |
Return Values:
The distance to the point
GetPlayerDistanceToPoint(1,1.9,8.5);
By: Sacky
GetPlayerDistanceToPointEx
Description:
Returns the player distance to a 3D point
Parameters:(playerid, Float:x, Float:y, Float:z)
| playerid | The player you wish to query |
| Float:x | The x value of the point |
| Float:y | The y value of the point |
| Float:z | The z value of the point |
Return Values:
The distance to the point
GetPlayerDistanceToPoint(1,1.9,8.5,9.5);
By: Sacky
GetPlayerId
Description:
Returns the player ID from a playername
Parameters:(playername[])
| playername[] | The name you want to get the playerid from |
Return Values:
The playerid (if none then returns -1)
GetPlayerId("Y_Less");
By: Y_Less
GetPlayers
Description:
Returns the number of players on the server
Return Values:
The number of players on the server
GetPlayers();
By: rapidZ
GetPlayerSkin
Description:
Returns the class of the players skin
Parameters:(playerid)
| playerid | The player you want to get the skin from |
Return Values:
The skin id (0 if invalid)
GetPlayerSkin(5);
By: Sacky
GetPlayerSpeed
Description:
Returns the player speed in KMPH as a float, it requires the uftimer to be implemented in the gamemode
Parameters:(playerid)
| playerid | The player you want to get the speed from |
Return Values:
The speed of the player
GetPlayerSpeed(5);
By: Sacky
GetPointDistanceToPoint
Description:
Returns the distance between 1 x and y value and another x and y value
Parameters:(Float:x,Float:y,Float:x2,Float:y2)
| Float:x | The x value of the first point |
| Float:y | The y value of the first point |
| Float:x2 | The x value of the second point |
| Float:y2 | The y value of the second point |
Return Values:
The distance between the 2 points
GetPointDistanceToPoint(12.3,14.5,109.7,88.9);
By: iRaiDeN
GetPointDistanceToPointEx
Description:
Returns the distance between 1 x,y and z value and another x,y and z value
Parameters:(Float:x,Float:y,Float:z,Float:x2,Float:y2,Float:z2)
| Float:x | The x value of the first point |
| Float:y | The y value of the first point |
| Float:z | The z value of the first point |
| Float:x2 | The x value of the second point |
| Float:y2 | The y value of the second point |
| Float:z2 | The z value of the first point |
Return Values:
The distance between the 2 points
GetPointDistanceToPointEx(12.3,14.5,15.6,109.7,88.9,13.4);
By: Sacky
GetVehicleClass
Description:
Returns the Vehicleclass/modelid (Needs AddStaticVehicle2 or AddStaticVehicleEx2)
Parameters:(vehicleid)
| vehicleid | The id of the vehicle to return the class from |
Return Values:
The vehicle class (0 if invalid vehicle)
GetVehicleClass(1);
By: Sacky
GetVehicleName
Description:
Returns the name of a vehicle (Needs AddStaticVehicle2 or AddStaticVehicle2Ex)
Parameters:(vehicleid)
| vehicleid | The id of the vehicle to return the class from |
Return Values:
The name of a vehicle (by class)
GetVehicleName(1);
By: Sacky
GetVehicleType
Description:
Returns the type of a vehicle (Needs AddStaticVehicle2 or AddStaticVehicle2Ex)
Parameters:(vehicleid)
| vehicleid | The id of the vehicle to return the type from |
Return Values:
The type of a vehicle (eg. CAR or BOAT)
GetVehicleType(1);
By: Sacky
GetVehicleZAngle
Description:
Returns the vehicles angle
Parameters:(vehicleid)
| vehicleid | The id of the vehicle to return the angle from |
Return Values:
The angle of the vehicle
GetVehicleZAngle(1);
By: Sacky
GetVehicles
Description:
Returns the number of vehicles on the server
Return Values:
The number of vehicles present on the server
GetVehicles();
By: Sacky
GivePlayerWeaponAlt
Description:
A version of GivePlayerWeapon, that displays an alert for weapon classes that cannot be given to players for some reason, then defaults to giving "Unarmed"
Parameters:(playerid, weaponid, ammo)
| playerid | The playerid to give the weapon to |
| weaponid | The weaponid you want to give to the player |
| ammo | How much ammo to give to the player |
GivePlayerWeaponAlt(1,26,500);
By: Allan
GivePlayerWeaponEx
Description:
Lets you specify an unlimited number of weapons and ammo to be given to a player
Parameters:( playerid, ... )
| playerid | The playerid to give the weapon to |
| ... | The weaponid you want to give to the player, also specify the ammo |
GivePlayerWeaponEx(1,25,400,26,400);
By: Peter
GiveTeamMoney
Description:
Gives every payer on a team a certain amount of money
Parameters:(team, amount)
| team | The team to give the money to |
| amount | The amount of money to give to the team |
GiveTeamMoney(1,500);
By: Hellomy
HexToRGBA
Description:
Converts Hexidecimal into RGBA
Parameters:(colour, &r, &g, &b, &a)
| colour | The hexidecimal colour |
| &r | The red colour to store |
| &g | The green colour to store |
| &b | The blue colour to store |
| &a | The alpha colour to store |
HexToRGBA(0xAFAFAFAA,r,g,b,a);
By: Betamaster
icos
Description:
Inverse Trigonomic Function (cosine)
Parameters:(Float:adj,Float:hyp)
| Float:adj | The length of the adjacent side |
| Float:hyp | The length of the hypotenuse side |
Return Values:
The processed inverse trigonomic equation (Float)
icos(5.3,4.6);
By: Sacky
isin
Description:
Inverse Trigonomic Function (sine)
Parameters:(Float:opp,Float:hyp)
| Float:opp | The length of the opposite side |
| Float:hyp | The length of the hypotenuse side |
Return Values:
The processed inverse trigonomic equation (Float)
isin(5.3,4.6);
By: Sacky
IsNumeric
Description:
Returns 1 if the string is numeric, 0 if not
Parameters:(string[])
| string[] | The string you want to check |
Return Values:
1 if numeric, 0 if not numeric
IsNumeric("12");
By: Mike
IsPickupConnected
Description:
Returns 1 if the pickup is connected and 0 if it isn't, it requires you to use AddStaticPickup2 rather than AddStaticPickup
Parameters:(pickupid)
| pickupid | The pickup id you want to query |
Return Values:
1 if it is connected, 0 if it isn't
IsPickupConnected(254);
By: Sacky
IsPlayerInAnyInterior
Description:
Returns the 1 if they are, returns 0 if they arent (There are some interiors which escape this function, it will work on about 95% of interiors)
Parameters:(playerid)
| playerid | The playerid you want to query |
Return Values:
1 if they are in an interior, 0 if they aren't
IsPlayerInAnyInterior(5);
By: Sacky
IsPlayerInArea
Description:
Returns 1 if the player is in the area and 0 if they aren't
Parameters:(playerid, Float:minx, Float:maxx, Float:miny, Float:maxy)
| playerid | The playerid you want to query |
| Float:minx | The minimum x value for the area |
| Float:miny | The minimum y value for the area |
| Float:maxx | The maximum x value for the area |
| Float:maxy | The maximum y value for the area |
Return Values:
1 if they are in the area, 0 if they aren't
IsPlayerInArea(2, 2.0, 2.0, 4.0, 4.0);
By: Y_Less
IsPlayerInAreaEx
Description:
Returns 1 if the player is in the area and 0 if they aren't
Parameters:(playerid, ...)
| playerid | The playerid you want to query |
| ... | The x and y values for your area |
Return Values:
1 if they are in the area, 0 if they aren't
IsPlayerInArea(2, 2.0, 2.0, 4.0, 4.0);
By: kool
IsPlayerInBoat
Description:
Returns the 1 if they are, returns 0 if they arent
Parameters:(playerid)
| playerid | The playerid you want to query |
Return Values:
1 if they are in a boat, 0 if they aren't
IsPlayerInBoat(5);
By: Sacky
IsPlayerInCar
Description:
Returns the 1 if they are, returns 0 if they arent
Parameters:(playerid)
| playerid | The playerid you want to query |
Return Values:
1 if they are in a car, 0 if they aren't
IsPlayerInCar(5);
By: Sacky
IsPlayerInCircle
Description:
Returns 1 if the player is in the circle and 0 if they aren't
Parameters:(playerid, Float:x, Float:y, radius)
| playerid | The playerid you want to query |
| Float:x | The x value of the center of the circle |
| Float:y | The y value of the center of the circle |
| radius | The radius of the circle |
Return Values:
1 if they are in the area, 0 if they aren't
IsPlayerInCircle(2,13.9,14.8,5);
By: Sacky
IsPlayerInCube
Description:
Returns 1 if the player is in the cube and 0 if they aren't
Parameters:(playerid, xmin, ymin, zmin, xmax, ymax, zmax)
| playerid | The playerid you want to query |
| xmin | The minimum x value of the cube |
| ymin | The minimum y value of the cube |
| zmin | The minimum z value of the cube |
| xmax | The maximum x value of the cube |
| ymax | The maximum y value of the cube |
| zmax | The maximum z value of the cube |
Return Values:
1 if they are in the area, 0 if they aren't
IsPlayerInCube(2,2,3,4,1,2,3);
By: 50p
IsPlayerInHelicopter
Description:
Returns the 1 if they are, returns 0 if they arent
Parameters:(playerid)
| playerid | The playerid you want to query |
Return Values:
1 if they are in a helicopter, 0 if they aren't
IsPlayerInHelicopter(5);
By: Sacky
IsPlayerInMonsterTruck
Description:
Returns the 1 if they are, returns 0 if they arent
Parameters:(playerid)
| playerid | The playerid you want to query |
Return Values:
1 if they are in a monster truck, 0 if they aren't
IsPlayerInMonsterTruck(5);
By: Sacky
IsPlayerInPlane
Description:
Returns the 1 if they are, returns 0 if they arent
Parameters:(playerid)
| playerid | The playerid you want to query |
Return Values:
1 if they are in a plane, 0 if they aren't
IsPlayerInPlane(5);
By: Sacky
IsPlayerInSphere
Description:
Returns 1 if the player is in the sphere and 0 if they aren't
Parameters:(playerid, Float:x, Float:y, Float:z, radius)
| playerid | The playerid you want to query |
| Float:x | The x value of the center of the sphere |
| Float:y | The y value of the center of the sphere |
| Float:z | The z value of the center of the sphere |
| radius | The radius of the circle |
Return Values:
1 if they are in the spherer, 0 if they aren't
IsPlayerInCircle(2,13.9,14.8,5,9.7);
By: Sacky
IsPlayerInQuad
Description:
Returns the 1 if they are, returns 0 if they arent
Parameters:(playerid)
| playerid | The playerid you want to query |
Return Values:
1 if they are in a quad, 0 if they aren't
IsPlayerInQuad(5);
By: Sacky
IsPlayerInRange
Description:
Returns 1 if if they are, 0 if they aren't
Parameters:(playerid, Float: Range, Float: Z_Range, Float:tar_x, Float:tar_y, Float:tar_z)
| playerid | The playerid you want to query |
| Float:Range | The range the player can be in |
| Float:Z_Range | The height range the player can be in |
| Float:tar_x | The x value for the point |
| Float:tar_y | The y value for the point |
| Float:tar_z | The z value for the point |
Return Values:
1 if they are in the range, 0 if they aren't
IsPlayerInRange(2, 2.0, 2.0, 4.0, 4.0, 4.0);
By: Simon
IsPlayerDriver
Description:
Returns the 1 if they are, returns 0 if they arent
Parameters:(playerid)
| playerid | The playerid you want to query |
Return Values:
1 if they are a driver, 0 if they aren't
IsPlayerDriver(5);
By: Sacky
IsPlayerOnBicycle
Description:
Returns the 1 if they are, returns 0 if they arent (Needs AddStaticVehicle2 or AddStaticVehicle2Ex)
Parameters:(playerid)
| playerid | The playerid you want to query |
Return Values:
1 if they are on a bicycle, 0 if they aren't
IsPlayerOnBicycle(5);
By: Sacky
IsPlayerOnBike
Description:
Returns the 1 if they are, returns 0 if they arent (Needs AddStaticVehicle2 or AddStaticVehicle2Ex)
Parameters:(playerid)
| playerid | The playerid you want to query |
Return Values:
1 if they are on a bike, 0 if they aren't
IsPlayerOnBike(5);
By: Sacky
IsPlayerOnFoot
Description:
Returns the 1 if they are, returns 0 if they arent
Parameters:(playerid)
| playerid | The playerid you want to query |
Return Values:
1 if they are on foot, 0 if they aren't
IsPlayerOnFoot(5);
By: Sacky
IsPlayerPassenger
Description:
Returns the 1 if they are, returns 0 if they arent
Parameters:(playerid)
| playerid | The playerid you want to query |
Return Values:
1 if they are a passenger, 0 if they aren't
IsPlayerPassenger(5);
By: Sacky
IsTeamInArea
Description:
Returns 1 if the team is in the area and 0 if they aren't
Parameters:(team, Float:minx, Float:maxx, Float:miny, Float:maxy)
| team | The teamid you want to query |
| Float:minx | The minimum x value for the area |
| Float:miny | The minimum y value for the area |
| Float:maxx | The maximum x value for the area |
| Float:maxy | The maximum y value for the area |
Return Values:
1 if they are in the area, 0 if they aren't
IsTeamInArea(2, 2.0, 2.0, 4.0, 4.0);
By: dyraXon
IsVehicleConnected
Description:
Returns 1 if the vehicle is connected and 0 if it isn't
Parameters:(vehicleid)
| vehicleid | The vehicle's id you want to query |
Return Values:
1 if it is connected, 0 if it isn't
IsVehicleConnected(254);
By: Sacky
IsVehicleInUse
Description:
Returns 1 if the vehicle is in use and 0 if it isn't
Parameters:(vehicleid)
| vehicleid | The vehicle's id you want to query |
Return Values:
1 if it is in use, 0 if it isn't
IsVehicleInUse(254);
By: Sacky
itan
Description:
Inverse Trigonomic Function (tangent)
Parameters:(Float:opp,Float:adj)
| Float:opp | The length of the opposite side |
| Float:adj | The length of the adjacent side |
Return Values:
The processed inverse trigonomic equation (Float)
itan(5.3,4.6);
By: Sacky
KickTeam
Description:
Kicks all the players in an entire team
Parameters:(team)
| team | The teamid to kick |
KickTeam(1);
By: Sacky
left
Description:
Returns the first characters in the string, it will return how many you set in the len
Parameters:(source[], len)
| source[] | The string you want to take the left characters from |
| len | The number of characters from the left you want to return |
Return Values:
The number of characters from the left specified in the len
left("Hello",1);
By: Y_Less
lengthdir_x
Description:
Returns the position relative to the current position taking angle and distance as the arguments
Parameters:(Float:length,Float:angle)
| Float:length | How long the line is |
| Float:angle | The angle in which to draw the virtual line |
Return Values:
The length of the line
lengthdir_x(32.4,170.9);
By: Slick
lengthdir_y
Description:
Returns the position relative to the current position taking angle and distance as the arguments
Parameters:(Float:length,Float:angle)
| Float:length | How long the line is |
| Float:angle | The angle in which to draw the virtual line |
Return Values:
The length of the line
lengthdir_y(32.4,170.9);
By: Slick
minrand
Description:
Generates a random integer between the minimum and maximum numbers set
Parameters:(min, max)
| min | The minimum number the random integer can be |
| max | The maximum number the random integer can be |
Return Values:
The random number between the min and max as an integer
minrand(1,5);
By: Y_Less
mktime
Description:
Returns the unix-timestamp of a date/time, equivalent to PHP's one: mktime on php.net
Parameters:(hour,minute,second,day,month,year)
| hour | The hour integer to pass |
| minute | The minute integer to pass |
| second | The second integer to pass |
| day | The day integer to pass |
| month | The month integer to pass |
| year | The year integer to pass |
Return Values:
seconds since the beginning of unix time/timestamp
mktime(1,1,1,1,1,2005);
By: mabako
parsecommand
Description:
This function takes a command passed to OnPlayerCommandText and splits it into the command and the rest
Parameters:(cmdtext[], cmd[], text[], parcount)
| cmdtext[] | The whole text in the command |
| cmd[] | The actual command (all letters that aren't separated by a space) |
| text[] | The Text you want to find |
| parcount | The number of spaces there are |
Return Values:
Whether the text is valid
parsecommand("/test test","/test","test",1);
By: Y_Less
PlayerID
Description:
Returns the playerid by detecting players who have a part of a playername in them
Parameters:(partofname[])
| partofname[] | The part of the players name you want to get the ID from |
Return Values:
The Players ID (if valid)
PlayerID("NoV");
By: DracoBlue
PlayerPlaySoundEx
Description:
Plays a sound to a player exactly where the player is
Parameters:(playerid,soundid)
| playerid | The ID of the player you want to play the sound for |
| soundid | The ID of the sound you want to play |
PlayerPlaySoundEx(1,205);
By: Sacky
RadiansToDegrees
Description:
Converts radians to degree's
Parameters:(Float:radian)
| Float:radian | The radian you want to convert |
Return Values:
The conversion of the radian to a degree
RadiansToDegrees(0.26);
By: Sacky
ResetVehicleSpawnPos
Description:
Resets a vehicle's dynamic spawn position (proof of concept, recomend against using it)
Parameters:(vehicleid)
| vehicleid | The vehicleid of vehicle you want to reset |
ResetVehicleSpawnPos(250);
By: Sacky
RetStr
Description:
Returns a string representation of a number
Parameters:(num)
| num | The number you want to convert into a string |
Return Values:
The string representation of a number
RetStr(11);
By: Y_Less
ReturnPlayerName
Description:
Returns the playername from the playerid
Parameters:(playerid)
| playerid | The playerid you want to get the name from |
Return Values:
The playername as a string
ReturnPlayerName(0);
By: Y_Less
RGBAToHex
Description:
Converts RGBA into Hexidecimal
Parameters:(r, g, b, a)
| r | The red value of the colour |
| g | The green value of the colour |
| b | The blue value of the colour |
| a | The alpha value of the colour |
RGBAToHex(210,90,75,3);
By: Betamaster
right
Description:
Returns the last characters in the string, it will return how many you set in the len
Parameters:(source[], len)
| source[] | The string you want to take the right characters from |
| len | The number of characters from the right you want to return |
Return Values:
The number of characters from the right specified in the len
right("Hello",1);
By: Y_Less
SendClientMessageToAdmins
Description:
Sends a string to all the admins logged in RCON
Parameters:(colour, str[])
| colour | The colour you want the Client Message to be |
| str[] | The text to send them |
SendClientMessageToAdmins(0xAFAFAFAA,"Hello");
By: Mike
SendClientMessageToAllOthers
Description:
Lets you send a client message to all clients except the one you specify
Parameters:(playerid, color, message[])
| playerid | The playerid you don't want the client message to be sent to |
| color | The colour to send the message in |
| message[] | The message to send |
SendClientMessageToAllOthers(1,0xAFAFAFAA,"Hello");
By: yom
SendClientMessageToTeam
Description:
Sends a Client Message to a team, the same as SendClientMessage except you can specify the team
Parameters:(team, color, text[])
| team | The team you want to send the client message to |
| color | The color (in hexidecimal format) that you want to send the text in |
| text[] | The text to send the team |
SendClientMessageToTeam(1,0xAFAFAFAA,"Hello");
By: Y_Less
SendFormattedGameTextToPlayer
Description:
A simple, but effective GameTextToPlayer and format wrap
Parameters:(playerid, const msg[], time, style, define)
| playerid | The playerid you want to see the gametext |
| msg[] | The text you want the gametext to be |
| time | The amount of time the gametext should linger on the screen |
| style | The style to send the gametext in |
| define | The variable you want to put in |
SendFormattedGameTextToPlayer(1,"Hello",1000,3,24);
By: Allan
SendFormattedGameTextToAll
Description:
A simple, but effective GameTextToAll and format wrap
Parameters:(const msg[], time, style, define)
| msg[] | The text you want the gametext to be |
| time | The amount of time the gametext should linger on the screen |
| style | The style to send the gametext in |
| define | The variable you want to put in |
SendFormattedGameTextToAll("Hello",1000,3,24);
By: Allan
SetPlayerColourAlpha
Description:
Used to set a players alpha colour
Parameters:(playerid, alpha)
| playerid | The id of the player you want to set the alpha colour to |
| alpha | The alpha value to set for the player |
SetPlayerColourAlpha(1,500);
By: Betamaster
SetPlayerMoney
Description:
Lets you Set the player money to any amount rather than going through GivePlayerMoney and minusing to take money away
Parameters:(playerid, money)
| playerid | The id of the player you want to set the money to |
| money | The amount of money to set |
SetPlayerMoney(1,500);
By: DracoBlue
SetPlayerPosEx
Description:
Lets you set the angle and interior as well as the position
Parameters:(playerid,Float:X,Float:Y,Float:Z,Float:Ang,Int)
| playerid | The id of the player you want to set position |
| Float:X | The x value of the position |
| Float:Y | The y value of the position |
| Float:Z | The z value of the position |
| Float:Ang | The angle value of the position |
| Int | The interior id of the position |
SetPlayerPosEx(1,1.1,2.2,3.3,270.9,6);
By: Kamazy
SetTeamScore
Description:
Sets a players score to everyone on a team
Parameters:(team, score)
| team | The id of the team you'd like to set a score for |
| score | The score to set |
SetTeamScore(1,500);
By: Hellomy
SetTeamPos
Description:
Lets you set player positions to everyone on a team at once
Parameters:(team, x, y, z)
| team | The id of the team you'd like to set position |
| x | The x value of the position |
| y | The y value of the position |
| z | The z value of the position |
SetTeamPos(1,2,2,2);
By: dyraXon
SetVehicleRespawnPos
Description:
Lets you Set the vehicle respawn position (proof of concept, recomend against using it)
Parameters:(vehicleid,Float:x,Float:y,Float:z,Float:angle)
| vehicleid | The id of the vehicle to reset its spawn |
| Float:x | The x value for the spawn position |
| Float:y | The y value for the spawn position |
| Float:z | The z value for the spawn position |
| Float:angle | The angle value for the spawn position |
SetVehicleRespawnPos(1,500.5,500.5,10.5,270.0);
By: Sacky
str_replace
Description:
Replaces certain aspects in a string
Parameters:(search[], replace[], source[])
| search[] | The string to search for |
| replace[] | The strings to replace |
| source[] | The original string |
Return Values:
The string formatted by the replace
str_replace("o","1","Hello World");
By: Tratulla
strrest
Description:
Returns the rest of the string splitting it at the index
Parameters:(string[], index)
| string[] | The full string to be split |
| &index | The character to split the string at |
Return Values:
The split string
strrest("Hello World Today",0);
By: mabako
strtok
Description:
Returns the string split by the index
Parameters:(string[], &index)
| string[] | The full string to be split |
| &index | The character to split the string at |
Return Values:
The split string
strtok("Hello World",0);
By: Compuphase
TakePlayerMoney
Description:
The opposite to GivePlayerMoney, simply takes it away from the player
Parameters:(playerid, money)
| playerid | The ID of the player to take money from |
| money | The amount of money to take |
TakePlayerMoney(1,500);
By: Sacky
timeconvert_seconds
Description:
Takes an integer of seconds and then formats it so it will say "minutes:seconds", useful for countdowns
Parameters:(time)
| time | The number of seconds to convert |
Return Values:
The converted seconds in a minutes:seconds format
timeconvert_seconds(181);
By: Sacky
TwoWayRand
Description:
Will generate a random number taking negatives into account, for example if you put in 10 there would be 20 possible numbers (-10 - 10)
Parameters:(value)
| value | The value to randomise |
Return Values:
The randomised number in a negative integer
TwoWayRand(10);
By: Allan
ValidEmail
Description:
Checks to see whether an email is valid, by entering in a string that should be an email address to it
Parameters:(email[])
| email[] | The email as a string |
Return Values:
True if the email is valid, false if it isn't
ValidEmail("user1@hotmail.com");
By: DracoBlue
VehicleDriverID
Description:
Returns the playerid of the driver of the vehicle
Parameters:(vehicleid)
| vehicleid | The ID of the vehicle to get the driver from |
Return Values:
The playerid if someone is driving the vehicle, -1 if no one is driving it
VehicleDriverID(52);
By: DracoBlue
VehicleDriverName
Description:
Returns the name of a player driving the vehicle (vehicleid)
Parameters:(vehicleid)
| vehicleid | The ID of the vehicle to get the driver from |
Return Values:
The driver name of the vehicle
VehicleDriverName(52);
By: Sacky
QuadraticRootCalc
Description:
Provided that the conditions are met, this should generate solutions to quadratic equasions
Parameters:(Float:Xsq,Float:X,Float:num)
| Float:Xsq | The square root of x |
| Float:X | The value of X |
| Float:num | The number to use |
Return Values:
The Quadratic Root of the number
QuadraticRootCalc(52.2,16.2,78.9);
By: Allan
Wait
Description:
Makes the server wait a certain amount of time before processing the next request
Parameters:(time)
| time | The time in miliseconds for the server to wait |
Wait(1000);
wiper
Description:
Clears the players Chat Screen
Parameters:(playerid)
| playerid | The playerid's chat screen to wipe |
wiper(1);
By: Spectre
Dini (Dini.inc)
| This section is outdated. It may use methods or functions which no longer exist or which are deemed obsolete by the community. Caution is advised. |
Here you can find an easy way to store and save variables and strings into files. Dini was created by DracoBlue. Download here: dini 1.1.4.
dini_Exists
Description:
Checks whether a file exists
Parameters:(filename[])
| filename[] | The filename to check |
Return Values:
False if it doesn't exist and true if it does
dini_Exists("acertainfile.txt");
dini_Remove
Description:
Remove's a file
Parameters:(filename[])
| filename[] | The filename to remove |
Return Values:
True if it removes it, False if it doesn't
dini_Remove("acertainfile.txt");
dini_Create
Description:
Create's a file
Parameters:(filename[])
| filename[] | The filename to create |
Return Values:
True if it creates it, False if it doesn't
dini_Create("acertainfile.txt");
dini_Set
Description:
Puts a string in a file using another string to call as a reference
Parameters:(filename[],key[],value[])
| filename[] | The filename to open |
| key[] | The value to save in |
| value[] | The string to save |
Return Values:
True if it exists, False if it doesn't
dini_Set("acertainfile.txt","Servername","A SA:MP Server");
dini_IntSet
Description:
Puts an integer in a file using another string to call as a reference
Parameters:(filename[],key[],value)
| filename[] | The filename to open |
| key[] | The value to save in |
| value | The integer to save |
Return Values:
True if it exists, False if it doesn't
dini_Set("acertainfile.txt","Servermaxplayers",50);
dini_BoolSet
Description:
Puts a bool in a file using another string to call as a reference
Parameters:(filename[],key[],value)
| filename[] | The filename to open |
| key[] | The value to save in |
| value | The bool to save |
Return Values:
True if it exists, False if it doesn't
dini_BoolSet("acertainfile.txt","Serveractive",true);
dini_FloatSet
Description:
Puts a Float in a file using another string to call as a reference
Parameters:(filename[],key[],Float:value)
| filename[] | The filename to open |
| key[] | The value to save in |
| Float:value | The Float to save |
Return Values:
True if it exists, False if it doesn't
dini_FloatSet("acertainfile.txt","Xpos",2345.67);
