DgsCreateFont: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Client function}}
{{Client function}}
__NOTOC__
__NOTOC__
This function creates a dx font element that can be used in [[dgsSetFont]].
This function creates a dx font element that can be used in [[dgsSetFont]] and stored in dgs.


Successful font creation is not guaranteed, and may fail due to hardware or memory limitations.
Successful font creation is not guaranteed, and may fail due to hardware or memory limitations.
'''The font file should be in the dgs folder.'''


==Syntax==  
==Syntax==  
Line 33: Line 31:
==Example==  
==Example==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
DGS = exports.dgs
-- Display a dgs label
-- Display a dgs label
local myLabel = dgsCreateLabel( 100, 300, 400, 50, "DGS label", false )
local myLabel = DGS:dgsCreateLabel( 100, 300, 400, 50, "DGS label", false )


-- Use 'toggle' command to switch custom font on and off
-- Use 'toggle' command to switch custom font on and off
Line 40: Line 39:
     function()
     function()
         if not myFont then
         if not myFont then
             myFont = dgsCreateFont( "segoeui.ttf", 20 )  -- Create DGS custom font
             myFont = DGS:dgsCreateFont( "segoeui.ttf", 20 )  -- Create DGS custom font
             dgsSetFont( myLabel, myFont )                -- Apply font to a widget
             DGS:dgsSetFont( myLabel, myFont )                -- Apply font to a widget
         else         
         else         
             destroyElement( myFont )                    -- Destroy custom font
             destroyElement( myFont )                    -- Destroy custom font

Latest revision as of 08:32, 26 January 2019

This function creates a dx font element that can be used in dgsSetFont and stored in dgs.

Successful font creation is not guaranteed, and may fail due to hardware or memory limitations.

Syntax

element dgsCreateFont ( string filepath [, int size=9, bool bold=false, string quality="proof" ] )

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
  • quality: the font quality
    • "default": not the actual default
    • "draft"
    • "proof": the default
    • "nonantialiased"
    • "antialiased"
    • "cleartype"
    • "cleartype_natural"

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

DGS = exports.dgs
-- Display a dgs label
local myLabel = DGS: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 = DGS:dgsCreateFont( "segoeui.ttf", 20 )  -- Create DGS custom font
            DGS:dgsSetFont( myLabel, myFont )                -- Apply font to a widget
        else        
            destroyElement( myFont )                     -- Destroy custom font
            myFont = nil
        end
    end
)

See Also

Custom Cursor Functions

Multi Language Supports

Animation

3D Element

3D Interface

3D Line

3D Image

3D Text

Browser

Button

Check Box

Combo Box

Custom Renderer

Edit

Detect Area

Drag'N Drop

Grid List

Image

Memo

Menu

Label

Layout

Line

Progress Bar

Radio Button

Scale Pane

Scroll Bar

Scroll Pane

Selector

Style

Switch Button

Tab Panel

Window

Basic Shape Plugins

Circle

Quadrilateral

Rounded Rectangle

Other Plugins

Blur Box

Canvas

Chart

Color Picker

Effect 3D

Gradient

Mask

Media Browser

Nine Slice

Object Preview Supports

Paste Handler

QRCode

Remote Image

Screen Source

SVG

Tooltips

Retrieved from "https://wiki.multitheftauto.com/wiki/DgsCreateFont?oldid=62042"