guiGetScreenSize | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

guiGetScreenSize

Client-side
Server-side
Shared

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

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

OOP Syntax Help! I don't understand this!

Syntax

float float guiGetScreenSize ( )

Returns

  • float float: value

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

Code Examples

shared

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 ()
  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", resourceRoot, checkResolutionOnStart )

See Also

GUI Functions
GUI Elements
Reference