DgsCreateFont: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(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...")
 
Line 13: Line 13:


===Returns===
===Returns===
Returns a [[DGS font]] element if successful, ''false'' if invalid arguments were passed to the function, or there is insufficient resources available.
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.'''
'''You should always check to see if this function has returned false.'''

Revision as of 03:42, 8 June 2018

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

element dgsCreateFont ( string filepath[, int size=9 ] )

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

-- 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
)