Multi Theft Auto: Wiki - User contributions [en]

GuiGetScreenSize

2011-04-27T15:39:29Z

XX3:

__NOTOC__
{{Client function}}
This function retrieves the local screen size according to the resolution they are using.

==Syntax==
<syntaxhighlight lang="lua">
float float guiGetScreenSize ()
</syntaxhighlight>

===Returns===
This returns two floats representing the player's screen resolution, ''width'' and ''height''.

==Example==
This example checks whether a player is using a low resolution, and warns them that GUI may appear incorrect.
<syntaxhighlight lang="lua">
--setup a function when the resource starts
function checkResolutionOnStart ( theResource )
--if the resource started isnt this resource, don't bother initiating the function
if theResource ~= getThisResource() then return end
local x,y = guiGetScreenSize() --get their screen size
if ( x <= 640 ) and ( y <= 480 ) then --if their resolution is lower or equal to 640x480
--warn them about GUI problems.
outputChatBox ( "WARNING: You are running on a low resolution. Some GUI may be placed or appear incorrectly." )
end
end
--attach the function to the event handler
addEventHandler ( "onClientResourceStart", getRootElement(), checkResolutionOnStart )
</syntaxhighlight>

==Using guiGetScreenSize to fit GUI & DX drawing in all resolutions==
To get the precise coordinates of a GUI element or DX drawings, you need to decide which edges of the screen you want to have them positioned against, then you just need to find the difference between your screen size and your position values.

For example, there is a DX text. It fits on 1024x768 resolution.
<syntaxhighlight lang="lua">
function DXtext ()
dxDrawText(tostring "Hello World!",684.0,731.0,732.0,766.0,tocolor(0,255,255,175),1.0,"bankgothic","left","top",false,false,false)
end

addEventHandler ( "onClientResourceStart", getRootElement(), DXtext )
</syntaxhighlight>
Now if you want it to fit on all resolutions. Then follow these steps:

1. Add ''width'' and ''height'' variables to get GUI's screen size, here we use sWidth and sHeight.
<syntaxhighlight lang="lua">
local sWidth,sHeight = guiGetScreenSize() -- The variables
dxDrawText( "Hello World!",684.0,731.0,732.0,766.0,tocolor(0,255,255,175),1.0,"bankgothic","left","top",false,false,false)
</syntaxhighlight>

2. Subtract each of the DX text's position values from the screen size manually (remembering the resolution is 1024x768):

*'''Left''' position value is 684, 1024-684 = 340
*'''Top''' position value is 731, 768-731 = 37
*'''Right''' position values is 732, 1024-732 = 292
*'''Bottom''' position value is 766, 768-766 = 2

You may want to use a calculator to help you count.

3. Now with the answer above remove all of the position values and replace it with the width or height variable subtract with the answer. Which would be:
<syntaxhighlight lang="lua">
local sWidth,sHeight = guiGetScreenSize() -- The variables
dxDrawText("Hello World!",sWidth-340, sHeight-37, sWidth-292, sHeight-2,tocolor(0,255,255,175),1.0,"bankgothic","left","top",false,false,false)
</syntaxhighlight>

So the final results will be a DX text which will fit on all resolutions which will be:
<syntaxhighlight lang="lua">
function DXtext ()
local sWidth,sHeight = guiGetScreenSize() -- The variables
dxDrawText("Hello World!",sWidth-340, sHeight-37, sWidth-292, sHeight-2,tocolor(0,255,255,175),1.0,"bankgothic","left","top",false,false,false)
end

addEventHandler ( "onClientResourceStart", getRootElement(), DXtext )
</syntaxhighlight>

==See Also==
{{GUI_functions}}

GuiGetScreenSize

2011-04-27T15:39:04Z

XX3: /* Precise DX Drawing example */

GuiGetScreenSize

2010-11-15T09:02:40Z

XX3:

__NOTOC__
{{Client function}}
This function retrieves the local screen size according to the resolution they are using.

==Syntax==
<syntaxhighlight lang="lua">
float float guiGetScreenSize ()
</syntaxhighlight>

===Returns===
This returns two floats representing the player's screen resolution, ''width'' and ''height''.

==Example==
This example checks whether a player is using a low resolution, and warns them that GUI may appear incorrect.
<syntaxhighlight lang="lua">
--setup a function when the resource starts
function checkResolutionOnStart ( theResource )
--if the resource started isnt this resource, don't bother initiating the function
if theResource ~= getThisResource() then return end
local x,y = guiGetScreenSize() --get their screen size
if ( x <= 640 ) and ( y <= 480 ) then --if their resolution is lower or equal to 640x480
--warn them about GUI problems.
outputChatBox ( "WARNING: You are running on a low resolution. Some GUI may be placed or appear incorrectly." )
end
end
--attach the function to the event handler
addEventHandler ( "onClientResourceStart", getRootElement(), checkResolutionOnStart )
</syntaxhighlight>

==Tips==
To get the precise coordinates of a GUI element or DX drawings, you need to decide which edges of the screen you want to have them positioned against, then you just need to find the difference between your screen size and your position values.

For example, there is a DX text. It fits on 1024x768 resolution.
<syntaxhighlight lang="lua">
function DXtext ()
dxDrawText(tostring "Hello World!",684.0,731.0,732.0,766.0,tocolor(0,255,255,175),1.0,"bankgothic","left","top",false,false,false)
end

addEventHandler ( "onClientResourceStart", getRootElement(), DXtext )
</syntaxhighlight>
Now if you want it to fit on all resolutions. Then follow these steps:

