Skip to content

Fix broken links and remove comments not applicable to open.mp #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Y-Less merged 2 commits into from
May 10, 2023
Merged

Fix broken links and remove comments not applicable to open.mp #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2e9412a
Fix broken links
Zbyss May 10, 2023
6dac92c
Remove comments not applicable to open.mp
Zbyss May 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions core.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ native clamp(value, min = cellmin, max = cellmax);
/**
* <library>core</library>
* <summary>Get a specific property from the memory, the string is returned as a packed string!.</summary>
* <param name="id">The <a href="http://en.wikipedia.org/wiki/Virtual_machine">virtual machine</a> to
* <param name="id">The <a href="https://en.wikipedia.org/wiki/Virtual_machine">virtual machine</a> to
* use, you should keep this zero (optional=<b><c>0</c></b>)</param>
* <param name="name">The property's name, you should keep this "" (optional=<b><c>""</c></b>)</param>
* <param name="value">The property's unique ID, Use the hash-function to calculate it from a string
Expand Down Expand Up @@ -185,7 +185,7 @@ native setproperty(id = 0, const name[] = "", value = cellmin, const string[] =
/**
* <library>core</library>
* <summary>Delete an earlier set property (<a href="#setproperty">setproperty</a>).</summary>
* <param name="id">The <a href="http://en.wikipedia.org/wiki/Virtual_machine">virtual machine</a> to
* <param name="id">The <a href="https://en.wikipedia.org/wiki/Virtual_machine">virtual machine</a> to
* use. You should keep this as zero (optional=<b><c>0</c></b>)</param>
* <param name="name">The property's name, you should keep this blank (optional=<b><c>""</c></b>)</param>
* <param name="value">The property's unique ID. Use the hash-function to calculate it from a string
Expand All @@ -200,7 +200,7 @@ native deleteproperty(id = 0, const name[] = "", value = cellmin);
/**
* <library>core</library>
* <summary>Check if a property exist.</summary>
* <param name="id">The <a href="http://en.wikipedia.org/wiki/Virtual_machine">virtual machine</a> to
* <param name="id">The <a href="https://en.wikipedia.org/wiki/Virtual_machine">virtual machine</a> to
* use, you should keep this zero (optional=<b><c>0</c></b>)</param>
* <param name="name">The property's name, you should keep this (optional=<b><c>""</c></b>)</param>
* <param name="value">The property's unique ID. Use the hash-function to calculate it from a string
Expand Down
10 changes: 2 additions & 8 deletions omp_core.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -348,9 +348,6 @@ native Format(output[], len = sizeof (output), const format[], {Float, _}:...) =
* <param name="repeating">Whether the timer should repeat or not</param>
* <seealso name="SetTimerEx" />
* <seealso name="KillTimer" />
* <remarks>Timer intervals are not accurate (roughly 25% off). There's a fix available
* <a href="http://forum.sa-mp.com/showthread.php?t=289675">here</a>.
* </remarks>
* <remarks>Timer IDs are never used twice. You can use <a href="#KillTimer">KillTimer</a> on a timer
* ID and it won't matter if it's running or not. </remarks>
* <remarks>The function that should be called must be public. </remarks>
Expand All @@ -373,9 +370,6 @@ native SetTimer(const functionName[], interval, bool:repeating);
* <seealso name="KillTimer" />
* <seealso name="CallLocalFunction" />
* <seealso name="CallRemoteFunction" />
* <remarks>Timer intervals are not accurate (roughly 25% off). There's a fix available
* <a href="http://forum.sa-mp.com/showthread.php?t=289675">here</a>.
* </remarks>
* <remarks>Timer IDs are never used twice. You can use KillTimer() on a timer ID and it won't matter
* if it's running or not. </remarks>
* <remarks>The function that should be called must be public. </remarks>
Expand Down Expand Up @@ -536,7 +530,7 @@ native bool:SendPlayerMessageToAll(senderid, const format[], OPEN_MP_TAGS:...);
* <summary>Adds a death to the 'killfeed' on the right-hand side of the screen for all players.</summary>
* <param name="killer">The ID of the killer (can be <b><c>INVALID_PLAYER_ID</c></b>)</param>
* <param name="killee">The ID of the player that died</param>
* <param name="weapon">The <a href="http://wiki.sa-mp.com/wiki/Weapons">reason</a> (not always a weapon)
* <param name="weapon">The <a href="https://www.open.mp/docs/scripting/resources/weaponids">reason</a> (not always a weapon)
* for the victim's death. Special icons can also be used (<b><c>ICON_CONNECT</c></b> and <b><c>ICON_DISCONNECT</c></b>)</param>
* <seealso name="SendDeathMessageToPlayer" />
* <seealso name="OnPlayerDeath" />
Expand Down Expand Up @@ -998,7 +992,7 @@ native void:SetNameTagDrawDistance(Float:distance);
/**
* <library>omp_core</library>
* <summary>Set the world weather for all players.</summary>
* <param name="weatherid">The <a href="http://wiki.sa-mp.com/wiki/Weatherid">weather</a> to set</param>
* <param name="weatherid">The <a href="https://www.open.mp/docs/scripting/resources/weatherid">weather</a> to set</param>
* <seealso name="SetPlayerWeather" />
* <seealso name="SetGravity" />
* <remarks>If <a href="#TogglePlayerClock">TogglePlayerClock</a> is enabled, weather will slowly change
Expand Down
8 changes: 4 additions & 4 deletions omp_network.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -420,8 +420,8 @@ native NetStats_MessagesRecvPerSecond(playerid);
* 1.0% is outright bad.</remarks>
* <remarks>This function has been found to be currently unreliable the output is not as expected when
* compared to the client. Therefore this function should not be used as a packet loss kicker. </remarks>
* <remarks>A more accurate packetloss function can be found here: <a href="http://forum.sa-mp.com/showpost.php?p=2488911&amp;postcount=984">
* http://forum.sa-mp.com/showpost.php?p=2488911&amp;postcount=984</a></remarks>
* <remarks>A more accurate packetloss function can be found here: <a href="https://sampforum.blast.hk/showthread.php?tid=281&pid=2488911#pid2488911">
* https://sampforum.blast.hk/showthread.php?tid=281&pid=2488911#pid2488911</a></remarks>
* <returns>The percentage packet loss as a float. <b><c>0.0</c></b> if player not connected.</returns>
*/
native Float:NetStats_PacketLossPercent(playerid);
Expand Down Expand Up @@ -653,8 +653,8 @@ forward OnRconLoginAttempt(ip[], password[], success);

