DgsSetSize

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

This function sets the dimensions (size) of a DGS element. It refers to the bounding box size for DGS elements. It does not make DGS elements smaller or larger in appearance.

Syntax

bool dgsSetSize ( element dgsElement, float width, float height, bool relative )

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

Note: It variables is a conjunction:
  • Relative: size.relative (set Relative property)
  • Width: size.w
  • Height: size.h

Method: DGSElement:setSize(...)
Variable: .size
Counterpart: dgsGetSize


Required Arguments

  • dgsElement: the DGS element whose visibility is to be changed
  • width: The desired width setting for the dgs element
  • height: The desired height setting for the dgs element
  • 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 true if the dgs element's size was set successfully, false otherwise.

Example

This example creates a dgs window and changes the x and y width of the window every 2 seconds.

DGS = exports.dgs
function changeWindowSize ( )
	--Called by the timer every 2 seconds. It decides an x and y width randomly between .1 and .5
	DGS:dgsSetSize ( myWindow, ( math.random( 10, 50 ) / 100 ), ( math.random( 10, 50 ) / 100 ), true )
end

--Create a dgs window called 'myWindow'
myWindow = DGS:dgsCreateWindow ( 0.3, 0.3, 0.5, 0.60, "DGS window title", true )
--Set a timer to change the window's size every 2 seconds, infinite times
setTimer ( changeWindowSize, 2000, 0 )

See Also

General Functions

General Events