1. Add ''width'' and ''height'' variables to get GUI's screen size, here we use sWidth and sHeight.
<syntaxhighlight lang="lua">
local sWidth,sHeight = guiGetScreenSize() -- The variables
dxDrawText(tostring "Hello World!",684.0,731.0,732.0,766.0,tocolor(0,255,255,175),1.0,"bankgothic","left","top",false,false,false)
</syntaxhighlight>

2. Subtract each of the DX text's position values from the screen size manually (remembering the resolution is 1024x768):

*'''Left''' position value is 684, 1024-684 = 340
*'''Top''' position value is 731, 768-731 = 37
*'''Right''' position values is 732, 1024-732 = 292
*'''Bottom''' position value is 766, 768-766 = 2

You may want to use a calculator to help you count.

3. Now with the answer above remove all of the position values and replace it with the width or height variable subtract with the answer. Which would be:
<syntaxhighlight lang="lua">
local sWidth,sHeight = guiGetScreenSize() -- The variables
dxDrawText(tostring "Hello World!",sWidth-340, sHeight-37, sWidth-292, sHeight-2,tocolor(0,255,255,175),1.0,"bankgothic","left","top",false,false,false)
</syntaxhighlight>

So the final results will be a DX text which will fit on all resolutions which will be:
<syntaxhighlight lang="lua">
function DXtext ()
local sWidth,sHeight = guiGetScreenSize() -- The variables
dxDrawText(tostring "Hello World!",sWidth-340, sHeight-37, sWidth-292, sHeight-2,tocolor(0,255,255,175),1.0,"bankgothic","left","top",false,false,false)
end

addEventHandler ( "onClientResourceStart", getRootElement(), DXtext )
</syntaxhighlight>

==See Also==
{{GUI_functions}}

GuiGetScreenSize

2010-11-15T09:00:57Z

XX3: Adding some tips to help you make a GUI elements or DX drawings in all resolutions.

__NOTOC__
{{Client function}}
This function retrieves the local screen size according to the resolution they are using.

==Syntax==
<syntaxhighlight lang="lua">
float float guiGetScreenSize ()
</syntaxhighlight>

===Returns===
This returns two floats representing the player's screen resolution, ''width'' and ''height''.

==Example==
This example checks whether a player is using a low resolution, and warns them that GUI may appear incorrect.
<syntaxhighlight lang="lua">
--setup a function when the resource starts
function checkResolutionOnStart ( theResource )
--if the resource started isnt this resource, don't bother initiating the function
if theResource ~= getThisResource() then return end
local x,y = guiGetScreenSize() --get their screen size
if ( x <= 640 ) and ( y <= 480 ) then --if their resolution is lower or equal to 640x480
--warn them about GUI problems.
outputChatBox ( "WARNING: You are running on a low resolution. Some GUI may be placed or appear incorrectly." )
end
end
--attach the function to the event handler
addEventHandler ( "onClientResourceStart", getRootElement(), checkResolutionOnStart )
</syntaxhighlight>

==Tips==
To get the precise coordinates of a GUI element or DX drawings, you need to decide which edges of the screen you want to have them positioned against, then you just need to find the difference between your screen size and your position values.

For example, there is a DX text. It fits on 1024x768 resolution.
<syntaxhighlight lang="lua">
function DXtext ()
dxDrawText(tostring "Hello World!",684.0,731.0,732.0,766.0,tocolor(0,255,255,175),1.0,"bankgothic","left","top",false,false,false)
end

addEventHandler ( "onClientResourceStart", getRootElement(), DXtext )
</syntaxhighlight>
Now if you want it to fit on all resolutions. Then follow these steps:

1. Add ''width'' and ''height'' variables to get GUI's screen size, here we use sWidth and sHeight.
<syntaxhighlight lang="lua">
local sWidth,sHeight = guiGetScreenSize() -- The variables
dxDrawText(tostring "Hello World!",684.0,731.0,732.0,766.0,tocolor(0,255,255,175),1.0,"bankgothic","left","top",false,false,false)
</syntaxhighlight>

2. Subtract each of the DX text's position values from the screen size manually (remembering the resolution is 1024x768):

*'''Left''' position value is 684, 1024-684 = 340
*'''Top''' position value is 731, 768-731 = 37
*'''Right''' position values is 732, 1024-732 = 292
*'''Bottom''' position value is 766, 768-766 = 2

You may want to use a calculator to help you count.

3. Now with the answer above remove all of the position values and replace it with the guiGetScreenSize variable subtract with the answer. Which would be:
<syntaxhighlight lang="lua">
local sWidth,sHeight = guiGetScreenSize() -- The variables
dxDrawText(tostring "Hello World!",sWidth-340, sHeight-37, sWidth-292, sHeight-2,tocolor(0,255,255,175),1.0,"bankgothic","left","top",false,false,false)
</syntaxhighlight>

So the final results will be a DX text which will fit on all resolutions which will be:
<syntaxhighlight lang="lua">
function DXtext ()
local sWidth,sHeight = guiGetScreenSize() -- The variables
dxDrawText(tostring "Hello World!",sWidth-340, sHeight-37, sWidth-292, sHeight-2,tocolor(0,255,255,175),1.0,"bankgothic","left","top",false,false,false)
end

addEventHandler ( "onClientResourceStart", getRootElement(), DXtext )
</syntaxhighlight>

==See Also==
{{GUI_functions}}