GetCameraPosition: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 22: Line 22:


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
<!-- Explain what the example is in a single sentence -->
This example does...
This example checks if the camera is fixed, and prints its position if so.
<!-- 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">
addCommandHandler( "check", "checkCamera" )
function checkCamera( source )
function checkCamera( source )
       if ( getCameraMode( source ) == "fixed" ) then --If the camera is fixed...
       if ( getCameraMode( source ) == "fixed" ) then --If the camera is fixed...
Line 35: Line 34:
       end
       end
end
end
addCommandHandler( "check", checkCamera )
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Camera functions}}
{{Camera functions}}

Revision as of 14:07, 15 August 2007

Dialog-information.png This article needs checking.

Reason(s): Returns 0 0 0 with script:
addCommandHandler ( "getcampos", "retrieveCameraPosition" )
function retrieveCameraPosition ( player, commandName )
local camx, camy, camz = getCameraPosition ( player )
outputChatBox ( "X: "..camx.." Y: "..camy.." Z: "..camz )
end
--Ransom 17:17, 11 April 2007 (CDT)



This function returns the position the player's camera would have if the camera mode is fixed (see setCameraMode).

Syntax

float float float getCameraPosition ( player thePlayer )

Required Arguments

  • thePlayer: The player whose camera position you wish to obtain.

Returns

Returns three floats containing the x, y and z co-ordinate values if the function was successful, false otherwise.

Example

This example checks if the camera is fixed, and prints its position if so.

function checkCamera( source )
      if ( getCameraMode( source ) == "fixed" ) then --If the camera is fixed...
            local camx, camy, camz = getCameraPosition( source ) --Get the cameras position
            outputConsole( camx .. " " .. camy .. " " .. camz, source ) --And output it.
      else
            outputConsole( "The camera is not fixed", source ) --If not, say so.
      end
end
addCommandHandler( "check", checkCamera )

See Also