/**
* <summary>This callback is called when a player finishes downloading custom models. For more information
* on how to add custom models to your server, see <a href="http://forum.sa-mp.com/showthread.php?t=644105">the
* release thread</a> and <a href="http://forum.sa-mp.com/showthread.php?t=644123">this tutorial</a>.</summary>
* on how to add custom models to your server, see <a href="https://sampforum.blast.hk/showthread.php?tid=644105">the
* release thread</a> and <a href="https://sampforum.blast.hk/showthread.php?tid=644123">this tutorial</a>.</summary>
* <param name="playerid">The ID of the player that finished downloading custom models</param>
* <param name="virtualworld">The ID of the virtual world the player finished downloading custom models
* for</param>
Expand Down
42 changes: 21 additions & 21 deletions omp_player.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -442,7 +442,7 @@ native GetPlayerWantedLevel(playerid);
* <library>omp_player</library>
* <summary>Set a player's weather.</summary>
* <param name="playerid">The ID of the player whose weather to set</param>
* <param name="weather">The <a href="http://wiki.sa-mp.com/wiki/Weatherid">weather</a> to set</param>
* <param name="weather">The <a href="https://www.open.mp/docs/scripting/resources/weatherid">weather</a> to set</param>
* <seealso name="SetWeather" />
* <seealso name="SetGravity" />
* <remarks>If <a href="#TogglePlayerClock">TogglePlayerClock</a> is enabled, weather will slowly change
Expand Down Expand Up @@ -515,7 +515,7 @@ native bool:StopAudioStreamForPlayer(playerid);
/**
* <library>omp_player</library>
* <summary>Creates an explosion that is only visible to a single player. This can be used to isolate
* explosions from other players or to make them only appear in specific <a href="http://wiki.sa-mp.com/wiki/SetPlayerVirtualWorld">virtual
* explosions from other players or to make them only appear in specific <a href="https://www.open.mp/docs/scripting/functions/SetPlayerVirtualWorld">virtual
* worlds</a>.</summary>
* <param name="playerid">The ID of the player to create the explosion for</param>
* <param name="x">The x coordinate of the explosion</param>
Expand Down Expand Up @@ -844,9 +844,9 @@ native GetPlayerDrunkLevel(playerid);
/**
* <library>omp_player</library>
* <summary>Set a player's interior. A list of currently known interiors and their positions can be
* found <a href="http://wiki.sa-mp.com/wiki/Interiorids">here</a>.</summary>
* found <a href="https://www.open.mp/docs/scripting/resources/interiorids">here</a>.</summary>
* <param name="playerid">The ID of the player to set the interior of</param>
* <param name="interiorid">The <a href="http://wiki.sa-mp.com/wiki/Interiorids">interior ID</a> to
* <param name="interiorid">The <a href="https://www.open.mp/docs/scripting/resources/interiorids">interior ID</a> to
* set the player in</param>
* <seealso name="GetPlayerInterior" />
* <seealso name="LinkVehicleToInterior" />
Expand All @@ -862,7 +862,7 @@ native bool:SetPlayerInterior(playerid, interiorid);
* <library>omp_player</library>
* <summary>Set the skin of a player. A player's skin is their character model.</summary>
* <param name="playerid">The ID of the player to set the skin of</param>
* <param name="skinid">The <a href="http://wiki.sa-mp.com/wiki/Skins">skin</a> the player should use</param>
* <param name="skinid">The <a href="https://www.open.mp/docs/scripting/resources/skins">skin</a> the player should use</param>
* <seealso name="GetPlayerSkin" />
* <seealso name="SetSpawnInfo" />
* <remarks>If a player's skin is set when they are crouching, in a vehicle, or performing certain animations,
Expand Down Expand Up @@ -1053,7 +1053,7 @@ native Float:GetPlayerDistanceFromPoint(playerid, Float:x, Float:y, Float:z);
/**
* <library>omp_player</library>
* <summary>Retrieves the player's current interior. A list of currently known interiors with their
* positions can be found on <a href="http://wiki.sa-mp.com/wiki/Interiorids">this</a> page.</summary>
* positions can be found on <a href="https://www.open.mp/docs/scripting/resources/interiorids">this</a> page.</summary>
* <param name="playerid">The player to get the interior ID of</param>
* <seealso name="SetPlayerInterior" />
* <seealso name="GetPlayerVirtualWorld" />
Expand Down Expand Up @@ -1145,7 +1145,7 @@ native bool:GetPlayerFacingAngle(playerid, &Float:ang);
* <seealso name="OnPlayerClickMap" />
* <remarks>This function does not work if the new coordinates are far away from where the player currently
* is. The z height will be <b><c>0</c></b>, which will likely put them underground. It is highly
* recommended that the <a href="http://forum.sa-mp.com/showthread.php?t=275492">MapAndreas plugin</a>
* recommended that the <a href="https://github.com/philip1337/samp-plugin-mapandreas">MapAndreas plugin</a>
* be used instead.</remarks>
* <returns>
* <b><c>1</c></b>: The function executed successfully.<br />
Expand Down Expand Up @@ -1292,9 +1292,9 @@ native bool:ClearAnimations(playerid, FORCE_SYNC:forceSync = SYNC_NONE);

/**
* <library>omp_player</library>
* <summary>Retrieves a player's current <a href="http://wiki.sa-mp.com/wiki/SpecialActions">special
* <summary>Retrieves a player's current <a href="https://www.open.mp/docs/scripting/resources/specialactions">special
* action</a>.</summary>
* <param name="playerid">The ID of the player to get the <a href="http://wiki.sa-mp.com/wiki/SpecialActions">special
* <param name="playerid">The ID of the player to get the <a href="https://www.open.mp/docs/scripting/resources/specialactions">special
* action</a> of</param>
* <seealso name="SetPlayerSpecialAction" />
* <seealso name="GetPlayerState" />
Expand Down Expand Up @@ -1331,7 +1331,7 @@ native bool:ClearAnimations(playerid, FORCE_SYNC:forceSync = SYNC_NONE);
* animation with visible pee.</li>
* </ul>
* </remarks>
* <returns>The <a href="http://wiki.sa-mp.com/wiki/SpecialActions">special action</a> of the player.</returns>
* <returns>The <a href="https://www.open.mp/docs/scripting/resources/specialactions">special action</a> of the player.</returns>
*/
native SPECIAL_ACTION:GetPlayerSpecialAction(playerid);

