View source for API:WorldToScreen

{{LuaApi|group=WorldObject}}
Projects a point in the 3D scene to screen pixel coordinates.

<pre>
onScreen, x, y = WorldToScreen(sceneX, sceneY, sceneZ)
</pre>

== Arguments ==
;sceneX, sceneY, sceneZ : <code>number</code> – The point, in the coordinate space of the 3D scene (see Details).

== Returns ==
;onScreen : <code>boolean</code> – <code>true</code> if the point is in front of the camera and inside the view.
;x, y : <code>number</code> – Screen position in whole pixels, measured from the top-left corner, at the game's display resolution. Both are <code>0</code> when <code>onScreen</code> is <code>false</code>.

== Details ==
* The three values are passed to the camera projection as given. When the client projects an object's position (for example in [[API:MoveWindowToWorldObject|MoveWindowToWorldObject]]) it first subtracts a world origin from X and Y and negates the height. This function does no such conversion, so positions taken from game data do not project to the right place.
* The pixel values use the resolution from the video settings, not the UI's scaled coordinate space.
* The function needs at least three arguments and only reads the last three.
* The stock UI never calls this function.

== Errors ==
None besides the generic ''Invalid Parameters'' message when an argument is not a number.

== Example ==
A minimal call built from the signature:
<pre>
local onScreen, x, y = WorldToScreen( sceneX, sceneY, sceneZ )
if onScreen then
    -- x, y are pixel coordinates
end
</pre>

== See also ==
* [[API:MoveWindowToWorldObject|MoveWindowToWorldObject]]