Add auto-parsed functions all marked as needing review

Author: Fernando-A-Rocha

functions/Camera/fadeCamera.yaml

@@ -1,18 +1,95 @@
 # Scraped from: https://wiki.multitheftauto.com/wiki/FadeCamera
+client:
+  name: fadeCamera
+  description: This function will fade a player's camera to a color or back to normal
+    over a specified time period. This will also affect the sound volume for the player
+    (50% faded \= 50% volume, full fade \= no sound). For clientside scripts you can
+    perform 2 fade ins or fade outs in a row, but for serverside scripts you must
+    use one then the other.
+  parameters:
+  - name: fadeIn
+    type: bool
+    description: Should the camera be faded in our out? Pass true to fade the camera
+      in, false to fade it out to a color.
+  - name: timeToFade
+    type: float
+    description: The number of seconds it should take to fade.
+    default: '1.0'
+  - name: red
+    type: int
+    description: The amount of red in the color that the camera fades out to (0 -
+      255). Not required for fading in.
+    default: '0'
+  - name: green
+    type: int
+    description: The amount of green in the color that the camera fades out to (0
+      - 255). Not required for fading in.
+    default: '0'
+  - name: blue
+    type: int
+    description: The amount of blue in the color that the camera fades out to (0 -
+      255). Not required for fading in.
+    default: '0'
+  examples: []
+  returns:
+    values:
+    - type: bool
+      name: value
+    description: Returns true if the camera was faded successfully, false if invalid
+      arguments were passed to the function.
+  oop: &id001
+    element: player
+    method: fadeCamera
+    static: false
+  notes: &id002
+  - type: info
+    content: The speed of the effect depends directly on the current gamespeed.
+  requires_review: true
 server:
   name: fadeCamera
   description: This function will fade a player's camera to a color or back to normal
     over a specified time period. This will also affect the sound volume for the player
     (50% faded \= 50% volume, full fade \= no sound). For clientside scripts you can
     perform 2 fade ins or fade outs in a row, but for serverside scripts you must
     use one then the other.
-  parameters: []
+  parameters:
+  - name: thePlayer
+    type: player
+    description: The player whose camera you wish to fade.
+  - name: fadeIn
+    type: bool
+    description: Should the camera be faded in or out? Pass true to fade the camera
+      in, false to fade it out to a color.
+  - name: timeToFade
+    type: float
+    description: The number of seconds it should take to fade.
+    default: '1.0'
+  - name: red
+    type: int
+    description: The amount of red in the color that the camera fades out to (0 -
+      255). Not required for fading in.
+    default: '0'
+  - name: green
+    type: int
+    description: The amount of green in the color that the camera fades out to (0
+      - 255). Not required for fading in.
+    default: '0'
+  - name: blue
+    type: int
+    description: The amount of blue in the color that the camera fades out to (0 -
+      255). Not required for fading in.
+    default: '0'
   examples:
   - path: examples/fadeCamera-1.lua
     description: When a player gets damaged, place a quick fade-to-red effect on his
       screen.
     side: server
-  notes:
-  - type: info
-    content: The speed of the effect depends directly on the current gamespeed.
+  returns:
+    values:
+    - type: bool
+      name: value
+    description: Returns true if the camera was faded successfully, false if invalid
+      arguments were passed to the function.
+  oop: *id001
+  notes: *id002
   requires_review: true

functions/Camera/getCamera.yaml

@@ -1,5 +1,5 @@
 # Scraped from: https://wiki.multitheftauto.com/wiki/GetCamera
-client:
+shared:
   name: getCamera
   description: This function returns an [element](/wiki/Element "Element") that corresponds
     to the game camera
@@ -8,6 +8,11 @@ client:
   - path: examples/getCamera-1.lua
     description: This example attaches (fixes) the camera to a vehicle.
     side: client
+  returns:
+    values:
+    - type: element
+      name: value
+    description: Returns an element that corresponds to the game camera
   notes:
   - type: info
     content: Using attachElements with the camera and the main player can interfere

functions/Camera/getCameraClip.yaml

@@ -1,5 +1,5 @@
 # Scraped from: https://wiki.multitheftauto.com/wiki/GetCameraClip
-client:
+shared:
   name: getCameraClip
   description: This function checks if the camera will "collide" with any objects
     or vehicles in its way. Read more about this [here](/wiki/SetCameraClip "SetCameraClip").
@@ -8,5 +8,16 @@ client:
   - path: examples/getCameraClip-1.lua
     description: This function checks the clip status.
     side: client
+  returns:
+    values:
+    - type: bool
+      name: value1
+    - type: bool
+      name: value2
+    description: This function checks the clip status.
+  oop:
+    element: Camera
+    method: )
+    static: true
   pair: setCameraClip
   requires_review: true

functions/Camera/getCameraDrunkLevel.yaml

@@ -1,5 +1,5 @@
 # Scraped from: https://wiki.multitheftauto.com/wiki/GetCameraDrunkLevel
