Difference between revisions of "GetCameraViewMode"

From Multi Theft Auto: Wiki
m
m
 
(8 intermediate revisions by 7 users not shown)
Line 2: Line 2:
 
{{Client function}}
 
{{Client function}}
 
This function allows you to get the camera's view mode. This indicates at what distance the camera will follow the player.
 
This function allows you to get the camera's view mode. This indicates at what distance the camera will follow the player.
*'''Note:''' It currently only returns vehicle view modes
+
{{Note|It currently only returns vehicle view modes.}}
  
 
==Syntax==
 
==Syntax==
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
int getCameraView (  )
+
int getCameraViewMode (  )
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
{{OOP||Camera.getCameraViewMode|viewMode|setCameraViewMode}}
  
 
===Returns===
 
===Returns===
Line 15: Line 16:
  
 
==Example==
 
==Example==
 +
This example tells the player their current camera view when they change it
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
-- TODO
+
function onPlayerSpawn ( theSpawnpoint )
 +
    currentCam("fire") -- start a repeating check
 +
end
 +
addEventHandler ( "onClientPlayerSpawn", root, onPlayerSpawn )
 +
 
 +
function currentCam(key)
 +
  if (getControlState(key)) then
 +
      outputChatBox("Your current cam view is: "..getCameraViewMode()..".")
 +
  end
 +
end
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
==See Also==
 
==See Also==
 
{{Client camera functions}}
 
{{Client camera functions}}
[[Category:Needs_Example]]
+
 
 +
[[hu:getCameraViewMode]]

Latest revision as of 08:58, 19 December 2019

This function allows you to get the camera's view mode. This indicates at what distance the camera will follow the player.

[[{{{image}}}|link=]] Note: It currently only returns vehicle view modes.

Syntax

int getCameraViewMode (  )

OOP Syntax Help! I don't understand this!

Method: Camera.getCameraViewMode(...)
Variable: .viewMode
Counterpart: setCameraViewMode

Returns

Returns an int indicating the current camera view mode. Their meanings can be seen below.

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

Example

This example tells the player their current camera view when they change it

function onPlayerSpawn ( theSpawnpoint )
    currentCam("fire") -- start a repeating check
end
addEventHandler ( "onClientPlayerSpawn", root, onPlayerSpawn )

function currentCam(key)
   if (getControlState(key)) then
      outputChatBox("Your current cam view is: "..getCameraViewMode()..".")
   end
end

See Also