Skip to content

Commit

Permalink
formatted, fixed line endings
Browse files Browse the repository at this point in the history
  • Loading branch information
Southclaws committed Oct 2, 2018
1 parent 034d052 commit ad38071
Show file tree
Hide file tree
Showing 9 changed files with 28 additions and 15 deletions.
27 changes: 20 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,46 @@
# samp-stdlib

The San Andreas Multiplayer Pawn Standard Library Package - designed for the [sampctl package management system](http://sampctl.com).
The San Andreas Multiplayer Pawn Standard Library Package - designed for the
[sampctl package management system](http://sampctl.com).

The current latest version is **0.3.7-R2-2-1**.

The master branch HEAD does not currently contain any RC libaries.

## Why?

The package management system built into the `sampctl` tool is based on GitHub (Simiar to that of the Go language) so it simplifies the process to have the standard library stored here on GitHub too. This means there doesn't need to be any special-case code written for the standard library, it can just be a package like all others.
The package management system built into the `sampctl` tool is based on GitHub
(Simiar to that of the Go language) so it simplifies the process to have the
standard library stored here on GitHub too. This means there doesn't need to be
any special-case code written for the standard library, it can just be a package
like all others.

## How Do Versions Work?

### Versions are represented by [Git Tags](https://help.github.com/articles/working-with-tags/)

Always specify a version when working with sampctl. To depend on the latest version, simply use `sampctl/samp-stdlib:0.3.7-R2-2-1` as a dependency.
Always specify a version when working with sampctl. To depend on the latest
version, simply use `sampctl/samp-stdlib:0.3.7-R2-2-1` as a dependency.

### What happens during Release Candidates (RCs)?

The `master` branch will contain RC libraries if there is an active RC. The most recent RC was 0.3.8, but since this was cancelled, this repository contains no 0.3.8 RC libraries.
The `master` branch will contain RC libraries if there is an active RC. The most
recent RC was 0.3.8, but since this was cancelled, this repository contains no
0.3.8 RC libraries.

### Version tags are fully compatible with [sampctl](https://github.com/Southclaws/sampctl/wiki/Dependencies#versioning)

[sampctl](http://bit.ly/sampctl) simplifies version control, this repository exists to help sampctl users who work with multiple SA:MP server versions.
[sampctl](http://bit.ly/sampctl) simplifies version control, this repository
exists to help sampctl users who work with multiple SA:MP server versions.

### Versioning starts at 0.3z (specifically, 0.3z-R1)

0.3z is the earliest version supported by [sampctl](http://bit.ly/sampctl). Most servers use the latest version so it didn't seem worth archiving every SA:MP library version.
0.3z is the earliest version supported by [sampctl](http://bit.ly/sampctl). Most
servers use the latest version so it didn't seem worth archiving every SA:MP
library version.

### Some tags point to the same commit

Some releases only changed the server's internals and never touched the libraries. In these cases, the version tags still exist in this repo but they simply point to the same commit.
Some releases only changed the server's internals and never touched the
libraries. In these cases, the version tags still exist in this repo but they
simply point to the same commit.
2 changes: 1 addition & 1 deletion a_actor.inc
Original file line number Diff line number Diff line change
Expand Up @@ -221,4 +221,4 @@ native IsActorInvulnerable(actorid);
/// <param name="actorid">The ID of the actor to check</param>
/// <remarks>This function was added in <b>SA-MP 0.3.7</b> and will not work in earlier versions!</remarks>
/// <returns><b><c>1</c></b> if the actor is valid, <b><c>0</c></b> if not.</returns>
native IsValidActor(actorid);
native IsValidActor(actorid);
2 changes: 1 addition & 1 deletion a_http.inc
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,4 @@
/// </remarks>
native HTTP(index, type, const url[], const data[], const callback[]);
// example HTTP callback: public MyHttpResponse(index, response_code, data[]) { ... }
// example HTTP callback: public MyHttpResponse(index, response_code, data[]) { ... }
2 changes: 1 addition & 1 deletion a_npc.inc
Original file line number Diff line number Diff line change
Expand Up @@ -527,4 +527,4 @@ forward OnVehicleStreamOut(vehicleid);
/// <remarks>This NPC callback was added in <b>SA-MP 0.3a</b> and will not work in earlier versions!</remarks>
forward OnRecordingPlaybackEnd();
// --------------------------------------------------
// --------------------------------------------------
2 changes: 1 addition & 1 deletion a_objects.inc
Original file line number Diff line number Diff line change
Expand Up @@ -632,4 +632,4 @@ native SetPlayerObjectMaterialText(playerid, objectid, const text[], materialind
/// <remarks>This function was added in <b>SA-MP 0.3.7</b> and will not work in earlier versions!</remarks>
/// <remarks>This function only affects the camera collision of objects created AFTER its use - it does not toggle existing objects' camera collisions.</remarks>
/// <remarks>This only works outside the map boundaries (past <b><c>-3000</c></b>/<b><c>3000</c></b> units on the x and/or y axis).</remarks>
native SetObjectsDefaultCameraCol(disable);
native SetObjectsDefaultCameraCol(disable);
2 changes: 1 addition & 1 deletion a_players.inc
Original file line number Diff line number Diff line change
Expand Up @@ -2426,4 +2426,4 @@ native CancelSelectTextDraw(playerid); // cancel textdraw selection with the mou
/// <remarks>This function was added in <b>SA-MP 0.3z R2-2</b> and will not work in earlier versions!</remarks>
/// <remarks>There is a limit as to how many explosions can be seen at once by a player. This is roughly 10.</remarks>
/// <returns>This function always returns <b><c>1</c></b>, even if the function failed to excute (player doesn't exist, invalid radius, or invalid explosion type).</returns>
native CreateExplosionForPlayer(playerid, Float:X, Float:Y, Float:Z, type, Float:Radius);
native CreateExplosionForPlayer(playerid, Float:X, Float:Y, Float:Z, type, Float:Radius);
2 changes: 1 addition & 1 deletion a_samp.inc
Original file line number Diff line number Diff line change
Expand Up @@ -3028,4 +3028,4 @@ forward OnPlayerSelectObject(playerid, type, objectid, modelid, Float:fX, Float:
/// </returns>
forward OnPlayerWeaponShot(playerid, weaponid, hittype, hitid, Float:fX, Float:fY, Float:fZ);
// --------------------------------------------------
// --------------------------------------------------
2 changes: 1 addition & 1 deletion a_sampdb.inc
Original file line number Diff line number Diff line change
Expand Up @@ -127,4 +127,4 @@ native db_get_mem_handle(DB:db);
native db_get_result_mem_handle(DBResult:result);
native db_debug_openfiles();
native db_debug_openresults();
native db_debug_openresults();
2 changes: 1 addition & 1 deletion a_vehicles.inc
Original file line number Diff line number Diff line change
Expand Up @@ -729,4 +729,4 @@ native SetVehicleVirtualWorld(vehicleid, worldid);
/// <seealso name="SetVehicleVirtualWorld"/>
/// <seealso name="GetPlayerVirtualWorld"/>
/// <returns>The virtual world that the vehicle is in.</returns>
native GetVehicleVirtualWorld(vehicleid);
native GetVehicleVirtualWorld(vehicleid);

0 comments on commit ad38071

Please sign in to comment.