GetCameraMode: Difference between revisions
Jump to navigation
Jump to search
Black Dragon (talk | contribs) mNo edit summary |
m (Fixed spelling of addCommandHandler, placed it after function declaration, second argument is a function pointer and not a string) |
||
| Line 21: | Line 21: | ||
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized --> | <!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized --> | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function checkCamera( source, command, player ) | function checkCamera( source, command, player ) | ||
player = getPlayerFromName( player ) --Gets the player using his name | player = getPlayerFromName( player ) --Gets the player using his name | ||
outputConsole( getCameraMode( player ), source ) --Outputs the state of players' camera. | outputConsole( getCameraMode( player ), source ) --Outputs the state of players' camera. | ||
end | end | ||
addCommandHandler( "camera", checkCamera ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Camera functions}} | {{Camera functions}} | ||
Revision as of 13:57, 15 August 2007
This function returns a string containing the current mode of the specified 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.
function checkCamera( source, command, player )
player = getPlayerFromName( player ) --Gets the player using his name
outputConsole( getCameraMode( player ), source ) --Outputs the state of players' camera.
end
addCommandHandler( "camera", checkCamera )
See Also
- fadeCamera
- getCameraInterior
- getCameraMatrix
- getCameraTarget
- setCameraInterior
- setCameraMatrix
- setCameraTarget