Colshape functions

Author: FileEX

assets/images/Colshapes/shape_circle.png

@@ -1,8 +1,6 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/AddColPolygonPoint
-shared:
+shared: &shared
   name: addColPolygonPoint
-  description: This function is used to add a new point to an existing [colshape polygon](/wiki/CreateColPolygon
-    "CreateColPolygon").
+  description: This function is used to add a new point to an existing [colshape polygon](/reference/createColPolygon).
   parameters:
   - name: shape
     type: colshape
@@ -15,21 +13,21 @@ shared:
     description: The Y position of the new bound point.
   - name: index
     type: int
-    description: MISSING_PARAM_DESC
+    description: The index where the new point will be inserted in the polygon. The points are indexed in order, with 1 being the first bound point. Passing 0 will insert the point as the last one in the polygon.
     default: '0'
-  examples:
-  - path: examples/addColPolygonPoint-1.lua
-    description: This examples adds a point to an existing polygon shape by a command.
-    side: server
   returns:
     values:
     - type: bool
-      name: value
-    description: Returns true if the polygon was changed, false if invalid arguments
+      name: result
+    description: Returns **true** if the polygon was changed, **false** if invalid arguments
       were passed.
   oop:
     element: colshape
     method: addPoint
-    static: false
   pair: removeColPolygonPoint
-  requires_review: true
+
+server:
+  <<: *shared
+  examples:
+  - path: examples/addColPolygonPoint-1.lua
+    description: This examples adds a point to an existing polygon shape by a command.

assets/images/Colshapes/shape_cuboid.png

@@ -1,9 +1,6 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/CreateColCircle
-shared:
+shared: &shared
   name: createColCircle
-  description: This function creates a collision circle. This is a shape that has
-    a position and a radius and infinite height that you can use to detect a player's
-    presence. Events will be triggered when a player enters or leaves it.
+  description: This function creates a collision circle. This is a shape that has a position and a radius and infinite height. Events will be triggered when a [[element]] enters or leaves it.
   parameters:
   - name: fX
     type: float
@@ -14,23 +11,29 @@ shared:
   - name: radius
     type: float
     description: The radius of the collision circle. Can not be smaller than 0.1.
-  examples:
-  - path: examples/createColCircle-1.lua
-    description: This example displays a chat message when a player enters the colshape
-      and allows the colshape to be created using a console functionset_zone.
-    side: server
   returns:
     values:
-    - type: colshape
-      name: value
-    description: Returns a colshape element if successful, false if invalid arguments
+    - type: colshape|false
+      name: col-circle
+    description: Returns a [[colshape]] element if successful, **false** if invalid arguments
       were passed to the function.
   oop:
-    element: ColShape
+    element: colshape
     method: Circle
     static: true
   notes:
   - type: tip
