GuiCreateMemo: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(New page: __NOTOC__ {{Client function}} This function creates a new GUI memo. This is a multiline edit box in which the user can input text. ==Syntax== <syntaxhighlight lang="lua"> gui-memo guiCreateMemo ( flo...)
 
No edit summary
Line 18: Line 18:
===Optional Arguments===  
===Optional Arguments===  
{{OptionalArg}}  
{{OptionalArg}}  
*'''parent:''' This is the parent that the GUI memo is attached to.  The ''relative'' argument must be true to use this. Sizes and positioning will be made relative to this parent. If no parent is passed, the parent will become the screen - causing relative positioning and sizing according to screen positioning.
*'''parent:''' This is the parent that the GUI 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.


===Returns===
===Returns===

Revision as of 20:33, 2 January 2009

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

Syntax

gui-memo guiCreateMemo ( float x, float y, float width, float height, string text, bool relative, [element parent = nil] )

Required Arguments

  • x: A float of the 2D x position of the GUI memo on a player's screen. This is affected by the relative argument.
  • y: A float of the 2D y position of the GUI memo on a player's screen. This is affected by the relative argument.
  • width: A float of the width of the GUI memo. This is affected by the relative argument.
  • height: A float of the height of the GUI 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 GUI 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.

Returns

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

Example

See Also

General functions

Browsers

Buttons

Checkboxes

Comboboxes

Edit Boxes

Gridlists

Memos

Progressbars

Radio Buttons

Scrollbars

Scrollpanes

Static Images

Tab Panels

Tabs

Text Labels

Windows