Merge pull request #51 from DasChaosAT/master

Added documentation of Blip, Checkpoint and ColShape.

Author: FabianTerhorst

api/AltV.Net/Alt.Blip.cs

@@ -6,34 +6,86 @@ namespace AltV.Net
 {
     public partial class Alt
     {
+        /// <summary>
+        /// Creates a blip for a specific player on a specific position.
+        /// </summary>
+        /// <param name="player">The player for which the blip is created.</param>
+        /// <param name="type">The type of the blip.</param>
+        /// <param name="pos">The position on which the blip is created.</param>
+        /// <returns>The created Blip.</returns>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         public static IBlip CreateBlip(IPlayer player, byte type, Position pos) =>
             Module.Server.CreateBlip(player, type, pos);
 
+        /// <summary>
+        /// Create a blip for a specific player, attached to specific entity.
+        /// </summary>
+        /// <param name="player">The player for which the blip is created.</param>
+        /// <param name="type">The type of the blip.</param>
+        /// <param name="entityAttach">The entity to which the blip is atteched to.</param>
+        /// <returns>The created Blip.</returns>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         public static IBlip CreateBlip(IPlayer player, byte type, IEntity entityAttach) =>
             Module.Server.CreateBlip(player, type, entityAttach);
 
+        /// <summary>
+        /// Creates a blip for a specific player on a specific position.
+        /// </summary>
+        /// <param name="player">The player for which the blip is created.</param>
+        /// <param name="type">The type of the blip.</param>
+        /// <param name="pos">The position on which the blip is created.</param>
+        /// <returns>The created Blip.</returns>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         public static IBlip CreateBlip(IPlayer player, BlipType type, Position pos) =>
             Module.Server.CreateBlip(player, (byte) type, pos);
 
+        /// <summary>
+        /// Creates a blip for a specific player, attached to specific entity.
+        /// </summary>
+        /// <param name="player">The player for which the blip is created.</param>
+        /// <param name="type">The type of the blip.</param>
+        /// <param name="entityAttach">The entity to which the blip is atteched to.</param>
+        /// <returns>The created Blip.</returns>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         public static IBlip CreateBlip(IPlayer player, BlipType type, IEntity entityAttach) =>
             Module.Server.CreateBlip(player, (byte) type, entityAttach);
 
+        /// <summary>
+        /// Creates a blip for all players on a specific position.
+        /// </summary>
+        /// <param name="type">The type of the blip.</param>
+        /// <param name="pos">The position on which the blip is created.</param>
+        /// <returns>The created Blip.</returns>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         public static IBlip CreateBlip(byte type, Position pos) =>
             Module.Server.CreateBlip(null, type, pos);
 
+        /// <summary>
+        /// Creates a blip for all players, attached to specific entity.
+        /// </summary>
+        /// <param name="type">The type of the blip.</param>
+        /// <param name="entityAttach">The entity to which the blip is atteched to.</param>
+        /// <returns>The created Blip.</returns>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         public static IBlip CreateBlip(byte type, IEntity entityAttach) =>
             Module.Server.CreateBlip(null, type, entityAttach);
 
+        /// <summary>
+        /// Creates a blip for all players on a specific position.
+        /// </summary>
+        /// <param name="type">The type of the blip.</param>
+        /// <param name="pos">The position on which the blip is created.</param>
+        /// <returns>The created Blip.</returns>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         public static IBlip CreateBlip(BlipType type, Position pos) =>
             Module.Server.CreateBlip(null, (byte) type, pos);
 
+        /// <summary>
+        /// Creates a blip for all players, attached to specific entity.
+        /// </summary>
+        /// <param name="type">The type of the blip.</param>
+        /// <param name="entityAttach">The entity to which the blip is atteched to.</param>
+        /// <returns>The created Blip.</returns>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         public static IBlip CreateBlip(BlipType type, IEntity entityAttach) =>
             Module.Server.CreateBlip(null, (byte) type, entityAttach);

api/AltV.Net/Alt.Checkpoint.cs

@@ -5,19 +5,57 @@ namespace AltV.Net
 {
     public partial class Alt
     {
+        /// <summary>
+        /// Creates a checkpoint for a specific player, with given type, position, radius, height and color.
+        /// </summary>
+        /// <param name="player">The player for which the checkpoint is created.</param>
+        /// <param name="type">The type of the checkpoint.</param>
+        /// <param name="pos">The position of the checkpoint.</param>
+        /// <param name="radius">The size of the checkpoint.</param>
+        /// <param name="height">The height of the checkpoint.</param>
+        /// <param name="color">The color of the checkpoint.</param>
+        /// <returns>The created Checkpoint.</returns>
         public static ICheckpoint CreateCheckpoint(IPlayer player, byte type, Position pos, float radius, float height,
             Rgba color) =>
             Module.Server.CreateCheckpoint(player, type, pos, radius, height, color);
 
+        /// <summary>
+        /// Creates a checkpoint for a specific player, with given type, position, radius, height and color.
+        /// </summary>
+        /// <param name="player">The player for which the checkpoint is created.</param>
+        /// <param name="type">The type of the checkpoint.</param>
+        /// <param name="pos">The position of the checkpoint.</param>
+        /// <param name="radius">The size of the checkpoint.</param>
+        /// <param name="height">The height of the checkpoint.</param>
+        /// <param name="color">The color (of the checkpoint.</param>
+        /// <returns>The created Checkpoint.</returns>
         public static ICheckpoint CreateCheckpoint(IPlayer player, CheckpointType type, Position pos, float radius,
             float height,
             Rgba color) =>
             Module.Server.CreateCheckpoint(player, (byte) type, pos, radius, height, color);
 
+        /// <summary>
+        /// Creates a checkpoint for a all players, with given type, position, radius, height and color.
+        /// </summary>
+        /// <param name="type">The type of the checkpoint.</param>
+        /// <param name="pos">The position of the checkpoint.</param>
+        /// <param name="radius">The size of the checkpoint.</param>
+        /// <param name="height">The height of the checkpoint.</param>
+        /// <param name="color">The color of the checkpoint.</param>
+        /// <returns>The created Checkpoint.</returns>
         public static ICheckpoint CreateCheckpoint(byte type, Position pos, float radius, float height,
             Rgba color) =>
             Module.Server.CreateCheckpoint(null, type, pos, radius, height, color);
 
+        /// <summary>
+        /// Creates a checkpoint for a all players, with given type, position, radius, height and color.
+        /// </summary>
+        /// <param name="type">The type of the checkpoint.</param>
+        /// <param name="pos">The position of the checkpoint.</param>
+        /// <param name="radius">The size of the checkpoint.</param>
+        /// <param name="height">The height of the checkpoint.</param>
+        /// <param name="color">The color of the checkpoint.</param>
+        /// <returns></returns>
         public static ICheckpoint CreateCheckpoint(CheckpointType type, Position pos, float radius,
             float height,
             Rgba color) =>

api/AltV.Net/Alt.ColShape.cs

@@ -5,26 +5,57 @@ namespace AltV.Net
 {
     public partial class Alt
     {
+        /// <summary>
+        /// Creates a alt:V cylinder colshape with specigic height.
+        /// </summary>
+        /// <param name="pos">The position of the colshape.</param>
+        /// <param name="radius">The size of the colshape.</param>
+        /// <param name="height">The height of the colshape.</param>
+        /// <returns>The created colshape.</returns>
         public static IColShape CreateColShapeCylinder(Position pos, float radius, float height)
         {
             return Module.Server.CreateColShapeCylinder(pos, radius, height);
         }
 
+        /// <summary>
+        /// Creates a alt:V sphere colshape.
+        /// </summary>
+        /// <param name="pos">The position of the colshape.</param>
+        /// <param name="radius">The size of the colshape.</param>
+        /// <returns>The created colshape.</returns>
         public static IColShape CreateColShapeSphere(Position pos, float radius)
         {
             return Module.Server.CreateColShapeSphere(pos, radius);
         }
 
+        /// <summary>
+        /// Creates a alt:V cylinder colshape with no height (from bottom to top of the height of the map).
+        /// </summary>
+        /// <param name="pos">The position of the colshape.</param>
+        /// <param name="radius">The size of the colshape.</param>
+        /// <returns>The created colshape.</returns>
         public static IColShape CreateColShapeCircle(Position pos, float radius)
         {
             return Module.Server.CreateColShapeCircle(pos, radius);
         }
 
+        /// <summary>
+        /// Creates a alt:V cube colshape between two positions.
+        /// </summary>
+        /// <param name="pos">The first position of the colshape.</param>
+        /// <param name="pos2">The second position of the colshape.</param>
+        /// <returns>The created colshape.</returns>
         public static IColShape CreateColShapeCube(Position pos, Position pos2)
         {
             return Module.Server.CreateColShapeCube(pos, pos2);
         }
 
+        /// <summary>
+        /// Creates a alt:v cube colshape between two positions with no height (from vottom to top of the height of the map).
+        /// </summary>
+        /// <param name="pos">The first position of the colshape.</param>
+        /// <param name="pos2">The second position of the colshape.</param>
+        /// <returns>The created colshape.</returns>
         public static IColShape CreateColShapeRectangle(Position pos, Position pos2)
         {
             return Module.Server.CreateColShapeRectangle(pos, pos2);