GetWorldFromScreenPosition

This function allows you to retrieve the world position coresponding to the 2D position on the screen.

Syntax

float float float getWorldFromScreenPosition ( float x, float y )

Required Arguments

• x: A float value between ? and ? indicating the x position on the screen.
• y: A float value between ? and ? indicating the y position on the screen.

Returns

Returns three floats indicating the world position, x, y and z respectively, false otherwise.

Example

This example binds the local player's "i" key to a function that creates an explosion in the middle of the screen.

function explosion ( key, keyState )
  local x, y, z = getWorldFromScreenPosition ( x, y, z, 0.5, 0.5 )
  createExplosion ( x, y, z, 11 )
end
bindKey ( "i", "down", "create explosion", explosion )