GetCameraMatrix: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
 
(14 intermediate revisions by 11 users not shown)
Line 3: Line 3:
This function gets the position of the camera and the position of the point it is facing.
This function gets the position of the camera and the position of the point it is facing.


Note: The server-side version of this function returns the last camera matrix that was set by the server, and thus does not necessarily indicate the current matrix of the camera (since it may have been changed client-side).
 
{{Important Note|Server-side this functions returns false or the latest value set via [[setCameraMatrix]] (called from server or client).}}


==Syntax==
==Syntax==
<section name="Server" class="server" show="true">
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
float float float float float float floatfloat getCameraMatrix ( player thePlayer )
float float float float float float float float getCameraMatrix ( player thePlayer )
</syntaxhighlight>
</syntaxhighlight>
{{OOP||[[player]]:getCameraMatrix|cameraMatrix|setCameraMatrix}}


===Required Arguments===  
===Required Arguments===
*'''thePlayer:''' The player whose camera matrix is to be returned.
*'''thePlayer:''' The player whose camera matrix is to be returned.
</section>
</section>
Line 17: Line 19:
<section name="Client" class="client" show="true">
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
float float float float float floatfloat float getCameraMatrix ( )
float float float float float float float float getCameraMatrix ()
</syntaxhighlight>
</syntaxhighlight>
 
{{OOP||[[Camera]].getMatrix|matrix|setCameraMatrix}}
===Required Arguments===
''None.''
</section>
</section>


===Returns===
===Returns===
Returns eight ''float'' numbers if the argument(s) are valid; the first three indicate the position of the camera, the next three indicate the position of the point it's facing, and the last two are the roll and FOV (field of view). Returns ''false'' if the arguments are invalid.
This function returns 8 [[float|floats]] if the argument is valid (when applicable); the first three indicate the position of the camera, the next three indicate the position of the point it's facing, and the last two are the roll and field of view. Returns ''false'' if the argument is invalid.


==Example==
===Example===
'''Example 1:''' This clientside example moves camera +1 unit on X axis.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
local x, y, z, lx, ly, lz = getCameraMatrix() -- Get the current location and lookat of camera
local x, y, z, lx, ly, lz = getCameraMatrix ()
x, lx = x + 1, lx + 1 -- What will be the new x and x lookat values
x, lx = x + 1, lx + 1
setCameraMatrix(x,y,z,lx,ly,lz) -- Set camera to new position
 
setCameraMatrix (x, y, z, lx, ly, lz)
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Camera functions}}
{{Camera functions}}
[[hu:getCameraMatrix]]
[[RO:getCameraMatrix]]

Latest revision as of 08:03, 10 October 2020

This function gets the position of the camera and the position of the point it is facing.


[[{{{image}}}|link=|]] Important Note: Server-side this functions returns false or the latest value set via setCameraMatrix (called from server or client).

Syntax

Click to collapse [-]
Server
float float float float float float float float getCameraMatrix ( player thePlayer )

OOP Syntax Help! I don't understand this!

Method: player:getCameraMatrix(...)
Variable: .cameraMatrix
Counterpart: setCameraMatrix


Required Arguments

  • thePlayer: The player whose camera matrix is to be returned.
Click to collapse [-]
Client
float float float float float float float float getCameraMatrix ()

OOP Syntax Help! I don't understand this!

Method: Camera.getMatrix(...)
Variable: .matrix
Counterpart: setCameraMatrix


Returns

This function returns 8 floats if the argument is valid (when applicable); the first three indicate the position of the camera, the next three indicate the position of the point it's facing, and the last two are the roll and field of view. Returns false if the argument is invalid.

Example

Click to collapse [-]
Client
local x, y, z, lx, ly, lz = getCameraMatrix ()
x, lx = x + 1, lx + 1

setCameraMatrix (x, y, z, lx, ly, lz)

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/GetCameraMatrix?oldid=67472"