DgsCreateMemo: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(5 intermediate revisions by 2 users not shown)
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
element dgsDxCreateMemo ( float x, float y, float width, float height, string text, bool relative, [element parent = nil, int textcolor = 0x000000FF, int scale_x = 1, int scale_y = 1, element imagebg = nil, int colorbg = 0xFFFFFFFF ] )
element dgsCreateMemo ( float x, float y, float width, float height, string text, bool relative [, element parent = nil, int textColor = 0x000000FF, int scaleX = 1, int scaleY = 1, element bgImage = nil, int bgColor = 0xFFFFFFFF ] )
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
[[Image:Gui-memo.png|frame|Example GUI memo.]]
[[Image:DGS Memo.png|frame|Example DGS memo.]]
*'''x:''' A float of the 2D x position of the DGS memo on a player's screen.  This is affected by the ''relative'' argument.
*'''x:''' A float of the 2D x position of the DGS memo on a player's screen.  This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the DGS memo on a player's screen. This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the DGS memo on a player's screen. This is affected by the ''relative'' argument.
Line 20: Line 20:
{{OptionalArg}}  
{{OptionalArg}}  
*'''parent:''' This is the parent that the DGS memo is attached to.  If the ''relative'' argument is true, sizes and positioning will be made relative to this parent. If the ''relative'' argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.
*'''parent:''' This is the parent that the DGS memo is attached to.  If the ''relative'' argument is true, sizes and positioning will be made relative to this parent. If the ''relative'' argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.
*'''textcolor:''' An integer of the color of the text.
*'''textColor:''' An integer of the color of the text.
*'''scale_x:''' A float of the width of the text scale.
*'''scaleX:''' A float of the width of the text scale.
*'''scale_y:''' A float of the height of the text scale.
*'''scaleY:''' A float of the height of the text scale.
*'''imagebg:''' A texture element of the back ground image of the memo.
*'''bgImage:''' A texture element of the back ground image of the memo.
*'''colorbg:''' A texture element of the back ground color of the memo.
*'''bgColor:''' An integer of the back ground color of the memo.


===Element Type===
===Element Type===
Line 37: Line 37:


addEventHandler("onClientResourceStart", resourceRoot, function()
addEventHandler("onClientResourceStart", resourceRoot, function()
Window = DGS:dgsDxCreateWindow(0.3664,0.2764,0.3508,0.3477,"DGS Window",true)
Window = DGS:dgsCreateWindow(0.3664,0.2764,0.3508,0.3477,"DGS Window",true)
DGS:dgsDxCreateMemo(17,79,414,246,"",false,Window)
DGS:dgsCreateMemo(17,79,414,246,"",false,Window)
end)
end)
</syntaxhighlight>
</syntaxhighlight>

Latest revision as of 09:26, 17 January 2021

This function creates a new DGS memo. This is a multiline edit box in which the user can input text.

Syntax

element dgsCreateMemo ( float x, float y, float width, float height, string text, bool relative [, element parent = nil, int textColor = 0x000000FF, int scaleX = 1, int scaleY = 1, element bgImage = nil, int bgColor = 0xFFFFFFFF ] )

Required Arguments

Example DGS memo.
  • x: A float of the 2D x position of the DGS memo on a player's screen. This is affected by the relative argument.
  • y: A float of the 2D y position of the DGS memo on a player's screen. This is affected by the relative argument.
  • width: A float of the width of the DGS memo. This is affected by the relative argument.
  • height: A float of the height of the DGS memo. This is affected by the relative argument.
  • text: A string of the text that will be displayed by default in the memo.
  • relative: This is whether sizes and positioning are relative. If this is true, then all x,y,width,height floats must be between 0 and 1, representing measures relative to the parent.

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • parent: This is the parent that the DGS memo is attached to. If the relative argument is true, sizes and positioning will be made relative to this parent. If the relative argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.
  • textColor: An integer of the color of the text.
  • scaleX: A float of the width of the text scale.
  • scaleY: A float of the height of the text scale.
  • bgImage: A texture element of the back ground image of the memo.
  • bgColor: An integer of the back ground color of the memo.

Element Type

The Element Type of this element is dgs-dxmemo.

Returns

Returns a dgs-dxmemo element of the created memo if it was successfully created, false otherwise.

Example

BEFORE VERSION 1.0 :
DGS = exports.dgs

addEventHandler("onClientResourceStart", resourceRoot, function()
	Window = DGS:dgsCreateWindow(0.3664,0.2764,0.3508,0.3477,"DGS Window",true)
	DGS:dgsCreateMemo(17,79,414,246,"",false,Window)
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/DgsCreateMemo?oldid=68291"