GuiGetScreenSize: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
This function retrieves the local screen size according to the resolution they are using.
This fake function is for use with blah & blah and does blahblahblabhalbhl


==Syntax==  
==Syntax==  
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
float float guiGetScreenSize ( )
float float guiGetScreenSize ()
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Returns===
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
This returns two floats of the player's screen size, ''x'' and ''y'', corresponding to the resolution of that axis.
*'''argumentName:''' description


<!-- Only include this section below if there are optional arguments -->
===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' description
*'''argumentName3:''' description
===Returns===
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
Returns ''true'' if blah, ''false'' otherwise.
*x
*y
==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This example checks whether a player is using a low resolution, and warns them that GUI may appear incorrect.
This example does...
<!-- 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">
--This line does...
--setup a function when the resource starts
blabhalbalhb --abababa
function checkResolutionOnStart ( theResource )
--This line does this...
--if the resource started isnt this resource, don't bother initiating the function
mooo
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>
</syntaxhighlight>


==See Also==
==See Also==
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
{{GUI_functions}}
{{FunctionArea_functions}}
[[Category:Need_Syntax]]  -- leave this until syntax is available. Cannot document the function or event without syntax.
[[Category:Incomplete]] -- leave this unless you complete the function

Revision as of 14:51, 1 August 2007

This function retrieves the local screen size according to the resolution they are using.

Syntax

float float guiGetScreenSize ()

Returns

This returns two floats of the player's screen size, x and y, corresponding to the resolution of that axis.

Example

This example checks whether a player is using a low resolution, and warns them that GUI may appear incorrect. 

--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 )

See Also

General functions

Browsers

Buttons

Checkboxes

Comboboxes

Edit Boxes

Gridlists

Memos

Progressbars

Radio Buttons

Scrollbars

Scrollpanes

Static Images

Tab Panels

Tabs

Text Labels

Windows

Retrieved from "https://wiki.multitheftauto.com/wiki/GuiGetScreenSize?oldid=9555"