-client:
+shared:
   name: getCameraDrunkLevel
   description: This function gets the camera drunk level set by [setCameraDrunkLevel](/wiki/SetCameraDrunkLevel
     "SetCameraDrunkLevel"). This function was renamed from [getCameraShakeLevel](/wiki/GetCameraShakeLevel
@@ -10,4 +10,13 @@ client:
     description: This example checks for changes in the camera drunk level of any
       player every frame and outputs different messages according to it.
     side: client
+  returns:
+    values:
+    - type: int
+      name: value
+    description: Returns an integer representing the camera drunk level, from 0 (no
+      drunk effect) to 255 (maximum drunk effect). By default, the camera has no drunk
+      effect. Drunk effect is a wavy motion of the camera depicting the player being
+      drunk. This function used to be called getCameraShakeLevel which has since been
+      deprecated.
   requires_review: true

functions/Camera/getCameraFieldOfView.yaml

@@ -1,13 +1,28 @@
 # Scraped from: https://wiki.multitheftauto.com/wiki/GetCameraFieldOfView
-client:
+shared:
   name: getCameraFieldOfView
   description: This function returns the field of view of the *dynamic camera* as
     set by [setCameraFieldOfView](/wiki/SetCameraFieldOfView "SetCameraFieldOfView").
-  parameters: []
+  parameters:
+  - name: cameraMode
+    type: string
+    description: 'the camera mode to get the field of view of: "player": whilst walking/running
+      "vehicle": whilst in vehicle "vehicle_max": the max the field of view can go
+      to when the vehicle is moving at a high speed (must be higher than "vehicle")'
   examples:
   - path: examples/getCameraFieldOfView-1.lua
     description: In this example, the field of view is output to the chat whenever
       the /getfov command is written
     side: client
+  returns:
+    values:
+    - type: float
+      name: value
+    description: Returns one float - the field of view angle
+  oop:
+    element: Camera
+    method: getFieldOfView
+    variable: fov
+    static: true
   pair: setCameraFieldOfView
   requires_review: true

functions/Camera/getCameraGoggleEffect.yaml

@@ -1,5 +1,5 @@
 # Scraped from: https://wiki.multitheftauto.com/wiki/GetCameraGoggleEffect
-client:
+shared:
   name: getCameraGoggleEffect
   description: This function returns what goggle effect is currently affecting the
     camera.
@@ -9,5 +9,16 @@ client:
     description: This example adds a command to enable or disable the nightvision
       effect.
     side: client
+  returns:
+    values:
+    - type: string
+      name: value
+    description: This example adds a command to enable or disable the nightvision
+      effect.
+  oop:
+    element: Camera
+    method: getGoggleEffect
+    variable: goggleEffect
+    static: true
   pair: setCameraGoggleEffect
   requires_review: true

functions/Camera/getCameraInterior.yaml

@@ -8,8 +8,12 @@ server:
   - path: examples/getCameraInterior-1.lua
     description: ''
     side: server
+  oop:
+    element: player
+    method: getCameraInterior
+    variable: cameraInterior
+    static: false
   pair: setCameraInterior
-  requires_review: true
   meta:
   - needs_checking: 'This function was partially migrated from the old wiki. Please
       review manually:
@@ -19,3 +23,4 @@ server:
       - Missing section: Object-oriented
 
       '
+  requires_review: true

functions/Camera/getCameraTarget.yaml

@@ -1,12 +1,41 @@
 # Scraped from: https://wiki.multitheftauto.com/wiki/GetCameraTarget
-server:
+client:
   name: getCameraTarget
   description: This function returns an [element](/wiki/Element "Element") that corresponds
     to the current target of the specified player's camera (i.e. what it is following).
   parameters: []
+  examples: []
+  returns:
+    values:
+    - type: element
+      name: value
+    description: This example checks whether a player's camera's target is another
+      player, and returns true or false accordingly.
+  oop: &id001
+    element: player
+    method: getCameraTarget
+    variable: cameraTarget
+    static: false
+  pair: setCameraTarget
+  requires_review: true
+server:
+  name: getCameraTarget
+  description: This function returns an [element](/wiki/Element "Element") that corresponds
+    to the current target of the specified player's camera (i.e. what it is following).
+  parameters:
+  - name: thePlayer
+    type: player
+    description: The player whose camera you wish to receive the target of.
   examples:
   - path: examples/getCameraTarget-1.lua
     description: ''
     side: server
+  returns:
+    values:
+    - type: element
+      name: value
+    description: This example checks whether a player's camera's target is another
+      player, and returns true or false accordingly.
+  oop: *id001
   pair: setCameraTarget
   requires_review: true

functions/Camera/getCameraViewMode.yaml

@@ -1,5 +1,5 @@
 # Scraped from: https://wiki.multitheftauto.com/wiki/GetCameraViewMode
-client:
+shared:
   name: getCameraViewMode
   description: This function allows you to get the active camera view modes. This
     indicates at what distance the camera will follow the player or vehicle.
@@ -9,5 +9,18 @@ client:
     description: This example tells the player their current camera view when they
       change it
     side: client
+  returns:
+    values:
+    - type: int
+      name: value1
+    - type: int
+      name: value2
+    description: Returns two ints indicating the current vehicle and ped camera view
+      mode respectively. Their meanings can be seen below.
+  oop:
+    element: Camera
+    method: getCameraViewMode
+    variable: viewMode
+    static: true
   pair: setCameraViewMode
   requires_review: true

functions/Camera/resetShakeCamera.yaml

@@ -1,5 +1,5 @@
 # Scraped from: https://wiki.multitheftauto.com/wiki/ResetShakeCamera
-client:
+shared:
   name: resetShakeCamera
   description: This function cancels the shaking effect caused by **shakeCamera**
   parameters: []
@@ -8,4 +8,9 @@ client:
     description: This example allows you to trigger huge camera shake effect near
       you and then cancels the effect after 5 seconds.
     side: client
+  returns:
+    values:
+    - type: bool
+      name: value
+    description: Always returns true .
   requires_review: true