Merge branch 'documentation'

a_actor.inc

@@ -10,25 +10,215 @@
 #define _actor_included
 #pragma library actors
 
+/// <summary>Create a static 'actor' in the world. These 'actors' are like NPCs, however they have limited functionality. They do not take up server player slots.</summary>
+/// <param name="modelid">The model ID (skin ID) the actor should have</param>
+/// <param name="X">The X coordinate to create the actor at</param>
+/// <param name="Y">The Y coordinate to create the actor at</param>
+/// <param name="Z">The Z coordinate to create the actor at</param>
+/// <param name="Rotation">The facing angle (rotation) for the actor to have</param>
+/// <seealso name="DestroyActor"/>
+/// <seealso name="SetActorPos"/>
+/// <seealso name="GetActorPos"/>
+/// <seealso name="SetActorFacingAngle"/>
+/// <seealso name="GetActorFacingAngle"/>
+/// <seealso name="SetActorVirtualWorld"/>
+/// <seealso name="GetActorVirtualWorld"/>
+/// <seealso name="ApplyActorAnimation"/>
+/// <seealso name="ClearActorAnimations"/>
+/// <seealso name="GetPlayerCameraTargetActor"/>
+/// <seealso name="IsActorStreamedIn"/>
+/// <seealso name="SetActorHealth"/>
+/// <seealso name="GetActorHealth"/>
+/// <seealso name="SetActorInvulnerable"/>
+/// <seealso name="IsActorInvulnerable"/>
+/// <seealso name="IsValidActor"/>
+/// <seealso name="GetActorPoolSize"/>
+/// <seealso name="GetPlayerTargetActor"/>
+/// <seealso name="OnActorStreamIn"/>
+/// <seealso name="OnActorStreamOut"/>
+/// <seealso name="OnPlayerGiveDamageActor"/>
+/// <remarks>This function was added in <b>SA-MP 0.3.7</b> and will not work in earlier versions!</remarks>
+/// <remarks>
+///   Actors are completely separate from NPCs. They do NOT use player IDs/slots on the server and CANNOT be handled like NPCs.<p/>
+///   Actors are limited to <b><c>1000</c></b> (<b><c>MAX_ACTORS</c></b>).<p/>
+///   Actors can be pushed by vehicles, use a timer to put them back at their positions.<p/>
+///   As of <b>0.3.7 R2</b> actors default to being <a href="http://wiki.sa-mp.com/wiki/SetActorInvulnerable">invulnerable</a>.
+/// </remarks>
+/// <returns>
+///   The created Actor ID (start at <b><c>0</c></b>).<p/>
+///   <b><c>INVALID_ACTOR_ID</c></b> (<b><c>65535</c></b>) If the actor limit (<b><c>1000</c></b>) is reached.
+/// </returns>
 native CreateActor(modelid, Float:X, Float:Y, Float:Z, Float:Rotation);
+
+/// <summary>Destroy an actor which was created with <a href="#CreateActor">CreateActor</a>.</summary>
+/// <param name="actorid">The ID of the actor to destroy. Returned by <a href="#CreateActor">CreateActor</a></param>
+/// <seealso name="CreateActor"/>
+/// <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>: The function executed successfully.<p/>
+///   <b><c>0</c></b>: The function failed to execute. The actor with the ID specified does not exist.
+/// </returns>
 native DestroyActor(actorid);
 
+
+/// <summary>Checks if an actor is streamed in for a player.</summary>
+/// <param name="actorid">The ID of the actor</param>
+/// <param name="forplayerid">The ID of the player</param>
+/// <seealso name="CreateActor"/>
+/// <seealso name="IsPlayerStreamedIn"/>
+/// <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 streamed in for the player, or <b><c>0</c></b> if it is not.</returns>
 native IsActorStreamedIn(actorid, forplayerid);
 
+
+/// <summary>Set the virtual world of an actor. Only players in the same world will see the actor.</summary>
+/// <param name="actorid">The ID of the actor (returned by <a href="#CreateActor">CreateActor</a>) to set the virtual world of</param>
+/// <param name="vworld">The virtual world to put the actor ID</param>
+/// <seealso name="GetActorVirtualWorld"/>
+/// <seealso name="CreateActor"/>
+/// <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>: The function executed successfully.<p/>
+///   <b><c>0</c></b>: The function failed to execute. The actor specified does not exist.
+/// </returns>
 native SetActorVirtualWorld(actorid, vworld);
+
+/// <summary>Get the virtual world of an actor.</summary>
+/// <param name="actorid">The ID of the actor to get the virtual world of</param>
+/// <seealso name="SetActorVirtualWorld"/>
+/// <remarks>This function was added in <b>SA-MP 0.3.7</b> and will not work in earlier versions!</remarks>
+/// <returns>The virtual world of the actor. By default this is <b><c>0</c></b>. Also returns <b><c>0</c></b> if actor specified does not exist.</returns>
 native GetActorVirtualWorld(actorid);
 
