guiGetScreenSize

Client-side

Server-side

Shared

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

OOP Syntax Help! I don't understand this!

Method:GuiElement.getScreenSize(...)

Syntax

float, float guiGetScreenSize ( )

Returns

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

float: width
float: height

Code Examples

client

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)

guiGetScreenSize

OOP Syntax Help! I don't understand this!

Syntax

Returns

Code Examples

See Also

GUI Functions

GUI Elements

Reference