GetCameraMode: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Changed "DeprecatedWithAlt" template to "Deprecated") |
||
(2 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | |||
{{Server function}} | {{Server function}} | ||
{{Deprecated|getCameraTarget|}} | |||
This function returns a [[string]] containing the current mode of the player's camera. | This function returns a [[string]] containing the current mode of the player's camera. | ||
==Syntax== | ==Syntax== |
Latest revision as of 16:24, 13 February 2015
This function is deprecated. This means that its use is discouraged and that it might not exist in future versions. | |
Please use getCameraTarget instead. |
This function returns a string containing the current mode of the player's camera.
Syntax
string getCameraMode ( player thePlayer )
Required Arguments
- thePlayer: The player whose camera mode you wish to obtain.
Returns
Returns a string with one of two values if successful:
- player: The camera is attached to a player.
- fixed: The camera is in a fixed position.
The function will return false if unsuccessful.
Example
This function checks the camera state of a player, by specifying his name:
function checkCamera( source, command, targetName ) local targetPlayer = getPlayerFromNick ( targetName ) -- Get the player using his name outputConsole( targetName.."'s camera mode is: "..getCameraMode( targetPlayer ), source ) -- Output the state of player's camera end addCommandHandler( "camera", checkCamera )
See Also
- fadeCamera
- getCameraInterior
- getCameraMatrix
- getCameraTarget
- setCameraInterior
- setCameraMatrix
- setCameraTarget