+/// <summary>Apply an animation to an actor.</summary>
+/// <param name="actorid">The ID of the actor to apply the animation to</param>
+/// <param name="animlib">The animation library from which to apply an animation</param>
+/// <param name="animname">The name of the animation to apply, within the specified library</param>
+/// <param name="fDelta">The speed to play the animation (use <b><c>4.1</c></b>)</param>
+/// <param name="loop">If set to <b><c>1</c></b>, the animation will loop. If set to <b><c>0</c></b>, the animation will play once</param>
+/// <param name="lockx">If set to <b><c>0</c></b>, the actor is returned to their old X coordinate once the animation is complete (for animations that move the actor such as walking). <b><c>1</c></b> will not return them to their old position</param>
+/// <param name="locky">Same as above but for the Y axis. Should be kept the same as the previous parameter</param>
+/// <param name="freeze">Setting this to <b><c>1</c></b> will freeze an actor at the end of the animation. <b><c>0</c></b> will not</param>
+/// <param name="time">Timer in milliseconds. For a never-ending loop it should be <b><c>0</c></b></param>
+/// <seealso name="ClearActorAnimations"/>
+/// <remarks>You must preload the animation library for the player the actor will be applying the animation for, and not for the actor. Otherwise, the animation won't be applied to the actor until the function is executed again.</remarks>
+/// <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>: The function executed successfully.<p/>
+/// <b><c>0</c></b>: The function failed to execute. The actor specified does not exist.
+/// </returns>
 native ApplyActorAnimation(actorid, const animlib[], const animname[], Float:fDelta, loop, lockx, locky, freeze, time);
+
+/// <summary>Clear any animations applied to an actor.</summary>
+/// <param name="actorid">The ID of the actor (returned by <a href="#CreateActor">CreateActor</a>) to clear the animations for</param>
+/// <seealso name="ApplyActorAnimation"/>
+/// <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>: The function executed successfully.<p/>
+///   <b><c>0</c></b>: The function failed to execute. The actor specified does not exist.
+/// </returns>
 native ClearActorAnimations(actorid);
 
+
+/// <summary>Set the position of an actor.</summary>
+/// <param name="actorid">The ID of the actor to set the position of. Returned by <a href="#CreateActor">CreateActor</a></param>
+/// <param name="X">The X coordinate to position the actor at</param>
+/// <param name="Y">The Y coordinate to position the actor at</param>
+/// <param name="Z">The Z coordinate to position the actor at</param>
+/// <seealso name="GetActorPos"/>
+/// <seealso name="CreateActor"/>
+/// <remarks>This function was added in <b>SA-MP 0.3.7</b> and will not work in earlier versions!</remarks>
+/// <remarks>When creating an actor with <a href="#CreateActor">CreateActor</a>, you specify it's position. You do not need to use this function unless you want to change its position later.</remarks>
+/// <returns>
+///   <b><c>1</c></b>: The function executed successfully.<p/>
+///   <b><c>0</c></b>: The function failed to execute. The actor specified does not exist.
+/// </returns>
 native SetActorPos(actorid, Float:X, Float:Y, Float:Z);
+
+/// <summary>Get the position of an actor.</summary>
+/// <param name="actorid">The ID of the actor to get the position of. Returned by <a href="# CreateActor">CreateActor</a></param>
+/// <param name="X">A float variable, passed by reference, in which to store the X coordinate of the actor</param>
+/// <param name="Y">A float variable, passed by reference, in which to store the Y coordinate of the actor</param>
+/// <param name="Z">A float variable, passed by reference, in which to store the Z coordinate of the actor</param>
+/// <seealso name="SetActorPos"/>
+/// <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>: The function executed successfully.<p/>
+///   <b><c>0</c></b>: The function failed to execute. The actor specified does not exist.<p/>
+/// </returns>
 native GetActorPos(actorid, &Float:X, &Float:Y, &Float:Z);
+
+/// <summary>Set the facing angle of an actor.</summary>
+/// <param name="actorid">The ID of the actor to set the facing angle of. Returned by <a href="#CreateActor">CreateActor</a></param>
+/// <param name="ang">The facing angle to set for the actor</param>
+/// <seealso name="GetActorFacingAngle"/>
+/// <seealso name="SetActorPos"/>
+/// <remarks>This function was added in <b>SA-MP 0.3.7</b> and will not work in earlier versions!</remarks>
+/// <remarks>Players will see actor's facing angle changed only when it is restreamed to them.</remarks>
+/// <remarks>When creating an actor with <a href="#CreateActor">CreateActor</a>, you specify it's facing angle. You do not need to use this function unless you want to change its facing angle later.</remarks>
+/// <returns>
+///   <b><c>1</c></b>: The function executed successfully.<p/>
+///   <b><c>0</c></b>: The function failed to execute. The actor specified does not exist.
+/// </returns>
 native SetActorFacingAngle(actorid, Float:ang);
