View source for DxCreateFont

{{Client function}}
__NOTOC__
{{New feature|3.0110|1.1|
Only available in 1.1
}}
This function creates a [[DX font]] element that can be used in [[dxDrawText]]. Successful font creation is not guaranteed, and may fail due to hardware or memory limitations.

To see if creation is likely to fail, use [[dxGetStatus]]. (When '''VideoRamFreeForMTA''' is zero, failure ''is'' guaranteed.)
=====It is highly recommended that [[dxSetTestMode]] is used when writing and testing scripts using dxCreateFont.=====

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

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

===Optional Arguments===
*'''size:''' size of the font
*'''bold:''' flag to indicate if the font should be bold

===Returns===
Returns a [[DX 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 text using dxDrawText
addEventHandler( "onClientRender", root,
    function()
        dxDrawText( "dxDrawText", 100, 350, 300, 350, tocolor(255,255,0), 1, myFont )
    end
)

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

==See Also==
{{Drawing_functions}}