DgsGetScreenSize

From Multi Theft Auto: Wiki
Jump to navigation Jump to search

This function is a replica of guiGetScreenSize. In order to satisfy the needs of developers, the function exists here.

Syntax

float, float dgsGetScreenSize()

DGS OOP Syntax Help! I don't understand this!

Note: The returned value it's a Vector2
Method: dgsRootInstance:getScreenSize(...)

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.

--setup a function when the resource starts
DGS = exports.dgs

function checkResolutionOnStart ()
	local x,y = DGS:dgsGetScreenSize() --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

General Functions

General Events