+
+/// <summary>Get the facing angle of an actor.</summary>
+/// <param name="actorid">The ID of the actor to get the facing angle of. Returned by <a href="#CreateActor">CreateActor</a></param>
+/// <param name="ang">A float variable, passed by reference, in to which the actor's facing angle will be stored</param>
+/// <seealso name="SetActorFacingAngle"/>
+/// <seealso name="GetActorPos"/>
+/// <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>: The function executed successfully.<p/>
+///   <b><c>0</c></b>: The function failed to execute. The actor specified does not exist.
+/// </returns>
 native GetActorFacingAngle(actorid, &Float:ang);
 
+
+/// <summary>Set the health of an actor.</summary>
+/// <param name="actorid">The ID of the actor to set the health of</param>
+/// <param name="health">The value to set the actors's health to</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> on success.<p/>
+///   <b><c>0</c></b> on failure (i.e. actor is not created).
+/// </returns>
 native SetActorHealth(actorid, Float:health);
+
+/// <summary>Get the health of an actor.</summary>
+/// <param name="actorid">The ID of the actor to get the health of</param>
+/// <param name="health">A float variable, passed by reference, in to which to store the actor's health</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> - success.<p/>
+///   <b><c>0</c></b> - failure (i.e. actor is not created).<p/>
+/// </returns>
 native GetActorHealth(actorid, &Float:health);
+
+/// <summary>Toggle an actor's invulnerability.</summary>
+/// <param name="actorid">The ID of the actor to set invulnerability</param>
+/// <param name="invulnerable"><b><c>false</c></b> to make them vulnerable, <b><c>true</c></b> to make them invulnerable (optional=<b><c>true</c></b>)</param>
+/// <remarks>This function was added in <b>SA-MP 0.3.7</b> and will not work in earlier versions!</remarks>
+/// <remarks>Once set invulnerable, the actor does not call <a href="#OnPlayerGiveDamageActor">OnPlayerGiveDamageActor</a>.</remarks>
+/// <remarks>Players will have actor's invulnerability state changed only when it is restreamed to them.</remarks>
+/// <returns>
+///   <b><c>1</c></b> - Success.<p/>
+///   <b><c>0</c></b> - Failure (i.e. Actor is not created).
+/// </returns>
 native SetActorInvulnerable(actorid, invulnerable = true);
+
+/// <summary>Check if an actor is invulnerable.</summary>
+/// <param name="actorid">The ID of the actor to check</param>
+/// <seealso name="CreateActor"/>
+/// <seealso name="SetActorInvulnerable"/>
+/// <seealso name="SetActorHealth"/>
+/// <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 invulnerable, <b><c>0</c></b> otherwise.</returns>
 native IsActorInvulnerable(actorid);
 
+
+/// <summary>Checks if an actor ID is valid.</summary>
+/// <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);

a_http.inc

@@ -19,6 +19,34 @@
 #define HTTP_ERROR_CONTENT_TOO_BIG		5
 #define HTTP_ERROR_MALFORMED_RESPONSE	6
 
+/// <summary>Sends a threaded HTTP request.</summary>
+/// <param name="index">ID used to differentiate requests that are sent to the same callback (useful for playerids)</param>
+/// <param name="type">The type of request you wish to send</param>
+/// <param name="url">The URL you want to request. (Without 'http://')</param>
+/// <param name="data">Any POST data you want to send with the request</param>
+/// <param name="callback">Name of the callback function you want to use to handle responses to this request</param>
+/// <remarks>This function was added in <b>SA-MP 0.3b</b> and will not work in earlier versions!</remarks>
+/// <returns><b><c>1</c></b> on success, <b><c>0</c></b> on failure.</returns>
+/// <remarks>
+///   <b>Request types:</b><p/>
+///   <ul>
+///     <li><b><c>HTTP_GET</c></b></li>
+///     <li><b><c>HTTP_POST</c></b></li>
+///     <li><b><c>HTTP_HEAD</c></b></li>
+///   </ul>
+/// </remarks>
+/// <remarks>
+///   <b>Response codes:</b><p/>
+///   <ul>
+///     <li><b><c>HTTP_ERROR_BAD_HOST</c></b></li>
+///     <li><b><c>HTTP_ERROR_NO_SOCKET</c></b></li>
+///     <li><b><c>HTTP_ERROR_CANT_CONNECT</c></b></li>
+///     <li><b><c>HTTP_ERROR_CANT_WRITE</c></b></li>
+///     <li><b><c>HTTP_ERROR_CONTENT_TOO_BIG</c></b></li>
+///     <li><b><c>HTTP_ERROR_MALFORMED_RESPONSE</c></b></li>
+///     <li>+ standard HTTP response codes</li>
+///   </ul>
+/// </remarks>
 native HTTP(index, type, const url[], const data[], const callback[]);
 
 // example HTTP callback: public MyHttpResponse(index, response_code, data[]) { ... }