DgsCreateFont

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

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

Label

Line

Progress Bar

Radio Button

Scale Pane

Scroll Bar

Scroll Pane

Selector

Style

Switch Button

Tab Panel

Window

Plugin

Blur Box

Color Picker

Canvas

Circle

Effect 3D

Media Browser

Mask

Nine Slice

Object Preview Supports

Paste Handler

QRCode

Remote Image

Rounded Rectangle