Expand Down Expand Up @@ -1458,7 +1458,7 @@ native bool:GetGameText(playerid, style, message[], len = sizeof (message), time
* <param name="playerid">The ID of the player to send the death message to</param>
* <param name="killer">The ID of the killer (can be <b><c>INVALID_PLAYER_ID</c></b>)</param>
* <param name="killee">The ID of the player that died</param>
* <param name="weapon">The <a href="http://wiki.sa-mp.com/wiki/Weapons">reason</a> (not always a weapon)
* <param name="weapon">The <a href="https://www.open.mp/docs/scripting/resources/weaponids">reason</a> (not always a weapon)
* for the victim's death. Special icons can also be used (<b><c>ICON_CONNECT</c></b> and <b><c>ICON_DISCONNECT</c></b>)</param>
* <seealso name="SendDeathMessage" />
* <seealso name="OnPlayerDeath" />
Expand Down Expand Up @@ -1728,7 +1728,7 @@ native bool:TogglePlayerControllable(playerid, bool:controllable);
* <library>omp_player</library>
* <summary>Check which keys a player is pressing.</summary>
* <param name="playerid">The ID of the player to get the keys of</param>
* <param name="keys">Bitmask containing the player's key states. <a href="http://wiki.sa-mp.com/wiki/Keys">List
* <param name="keys">Bitmask containing the player's key states. <a href="https://www.open.mp/docs/scripting/resources/keys">List
* of keys</a></param>
* <param name="updown">Up/down state</param>
* <param name="leftright">Left/right state</param>
Expand Down Expand Up @@ -1955,7 +1955,7 @@ native ResetPlayerWeapons(playerid);
* <library>omp_player</library>
* <summary>Set the ammo of a player's weapon.</summary>
* <param name="playerid">The ID of the player to set the weapon ammo of</param>
* <param name="weaponid">The ID of the <a href="http://wiki.sa-mp.com/wiki/Weapons">weapon</a> to set
* <param name="weaponid">The ID of the <a href="https://www.open.mp/docs/scripting/resources/weaponids">weapon</a> to set
* the ammo of.</param>
* <param name="ammo">The amount of ammo to set</param>
* <seealso name="GetPlayerAmmo" />
Expand Down Expand Up @@ -2310,7 +2310,7 @@ native bool:PlayerSpectateVehicle(playerid, targetid, SPECTATE_MODE:mode = SPECT
* <seealso name="GetPlayerWeapon" />
* <seealso name="VectorSize" />
* <seealso name="OnPlayerWeaponShot" />
* <remarks>This function will only work when <a href="http://wiki.sa-mp.com/wiki/Lag_Compensation">lag
* <remarks>This function will only work when <a href="https://www.open.mp/docs/server/LagCompensation">lag
* compensation</a> is <b>enabled</b>. </remarks>
* <remarks>If the player hit nothing, the hit positions will be <b><c>0</c></b>. This means you can't
* currently calculate how far a bullet travels through open air. </remarks>
Expand Down Expand Up @@ -2804,7 +2804,7 @@ forward OnPlayerStreamOut(playerid, forplayerid);
* <param name="issuerid">The ID of the player that caused the damage. <b><c>INVALID_PLAYER_ID</c></b>
* if self-inflicted</param>
* <param name="amount">The amount of damage the player took (health and armour combined)</param>
* <param name="weaponid">The ID of the <a href="http://wiki.sa-mp.com/wiki/Weapons">weapon/reason</a>
* <param name="weaponid">The ID of the <a href="https://www.open.mp/docs/scripting/resources/weaponids">weapon/reason</a>
* for the damage</param>
* <param name="bodypart">The body part that was hit. (NOTE: This parameter was added in <b>0.3z</b>.
* Leave it out if using an older version!)</param>
Expand Down Expand Up @@ -2838,7 +2838,7 @@ forward OnPlayerTakeDamage(playerid, issuerid, Float:amount, WEAPON:weaponid, bo
* <param name="playerid">The ID of the player that gave damage</param>
* <param name="damagedid">The ID of the player that received damage</param>
* <param name="amount">The amount of health/armour damagedid has lost (combined)</param>
* <param name="weaponid">The <a href="http://wiki.sa-mp.com/wiki/Weapons">reason</a> that caused the
* <param name="weaponid">The <a href="https://www.open.mp/docs/scripting/resources/weaponids">reason</a> that caused the
* damage</param>
* <param name="bodypart">The body part that was hit. (NOTE: This parameter was added in <b>0.3z</b>.
* Leave it out if using an older version!)</param>
Expand Down Expand Up @@ -2889,7 +2889,7 @@ forward OnPlayerClickPlayer(playerid, clickedplayerid, CLICK_SOURCE:source);
* <param name="playerid">The ID of the player that died</param>
* <param name="killerid">The ID of the player that killed the player who died, or <b><c>INVALID_PLAYER_ID</c></b>
* if there was none</param>
* <param name="reason">The ID of the <a href="http://wiki.sa-mp.com/wiki/Weapons">reason</a> for the
* <param name="reason">The ID of the <a href="https://www.open.mp/docs/scripting/resources/weaponids">reason</a> for the
* player's death</param>
* <seealso name="OnPlayerSpawn" />
* <seealso name="SendDeathMessage" />
Expand All @@ -2914,7 +2914,7 @@ forward OnPlayerDeath(playerid, killerid, WEAPON:reason);
* supported. Only <b>passenger</b> drive-by is supported (not driver drive-by, and not sea sparrow
* / hunter shots).</summary>
* <param name="playerid">The ID of the player that shot a weapon</param>
* <param name="weaponid">The ID of the <a href="http://wiki.sa-mp.com/wiki/Weapons">weapon</a> shot
* <param name="weaponid">The ID of the <a href="https://www.open.mp/docs/scripting/resources/weaponids">weapon</a> shot
* by the player</param>
* <param name="hittype">The type of thing the shot hit (none, player, vehicle, or (player)object)</param>
* <param name="hitid">The ID of the player, vehicle or object that was hit</param>
Expand Down Expand Up @@ -2981,7 +2981,7 @@ forward OnScriptCash(playerid, amount, source);
* <seealso name="SetPlayerPosFindZ" />
* <seealso name="GetPlayerPos" />
* <remarks>The Z value returned will be <b><c>0</c></b> (invalid) if it is far away from the player;
* use the <a href="http://forum.sa-mp.com/showthread.php?t=275492">MapAndreas plugin</a> to get a more
* use the <a href="https://github.com/philip1337/samp-plugin-mapandreas">MapAndreas plugin</a> to get a more
* accurate Z coordinate.</remarks>
* <returns>
* <b><c>1</c></b> - Will prevent other filterscripts from receiving this callback.<br />
Expand Down Expand Up @@ -3050,9 +3050,9 @@ forward OnPlayerInteriorChange(playerid, newinteriorid, oldinteriorid);
* <summary>This callback is called when the state of any supported key is changed (pressed/released).
* Directional keys do not trigger OnPlayerKeyStateChange (up/down/left/right).</summary>
* <param name="playerid">The ID of the player that pressed or released a key</param>
* <param name="newkeys">A map (bitmask) of the keys currently held - see <a href="http://wiki.sa-mp.com/wiki/Keys">here</a></param>
* <param name="newkeys">A map (bitmask) of the keys currently held - see <a href="https://www.open.mp/docs/scripting/resources/keys">here</a></param>
* <param name="oldkeys">A map (bitmask) of the keys held prior to the current change - see
* <a href="http://wiki.sa-mp.com/wiki/Keys">here</a></param>
* <a href="https://www.open.mp/docs/scripting/resources/keys">here</a></param>
* <seealso name="GetPlayerKeys" />
* <remarks>This callback can also be called by NPC.</remarks>
* <remarks>
Expand Down
2 changes: 1 addition & 1 deletion omp_textlabel.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ native #Global();
* If the virtualWorld is set as <b><c>-1</c></b> the text will not appear.
* </remarks>
* <remarks>drawdistance seems to be a lot smaller when spectating.</remarks>
* <remarks>Use <a href="http://wiki.sa-mp.com/wiki/Colors_List#Inline_colour_embedding">colour embedding</a>
* <remarks>Use <a href="https://www.open.mp/docs/scripting/resources/colorslist">colour embedding</a>
* for multiple colours in the text.</remarks>
* <returns>The ID of the newly created 3D Text Label, or <b><c>INVALID_3DTEXT_ID</c></b> if the 3D
* Text Label limit (<b><c>MAX_3DTEXT_GLOBAL</c></b>) was reached.</returns>
Expand Down
Loading