Multi Theft Auto: Wiki - User contributions [en]

DgsBringToFront

2018-06-08T03:45:49Z

Scorpyo: Created page with "This function sets the font of a dgs element to be used when drawing text. ==Syntax== <syntaxhighlight lang="lua"> bool guiBringToFront ( element dgsElement ) </syntaxhighli..."

This function sets the font of a dgs element to be used when drawing text.

==Syntax==
<syntaxhighlight lang="lua">
bool guiBringToFront ( element dgsElement )
</syntaxhighlight>

===Required Arguments===
*'''dgsElement:''' the DGS element that you want to move to the front.

===Returns===
Returns ''true'' if the function was successful, ''false'' otherwise.

==Example==
This example creates a dgs window and brings it on top.
<syntaxhighlight lang="lua">
local window = dgsCreateWindow ( 0.4, 0.4, 0.3, 0.3, "My dummy window", true )
dgsBringToFront ( window )
</syntaxhighlight>

DgsCreateFont

2018-06-08T03:42:50Z

Scorpyo: /* Returns */

This function creates a dgs font element that can be used in [dgsSetFont]https://wiki.multitheftauto.com/wiki/DgsSetFont. Successful font creation is not guaranteed, and may fail due to hardware or memory limitations.

==Syntax==
<syntaxhighlight lang="lua">
element dgsCreateFont ( string filepath[, int size=9 ] )
</syntaxhighlight>

===Required Arguments===
*'''filepath:''' the name of the file containing the font

===Optional Arguments===
*'''size:''' size of the font

===Returns===
Returns a DGS font element if successful, ''false'' if invalid arguments were passed to the function, or there is insufficient resources available.

'''You should always check to see if this function has returned false.'''

==Example==
<syntaxhighlight lang="lua">
-- Display a dgs label
local myLabel = dgsCreateLabel( 100, 300, 400, 50, "DGS label", false )

-- Use 'toggle' command to switch custom font on and off
addCommandHandler( "toggle",
function()
if not myFont then
myFont = dgsCreateFont( "segoeui.ttf", 20 ) -- Create DGS custom font
dgsSetFont( myLabel, myFont ) -- Apply font to a widget
else
destroyElement( myFont ) -- Destroy custom font
myFont = nil
end
end
)
</syntaxhighlight>

DgsCreateFont

2018-06-08T03:42:15Z

Scorpyo: Created page with "This function creates a dgs font element that can be used in [dgsSetFont]https://wiki.multitheftauto.com/wiki/DgsSetFont. Successful font creation is not guaranteed, and may f..."

This function creates a dgs font element that can be used in [dgsSetFont]https://wiki.multitheftauto.com/wiki/DgsSetFont. Successful font creation is not guaranteed, and may fail due to hardware or memory limitations.

==Syntax==
<syntaxhighlight lang="lua">
element dgsCreateFont ( string filepath[, int size=9 ] )
</syntaxhighlight>

===Required Arguments===
*'''filepath:''' the name of the file containing the font

===Optional Arguments===
*'''size:''' size of the font

===Returns===
Returns a [[DGS font]] element if successful, ''false'' if invalid arguments were passed to the function, or there is insufficient resources available.

'''You should always check to see if this function has returned false.'''

==Example==
<syntaxhighlight lang="lua">
-- Display a dgs label
local myLabel = dgsCreateLabel( 100, 300, 400, 50, "DGS label", false )

-- Use 'toggle' command to switch custom font on and off
addCommandHandler( "toggle",
function()
if not myFont then
myFont = dgsCreateFont( "segoeui.ttf", 20 ) -- Create DGS custom font
dgsSetFont( myLabel, myFont ) -- Apply font to a widget
else
destroyElement( myFont ) -- Destroy custom font
myFont = nil
end
end
)
</syntaxhighlight>