SetCameraViewMode: Difference between revisions

Latest revision as of 21:09, 23 September 2021

This function allows you to set the camera view modes. This indicates at what distance the camera will follow the player or vehicle.

Syntax

bool setCameraViewMode ( int vehicleCameraMode [, int pedCameraMode ] )

OOP Syntax Help! I don't understand this!

Method: Camera.setCameraViewMode(...)

Variable: .viewMode

Counterpart: getCameraViewMode

Required Arguments

vehicleCameraMode: The view mode you wish to use when inside vehicles.

Optional Arguments

pedCameraMode: The view mode you wish to use when you are not inside vehicles.

Vehicle Modes:

0: Bumper
1: Close external
2: Middle external
3: Far external
4: Low external
5: Cinematic

Ped Modes:

1: Close
2: Middle
3: Far

Returns

Returns true if the view(s) were set correctly, false otherwise.

Example

This example sets the camera to bumper view when the local player enters any vehicle.

addEventHandler("onClientPlayerVehicleEnter", localPlayer, function()
  setCameraViewMode(0)
end)

@@ Line 1: / Line 1: @@
 __NOTOC__
 {{Client function}}
-This function allows you to set the camera's view mode. This indicates at what distance the camera will follow the player.
+This function allows you to set the camera view modes. This indicates at what distance the camera will follow the player or vehicle.
-*'''Note:''' It can currently only set vehicle view modes
 ==Syntax==
 <syntaxhighlight lang="lua">
-bool setCameraView ( int viewMode )
+bool setCameraViewMode ( int vehicleCameraMode [, int pedCameraMode ] )
 </syntaxhighlight>
+{{OOP||Camera.setCameraViewMode|viewMode|getCameraViewMode}}
+===Required Arguments===
+*'''vehicleCameraMode''': The view mode you wish to use when inside vehicles.
+{{Added feature/item|1.5.9|1.5.8|20851|
+===Optional Arguments===
+*'''pedCameraMode''': The view mode you wish to use when you are not inside vehicles.
+}}
-===Required Arguments===
-*'''viewMode''': The view mode you wish to use
 {{Camera view modes}}
 ===Returns===
-Returns ''true'' if the view was set correctly, ''false'' otherwise.
+Returns ''true'' if the view(s) were set correctly, ''false'' otherwise.
 ==Example==
+This example sets the camera to bumper view when the local player enters any vehicle.
 <syntaxhighlight lang="lua">
--- TODO
+addEventHandler("onClientPlayerVehicleEnter", localPlayer, function()
+  setCameraViewMode(0)
+end)
 </syntaxhighlight>
 ==See Also==
-{{Camera functions}}
+{{Client camera functions}}
-[[Category:Needs_Example]]
+[[hu:setCameraViewMode]]
+[[RO:setCameraViewMode]]