GuiCreateMemo: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(11 intermediate revisions by 8 users not shown)
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
gui-memo guiCreateMemo ( float x, float y, float width, float height, string text, bool relative, [element parent = nil] )
gui-memo guiCreateMemo ( float x, float y, float width, float height, string text, [ bool relative = false, gui-element parent = nil ] )
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP||[[GuiMemo]]}}


===Required Arguments===  
===Required Arguments===  
[[Image:Gui-memo.png|frame|Example GUI memo.]]
*'''x:''' A float of the 2D x position of the GUI memo on a player's screen.  This is affected by the ''relative'' argument.
*'''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.
*'''y:''' A float of the 2D y position of the GUI memo on a player's screen. This is affected by the ''relative'' argument.
Line 14: Line 16:
*'''height:''' A float of the height 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.
*'''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===  
===Optional Arguments===  
{{OptionalArg}}  
{{OptionalArg}}  
*'''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.
*'''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.
*'''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.
 
===Element Type===
The Element Type of this element is gui-memo.
===Returns===
===Returns===
Returns a gui-memo element of the created memo if it was successfully created, false otherwise.
Returns a gui-memo element of the created memo if it was successfully created, false otherwise.


==Example==  
==Example==  
[[Category:Needs Example]]
<syntaxhighlight lang="lua">
function cMemoFPlayer()
    Window = guiCreateWindow(0.3664, 0.2764, 0.3508, 0.3477, "GUI Window", true)
    guiCreateMemo(17, 79, 414, 246, "", false, Window)
end
addEventHandler("onClientResourceStart", resourceRoot, cMemoFPlayer)
</syntaxhighlight>


==See Also==
==See Also==
{{GUI_functions}}
{{GUI_functions}}
{{GUI_events}}

Latest revision as of 08:09, 30 October 2023

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 = false, gui-element parent = nil ] )

OOP Syntax Help! I don't understand this!

Method: GuiMemo(...)


Required Arguments

Example GUI memo.
  • 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.

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.

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

Element Type

The Element Type of this element is gui-memo.

Returns

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

Example

function cMemoFPlayer()
    Window = guiCreateWindow(0.3664, 0.2764, 0.3508, 0.3477, "GUI Window", true)
    guiCreateMemo(17, 79, 414, 246, "", false, Window)
end
addEventHandler("onClientResourceStart", resourceRoot, cMemoFPlayer)

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

Input

GUI


Retrieved from "https://wiki.multitheftauto.com/wiki/GuiCreateMemo?oldid=78481"