-    content: To visualize a colshape when writing scripts, use the client console
-      command showcol
-  requires_review: true
+    content: To visualize a colshape when writing scripts, use the client console command [showcol](/articles/Client_commands#showcol).
+  preview_images:
+    - path: 'Colshapes/shape_circle.png'
+
+server:
+  <<: *shared
+  examples:
+  - path: examples/createColCircle-1.lua
+    description: This example displays a chat message when a player enters the colshape
+      and allows the colshape to be created using a console command <code>set_zone</code>.
+  - path: examples/createColCircle_OOP-1.lua
+    description: This example displays a chat message when a player enters the colshape
+      and allows the colshape to be created using a console command <code>set_zone</code>.
+    oop: true

assets/images/Colshapes/shape_polygon.png

@@ -1,5 +1,4 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/CreateColCuboid
-shared:
+shared: &shared
   name: createColCuboid
   description: This function creates a collision cuboid. This is a shape that has
     a position, width, depth and height. See [Wikipedia](http://en.wikipedia.org/wiki/Cuboid)
@@ -24,19 +23,11 @@ shared:
   - name: fHeight
     type: float
     description: The collision cuboid's height.
-  examples:
-  - path: examples/createColCuboid-1.lua
-    description: This example displays a chat message when a player enters the colshape
-      and allows the colshape to be created using a console functionset_zone.
-    side: server
-  - path: examples/createColCuboid-2.lua
-    description: This function creates a cuboid and centers it to given coordinates
-    side: server
   returns:
     values:
-    - type: colshape
-      name: value
-    description: Returns a colshape element if successful, false if invalid arguments
+    - type: colshape|false
+      name: col-cuboid
+    description: Returns a [[colshape]] element if successful, **false** if invalid arguments
       were passed to the function.
   oop:
     element: ColShape
@@ -45,9 +36,21 @@ shared:
   notes:
   - type: info
     content: Attaching a cuboid colshape to another element may give unexpected results
-      as the origin is not at the cuboid centre. Try using a collision sphere for
-      attaching instead
+      as the origin is not at the cuboid centre. Try using a [collision sphere](/reference/createColSphere) for
+      attaching instead.
   - type: tip
-    content: To visualize a colshape when writing scripts, use the client console
-      command showcol
-  requires_review: true
+    content: To visualize a colshape when writing scripts, use the client console command [showcol](/articles/Client_commands#showcol).
+  preview_images:
+    - path: 'Colshapes/shape_cuboid.png'
+
+server:
+  <<: *shared
+  examples:
+  - path: examples/createColCuboid-1.lua
+    description: This example displays a chat message when a player enters the colshape
+      and allows the colshape to be created using a console command <code>set_zone</code>.
+  - path: examples/createColCuboid-2.lua
+    description: This function creates a cuboid and centers it to given coordinates.
+  - path: examples/createColCuboid_OOP-1.lua
+    description: This function creates a cuboid and centers it to given coordinates.
+    oop: true

assets/images/Colshapes/shape_rectangle.png

@@ -1,5 +1,4 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/CreateColPolygon
-shared:
+shared: &shared
   name: createColPolygon
   description: This function creates a collision polygon. See [Wikipedia](http://en.wikipedia.org/wiki/Polygon)
     for a definition of a polygon. The first set of X Y of this shape is not part
@@ -10,11 +9,11 @@ shared:
   - name: fCenterX
     type: float
     description: The X position of the collision polygon's position - the position
-      that will be returned from getElementPosition .
+      that will be returned from [[getElementPosition]].
   - name: fCenterY
     type: float
     description: The Y position of the collision polygon's position - the position
-      that will be returned from getElementPosition .
+      that will be returned from [[getElementPosition]].
   - name: fX1
     type: float
     description: The 1st X position of the collision polygon's bound point
@@ -34,35 +33,39 @@ shared:
     type: float
     description: The 3rd Y position of the collision polygon's bound point
   - name: '...'
-    type: unknown
-    description: MISSING_PARAM_DESC
-  examples:
-  - path: examples/createColPolygon-1.lua
-    description: This example displays a chat message when any element hits the colshape
-      and allows the colshape to be created using a console functionset_zone.
-    side: server
-  - path: examples/createColPolygon-2.lua
-    description: This example displays a chat message when any element hits the colshape
-      and allows the colshape to be created using a console functionset_wall.
-    side: server
+    type: ''
+    description: From the 3rd position you can have as many points as you require to create the colshape.
   returns:
     values:
-    - type: colshape
-      name: value
-    description: Returns a colshape element if successful, false if invalid arguments
+    - type: colshape|false
+      name: col-polygon
+    description: Returns a [[colshape]] element if successful, **false** if invalid arguments
       were passed to the function.
   oop:
-    element: ColShape
+    element: colshape
     method: Polygon
     static: true
+  preview_images:
+    - path: 'Colshapes/shape_polygon.png'
   notes:
   - type: info
-    content: For this function to work correctly, get/set your bound points in an
+    content: |
+      - For this function to work correctly, get/set your bound points in an
       anti-clockwise fashion.
-  - type: info
-    content: Even though this is a 2D colshape, isElementWithinColShape returns false
+      - Even though this is a 2D colshape, [[isElementWithinColShape]] returns **false**
       if an element is in the area but below 0 Z height.
   - type: tip
-    content: To visualize a colshape when writing scripts, use the client console
-      command showcol
-  requires_review: true
+    content: To visualize a colshape when writing scripts, use the client console command [showcol](/articles/Client_commands#showcol).
+
+server:
+  <<: *shared
+  examples:
+  - path: examples/createColPolygon-1.lua
+    description: This example displays a chat message when any element hits the colshape
+      and allows the colshape to be created using a console command <code>set_zone</code>.
+  - path: examples/createColPolygon-2.lua
+    description: This example displays a chat message when any element hits the colshape
+      and allows the colshape to be created using a console command <code>set_wall</code>.
+  - path: examples/createColPolygon_OOP-1.lua
+    description: This example displays a chat message when any element hits the colshape
+      and allows the colshape to be created using a console command <code>set_wall</code>.