DgsSetSystemFont: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(DGS OOP Syntax changing)
 
(5 intermediate revisions by 3 users 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 as default font 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.
Line 10: Line 10:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
element dgsSetSystemFont ( string filepath [, int size=9, bool bold=false, string quality="proof" ] )
element dgsSetSystemFont ( string filepath [, int size=9, bool bold=false, string quality="proof" ] )
</syntaxhighlight>  
</syntaxhighlight>
{{DGS/OOP|
    Method = '''dgsRootInstance''':setSystemFont|
    Counterpart = dgsGetSystemFont
}}


===Required Arguments===  
===Required Arguments===  
*'''filepath:''' the name of the file containing the font. Or built-in fonts are available:
*'''filepath:''' the name of the file containing the font. Or built-in fonts are available (see here [[Standard_DGS_Font_Names]]):
**default
**default
**default-bold
**default-bold
Line 46: Line 50:
</syntaxhighlight>
</syntaxhighlight>


==See Also==
 
{{DGSFUNCTIONS}}
<syntaxhighlight lang="lua">
DGS = exports.dgs
 
DGS:dgsSetSystemFont("default-bold")
</syntaxhighlight>
 
=See Also=
 
==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">General Functions</span>==
{{DGS General Functions}}
 
==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">General Events</span>==
{{DGS Events/General}}

Latest revision as of 22:22, 3 May 2021

This function creates a dx font element as default font stored in dgs.

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

This function will copy the font file into dgs folder and then load it

Syntax

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

DGS OOP Syntax Help! I don't understand this!

Method: dgsRootInstance:setSystemFont(...)
Counterpart: dgsGetSystemFont

Required Arguments

  • filepath: the name of the file containing the font. Or built-in fonts are available (see here Standard_DGS_Font_Names):
    • default
    • default-bold
    • clear
    • arial
    • sans
    • pricedown
    • bankgothic
    • diploma
    • beckett

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 true if successful, false otherwise.

Example

DGS = exports.dgs

DGS:dgsSetSystemFont("example.ttf")



DGS = exports.dgs

DGS:dgsSetSystemFont("default-bold")

See Also

General Functions

General Events

Retrieved from "https://wiki.multitheftauto.com/wiki/DgsSetSystemFont?oldid=71013"