DgsCreate3DText: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Client function}} This function creates a 3d text in the world ( such as nametag ). ==Syntax== <syntaxhighlight lang="lua"> element dgsCreate3DText( float x, fl...")
 
(update arguments names)
 
(3 intermediate revisions by one other user not shown)
Line 3: Line 3:
This function creates a 3d text in the world ( such as nametag ).
This function creates a 3d text in the world ( such as nametag ).


==Syntax==  
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
element dgsCreate3DText( float x, float y, float z, float width, float height, int resolutionX, int resolutionY, [ int color = 0xFFFFFFFF, float faceToX = cameraX, float faceToY = cameraY, float faceToZ = cameraZ, float distance = 100 ] )
element dgsCreate3DText( float x, float y, float z, string text [, int color = 0xFFFFFFFF, dx-font/string font = nil, float scaleX = 1, float scaleY = 1, float maxDistance = 80, bool = colorcoded = false ] )
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===
[[Image:DGS 3D Text Example.gif|frame|Example DGS 3D Text.]]
[[Image:DGS 3D Text Example.gif|frame|Example DGS 3D Text.]]
*'''x:''' A float of the 3D x position of the DGS 3D Interface in the world.
*'''x:''' A float of the 3D x position of the DGS 3D Text in the world.
*'''y:''' A float of the 3D y position of the DGS 3D Interface in the world.
*'''y:''' A float of the 3D y position of the DGS 3D Text in the world.
*'''z:''' A float of the 3D z position of the DGS 3D Interface in the world.
*'''z:''' A float of the 3D z position of the DGS 3D Text in the world.
*'''width:''' A float of the width of the DGS 3D Interface in the world
*'''text:''' A string of the text of DGS 3D Text.
*'''height:''' A float of the height of the DGS 3D Interface in the world
*'''resolutionX:''' A float of the width of render target.
*'''resolutionY:''' A float of the height of render target.


===Optional Arguments===
===Optional Arguments===
*'''color:''' An integer of the color of the DGS 3D Interface.
*'''color:''' An integer of the color of the DGS 3D Text.
*'''faceToX:''' A float of the 3D x direction that the DGS 3D Interface faces to in the world.
*'''font:''' A dx-font element or a string of the DGS 3D Text.
*'''faceToY:''' A float of the 3D y direction that the DGS 3D Interface faces to in the world.
*'''scaleX:''' A float of the 2D X scale of the DGS 3D Text.
*'''faceToZ:''' A float of the 3D z direction that the DGS 3D Interface faces to in the world.
*'''scaleY:''' A float of the 2D Y scale of the DGS 3D Text.
*'''distance:''' A float of the 3D distance within which we can see the DGS 3D Interface
*'''maxDistance:''' A float of the 3D distance within which we can see the DGS 3D Text
 
*'''colorcoded:''' A bool Set to true to enable embedded #FFFFFF color codes.
===Returns===
===Returns===
Returns a 3d interface if it was successfully created, false otherwise.
Returns a dgs-3dtext element if it was successfully created, false otherwise.


==Example==  
==Example==  
Line 32: Line 29:
DGS = exports.dgs
DGS = exports.dgs


material = dgsCreate3DInterface(0,0,3,2,2,400,400,tocolor(255,255,255,255),0,1,0)
local text = DGS:dgsCreate3DText(0,0,4,"DGS 3D Text Test",white)
edit = dgsCreateEdit(0,0,200,50,"DGS 3D Interface Edit",false,material)
DGS:dgsSetProperty(text,"fadeDistance",20)
memo= dgsCreateMemo(0,60,200,90,"DGS 3D Interface Memo",false,material)
DGS:dgsSetProperty(text,"shadow",{1,1,tocolor(0,0,0,255),true})
DGS:dgsSetProperty(text,"outline",{"out",1,tocolor(255,255,255,255)})
DGS:dgs3DTextAttachToElement(text,localPlayer,0,5)
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{DGSFUNCTIONS}}
{{DGSFUNCTIONS}}

Latest revision as of 14:08, 16 February 2021

This function creates a 3d text in the world ( such as nametag ).

Syntax

element dgsCreate3DText( float x, float y, float z, string text [, int color = 0xFFFFFFFF, dx-font/string font = nil, float scaleX = 1, float scaleY = 1, float maxDistance = 80, bool = colorcoded = false ] )

Required Arguments

Example DGS 3D Text.
  • x: A float of the 3D x position of the DGS 3D Text in the world.
  • y: A float of the 3D y position of the DGS 3D Text in the world.
  • z: A float of the 3D z position of the DGS 3D Text in the world.
  • text: A string of the text of DGS 3D Text.

Optional Arguments

  • color: An integer of the color of the DGS 3D Text.
  • font: A dx-font element or a string of the DGS 3D Text.
  • scaleX: A float of the 2D X scale of the DGS 3D Text.
  • scaleY: A float of the 2D Y scale of the DGS 3D Text.
  • maxDistance: A float of the 3D distance within which we can see the DGS 3D Text
  • colorcoded: A bool Set to true to enable embedded #FFFFFF color codes.

Returns

Returns a dgs-3dtext element if it was successfully created, false otherwise.

Example

DGS = exports.dgs

local text = DGS:dgsCreate3DText(0,0,4,"DGS 3D Text Test",white)
DGS:dgsSetProperty(text,"fadeDistance",20)
DGS:dgsSetProperty(text,"shadow",{1,1,tocolor(0,0,0,255),true})
DGS:dgsSetProperty(text,"outline",{"out",1,tocolor(255,255,255,255)})
DGS:dgs3DTextAttachToElement(text,localPlayer,0,5)

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/DgsCreate3DText?oldid=69023"