DgsGetSize

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

This function gets the size of a DGS element.

Syntax

float, float dgsGetSize ( element theElement, bool relative )

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

Note: It variables is a conjunction:
  • Relative: size.relative (whether element size is relative)
  • Width: size.w or size.width
  • Height: size.h or size.height
  • toVector: size.toVector [returns a Vector, use size.toVector.x (for width) and size.toVector.y (for height)]
Method: DGSElement:getSize(...)
Variable: .size
Counterpart: dgsSetSize

Required Arguments

  • theElement: The DGS element to get size of.
  • relative: This is whether sizes and positioning are relative. If this is true, then all x,y,width,height floats must be between 0 and 1, representing sizes relative to the parent.

Returns

Returns the DGS element size x and y if the function has been successful, false otherwise.

Example

This example creates a random sized dgs window and outputs its size to the chatbox. 

DGS = exports.dgs
local window = DGS:dgsCreateWindow ( 0, 0, (math.random ( 0, 100 ) / 100), (math.random ( 0, 100 ) / 100), "test", true ) 
-- Create the window
local x, y = DGS:dgsGetSize ( window, false ) -- Get the dgs window size
outputChatBox ( "Window size: " .. x .. " " .. y ) --output the dgs window size

See Also

General Functions

General Events

Retrieved from "https://wiki.multitheftauto.com/wiki/DgsGetSize?oldid=70981"