Multi Theft Auto: Wiki - User contributions [en]

GuiCreateMemo

2011-11-19T02:15:03Z

Capy: /* Example */

__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 ( float x, float y, float width, float height, string text, bool relative, [element parent = nil] )
</syntaxhighlight>

===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.
*'''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===
{{OptionalArg}}
*'''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==
{{Client functions}}
<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", getRootElement(), cMemoFPlayer)
</syntaxhighlight>

==See Also==
{{GUI_functions}}

GuiCreateMemo

2011-11-19T02:14:51Z

Capy: /* Example */

__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 ( float x, float y, float width, float height, string text, bool relative, [element parent = nil] )
</syntaxhighlight>

===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.
*'''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===
{{OptionalArg}}
*'''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==
{{Client functions}}
<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[1])
end
addEventHandler("onClientResourceStart", getRootElement(), cMemoFPlayer)
</syntaxhighlight>

==See Also==
{{GUI_functions}}

GuiMemoSetReadOnly

2011-11-19T02:08:38Z

Capy: /* Example */

{{Client function}}
__NOTOC__
This function allows you to set or remove read-only status for a GUI memo. If read-only is set to ''true'', the contents are not editable.

==Syntax==
<syntaxhighlight lang="lua">
bool guiMemoSetReadOnly ( gui-memo theMemo, bool status )
</syntaxhighlight>

===Required Arguments===
*'''theMemo:''' The memo to change read-only status of.
*'''status:''' A boolean value indicating whether read-only is to be enabled or disabled.

===Returns===
Returns ''true'' if the status was successfully changed, ''false'' otherwise.

==Example==
{{Client function}}
<syntaxhighlight lang="lua">
function memoo()
memo = guiCreateMemo(500, 500, 500, 500, "This is a memo", false)-- We created a memo.
guiMemoSetReadOnly(memo, true)--We made it read only.
end
addEventHandler("onClientResourceStart", getRootElement(), memoo)--We handle our memo.</syntaxhighlight>

==See Also==
{{GUI_functions}}

GuiCreateScrollBar

2011-11-19T02:08:00Z

Capy: /* Example */

__NOTOC__
{{Client function}}
This function creates a GUI scrollbar. You can use the functions [[guiScrollPaneSetHorizontalScrollPosition]], [[guiScrollPaneSetVerticalScrollPosition]], [[guiScrollPaneGetHorizontalScrollPosition]] and [[guiScrollPaneGetVerticalScrollPosition]] to read and modify the scrollbar's scroll.

==Syntax==
<syntaxhighlight lang="lua">
gui-scrollbar guiCreateScrollBar ( float x, float y, float width, float height, bool horizontal, bool relative, [gui-element parent = nil])
</syntaxhighlight>

===Required Arguments===
[[Image:gui-scrollbar.png|frame|Example GUI scrollbar.]]
*'''x:''' the 2D x offset of the GUI scrollbar from its parent. This is affected by the ''relative'' argument.
*'''y:''' the 2D y offset of the GUI scrollbar from its parent. This is affected by the ''relative'' argument.
*'''width:''' the width of the GUI scrollbar. This is affected by the ''relative'' argument.
*'''height:''' the height of the GUI scrollbar. This is affected by the ''relative'' argument.
*'''horizontal:''' whether this scrollbar is horizontal (''true'') or vertical (''false'').
*'''relative:''' whether sizes and positions are relative to their parent's. If this is ''true'', then all measures must be between 0 and 1, representing sizes/positions as a fraction of the parent widget's size.

===Optional Arguments===
*'''parent:''' the gui-element this scrollbar is attached to. By default, it is nil, meaning the widget is attached to the background.

===Returns===
Returns a ''gui-scrollbar'' if it was created successfully, ''false'' otherwise.

==Example==
{{Client function}}
<syntaxhighlight lang="lua">
function scBar()
Window = guiCreateWindow(0.3664,0.2764,0.3508,0.3477,"Window",true)--We create a window.
guiCreateScrollBar(15,81,24,245,false,false,Window)--We create a scrollbar as a child of 'Window'
end
addEventHandler("onClientResourceStart", getRootElement(), scBar) --We handle it with 'onClientResourceStart' event.
</syntaxhighlight>

==See Also==
{{GUI_functions}}

GuiCreateScrollBar

2011-11-19T02:07:18Z

Capy: /* Example */

__NOTOC__
{{Client function}}
This function creates a GUI scrollbar. You can use the functions [[guiScrollPaneSetHorizontalScrollPosition]], [[guiScrollPaneSetVerticalScrollPosition]], [[guiScrollPaneGetHorizontalScrollPosition]] and [[guiScrollPaneGetVerticalScrollPosition]] to read and modify the scrollbar's scroll.

==Syntax==
<syntaxhighlight lang="lua">
gui-scrollbar guiCreateScrollBar ( float x, float y, float width, float height, bool horizontal, bool relative, [gui-element parent = nil])
</syntaxhighlight>

===Required Arguments===
[[Image:gui-scrollbar.png|frame|Example GUI scrollbar.]]
*'''x:''' the 2D x offset of the GUI scrollbar from its parent. This is affected by the ''relative'' argument.
*'''y:''' the 2D y offset of the GUI scrollbar from its parent. This is affected by the ''relative'' argument.
*'''width:''' the width of the GUI scrollbar. This is affected by the ''relative'' argument.
*'''height:''' the height of the GUI scrollbar. This is affected by the ''relative'' argument.
*'''horizontal:''' whether this scrollbar is horizontal (''true'') or vertical (''false'').
*'''relative:''' whether sizes and positions are relative to their parent's. If this is ''true'', then all measures must be between 0 and 1, representing sizes/positions as a fraction of the parent widget's size.

===Optional Arguments===
*'''parent:''' the gui-element this scrollbar is attached to. By default, it is nil, meaning the widget is attached to the background.

===Returns===
Returns a ''gui-scrollbar'' if it was created successfully, ''false'' otherwise.

==Example==
[[Category:Needs Example]]
{{Client function}}
<syntaxhighlight lang="lua">
function scBar()
Window = guiCreateWindow(0.3664,0.2764,0.3508,0.3477,"Window",true)--We create a window.
guiCreateScrollBar(15,81,24,245,false,false,Window)--We create a scrollbar as a child of 'Window'
end
addEventHandler("onClientResourceStart", getRootElement(), scBar) --We handle it with 'onClientResourceStart' event.
</syntaxhighlight>

==See Also==
{{GUI_functions}}

GuiCreateScrollBar

2011-11-19T02:03:24Z

Capy: /* Example */

__NOTOC__
{{Client function}}
This function creates a GUI scrollbar. You can use the functions [[guiScrollPaneSetHorizontalScrollPosition]], [[guiScrollPaneSetVerticalScrollPosition]], [[guiScrollPaneGetHorizontalScrollPosition]] and [[guiScrollPaneGetVerticalScrollPosition]] to read and modify the scrollbar's scroll.

==Syntax==
<syntaxhighlight lang="lua">
gui-scrollbar guiCreateScrollBar ( float x, float y, float width, float height, bool horizontal, bool relative, [gui-element parent = nil])
</syntaxhighlight>

===Required Arguments===
[[Image:gui-scrollbar.png|frame|Example GUI scrollbar.]]
*'''x:''' the 2D x offset of the GUI scrollbar from its parent. This is affected by the ''relative'' argument.
*'''y:''' the 2D y offset of the GUI scrollbar from its parent. This is affected by the ''relative'' argument.
*'''width:''' the width of the GUI scrollbar. This is affected by the ''relative'' argument.
*'''height:''' the height of the GUI scrollbar. This is affected by the ''relative'' argument.
*'''horizontal:''' whether this scrollbar is horizontal (''true'') or vertical (''false'').
*'''relative:''' whether sizes and positions are relative to their parent's. If this is ''true'', then all measures must be between 0 and 1, representing sizes/positions as a fraction of the parent widget's size.

===Optional Arguments===
*'''parent:''' the gui-element this scrollbar is attached to. By default, it is nil, meaning the widget is attached to the background.

===Returns===
Returns a ''gui-scrollbar'' if it was created successfully, ''false'' otherwise.

==Example==
[[Category:Needs Example]]
<syntaxhighlight lang="lua">
function scBar()
Window = guiCreateWindow(0.3664,0.2764,0.3508,0.3477,"Window",true)--We create a window.
guiCreateScrollBar(15,81,24,245,false,false,Window)--We create a scrollbar as a child of 'Window'
end
addEventHandler("onClientResourceStart", getRootElement(), scBar) --We handle it with 'onClientResourceStart' event.
</syntaxhighlight>

==See Also==
{{GUI_functions}}

GuiCreateScrollBar

2011-11-19T02:02:59Z

Capy: /* Example */

__NOTOC__
{{Client function}}
This function creates a GUI scrollbar. You can use the functions [[guiScrollPaneSetHorizontalScrollPosition]], [[guiScrollPaneSetVerticalScrollPosition]], [[guiScrollPaneGetHorizontalScrollPosition]] and [[guiScrollPaneGetVerticalScrollPosition]] to read and modify the scrollbar's scroll.

==Syntax==
<syntaxhighlight lang="lua">
gui-scrollbar guiCreateScrollBar ( float x, float y, float width, float height, bool horizontal, bool relative, [gui-element parent = nil])
</syntaxhighlight>

===Required Arguments===
[[Image:gui-scrollbar.png|frame|Example GUI scrollbar.]]
*'''x:''' the 2D x offset of the GUI scrollbar from its parent. This is affected by the ''relative'' argument.
*'''y:''' the 2D y offset of the GUI scrollbar from its parent. This is affected by the ''relative'' argument.
*'''width:''' the width of the GUI scrollbar. This is affected by the ''relative'' argument.
*'''height:''' the height of the GUI scrollbar. This is affected by the ''relative'' argument.
*'''horizontal:''' whether this scrollbar is horizontal (''true'') or vertical (''false'').
*'''relative:''' whether sizes and positions are relative to their parent's. If this is ''true'', then all measures must be between 0 and 1, representing sizes/positions as a fraction of the parent widget's size.

===Optional Arguments===
*'''parent:''' the gui-element this scrollbar is attached to. By default, it is nil, meaning the widget is attached to the background.

===Returns===
Returns a ''gui-scrollbar'' if it was created successfully, ''false'' otherwise.

==Example==
[[Category:Needs Example]]
<syntaxhighlight lang="lua">
function scBar()
Window = guiCreateWindow(0.3664,0.2764,0.3508,0.3477,"Window",true)--We create a window.
guiCreateScrollBar(15,81,24,245,false,Window)--We create a scrollbar as a child of 'Window'
end
addEventHandler("onClientResourceStart", getRootElement(), scBar) --We handle it with 'onClientResourceStart' event.
</syntaxhighlight>

==See Also==
{{GUI_functions}}

GuiCreateScrollBar

2011-11-19T02:02:31Z

Capy: /* Example */

__NOTOC__
{{Client function}}
This function creates a GUI scrollbar. You can use the functions [[guiScrollPaneSetHorizontalScrollPosition]], [[guiScrollPaneSetVerticalScrollPosition]], [[guiScrollPaneGetHorizontalScrollPosition]] and [[guiScrollPaneGetVerticalScrollPosition]] to read and modify the scrollbar's scroll.

==Syntax==
<syntaxhighlight lang="lua">
gui-scrollbar guiCreateScrollBar ( float x, float y, float width, float height, bool horizontal, bool relative, [gui-element parent = nil])
</syntaxhighlight>

===Required Arguments===
[[Image:gui-scrollbar.png|frame|Example GUI scrollbar.]]
*'''x:''' the 2D x offset of the GUI scrollbar from its parent. This is affected by the ''relative'' argument.
*'''y:''' the 2D y offset of the GUI scrollbar from its parent. This is affected by the ''relative'' argument.
*'''width:''' the width of the GUI scrollbar. This is affected by the ''relative'' argument.
*'''height:''' the height of the GUI scrollbar. This is affected by the ''relative'' argument.
*'''horizontal:''' whether this scrollbar is horizontal (''true'') or vertical (''false'').
*'''relative:''' whether sizes and positions are relative to their parent's. If this is ''true'', then all measures must be between 0 and 1, representing sizes/positions as a fraction of the parent widget's size.

===Optional Arguments===
*'''parent:''' the gui-element this scrollbar is attached to. By default, it is nil, meaning the widget is attached to the background.

===Returns===
Returns a ''gui-scrollbar'' if it was created successfully, ''false'' otherwise.

==Example==
[[Category:Needs Example]]
<syntaxhighlight lang="lua">
function scBar()
Window = guiCreateWindow(0.3664,0.2764,0.3508,0.3477,"Window",true)--We create a window.
Scrollbar = guiCreateScrollBar(15,81,24,245,false,Window)--We create a scrollbar as a child of 'Window'
end
addEventHandler("onClientResourceStart", getRootElement(), scBar) --We handle it with 'onClientResourceStart' event.
</syntaxhighlight>

==See Also==
{{GUI_functions}}

GuiMemoSetReadOnly

2011-11-19T01:46:15Z

Capy: /* Example */

{{Client function}}
__NOTOC__
This function allows you to set or remove read-only status for a GUI memo. If read-only is set to ''true'', the contents are not editable.

==Syntax==
<syntaxhighlight lang="lua">
bool guiMemoSetReadOnly ( gui-memo theMemo, bool status )
</syntaxhighlight>

===Required Arguments===
*'''theMemo:''' The memo to change read-only status of.
*'''status:''' A boolean value indicating whether read-only is to be enabled or disabled.

===Returns===
Returns ''true'' if the status was successfully changed, ''false'' otherwise.

==Example==
[[Category:Needs Example]]
<syntaxhighlight lang="lua">
function memoo()
memo = guiCreateMemo(500, 500, 500, 500, "This is a memo", false)-- We created a memo.
guiMemoSetReadOnly(memo, true)--We made it read only.
end
addEventHandler("onClientResourceStart", getRootElement(), memoo)--We handle our memo.</syntaxhighlight>

==See Also==
{{GUI_functions}}

GuiMemoSetReadOnly

2011-11-19T01:45:55Z

Capy: /* Example */

{{Client function}}
__NOTOC__
This function allows you to set or remove read-only status for a GUI memo. If read-only is set to ''true'', the contents are not editable.

==Syntax==
<syntaxhighlight lang="lua">
bool guiMemoSetReadOnly ( gui-memo theMemo, bool status )
</syntaxhighlight>

===Required Arguments===
*'''theMemo:''' The memo to change read-only status of.
*'''status:''' A boolean value indicating whether read-only is to be enabled or disabled.

===Returns===
Returns ''true'' if the status was successfully changed, ''false'' otherwise.

==Example==
[[Category:Needs Example]]
<syntaxhighlight lang="lua">
function memo()
memo = guiCreateMemo(500, 500, 500, 500, "This is a memo", false)-- We created a memo.
guiMemoSetReadOnly(memo, true)--We made it read only.
end
addEventHandler("onClientResourceStart", getRootElement(), memo)--We handle our memo.</syntaxhighlight>

==See Also==
{{GUI_functions}}

GuiMemoSetReadOnly

2011-11-19T01:45:31Z

Capy: /* Example */

{{Client function}}
__NOTOC__
This function allows you to set or remove read-only status for a GUI memo. If read-only is set to ''true'', the contents are not editable.

==Syntax==
<syntaxhighlight lang="lua">
bool guiMemoSetReadOnly ( gui-memo theMemo, bool status )
</syntaxhighlight>

===Required Arguments===
*'''theMemo:''' The memo to change read-only status of.
*'''status:''' A boolean value indicating whether read-only is to be enabled or disabled.

===Returns===
Returns ''true'' if the status was successfully changed, ''false'' otherwise.

==Example==
[[Category:Needs Example]]
<syntaxhighlight lang="lua">
function memo()
memo = guiCreateMemo(500, 500, 500, 500, "This is a memo", false)-- We created a memo.
guiMemoSetReadOnly(memo, true)--We made it read only.
end
addEventHandler("onClientResourceStart", getRootElement(), memo)--We handle our memo.</syntaxhighlight>

==See Also==
{{GUI_functions}}

GuiMemoSetReadOnly

2011-11-19T01:44:16Z

Capy: /* Example */

{{Client function}}
__NOTOC__
This function allows you to set or remove read-only status for a GUI memo. If read-only is set to ''true'', the contents are not editable.

==Syntax==
<syntaxhighlight lang="lua">
bool guiMemoSetReadOnly ( gui-memo theMemo, bool status )
</syntaxhighlight>

===Required Arguments===
*'''theMemo:''' The memo to change read-only status of.
*'''status:''' A boolean value indicating whether read-only is to be enabled or disabled.

===Returns===
Returns ''true'' if the status was successfully changed, ''false'' otherwise.

==Example==
[[Category:Needs Example]]
<syntaxhighlight lang="lua">
function memo()
memo = guiCreateMemo(500, 500, 500, 500, "This is a memo", false)-- We created a memo.
guiMemoSetReadOnly(false, true)--We made it read only.
end
addEventHandler("onClientResourceStart", getRootElement(), memo)--We handle our memo.</syntaxhighlight>

==See Also==
{{GUI_functions}}

GuiMemoSetReadOnly

2011-11-19T01:43:48Z

Capy: /* Example */

{{Client function}}
__NOTOC__
This function allows you to set or remove read-only status for a GUI memo. If read-only is set to ''true'', the contents are not editable.

==Syntax==
<syntaxhighlight lang="lua">
bool guiMemoSetReadOnly ( gui-memo theMemo, bool status )
</syntaxhighlight>

===Required Arguments===
*'''theMemo:''' The memo to change read-only status of.
*'''status:''' A boolean value indicating whether read-only is to be enabled or disabled.

===Returns===
Returns ''true'' if the status was successfully changed, ''false'' otherwise.

==Example==
[[Category:Needs Example]]
<syntaxhighlight lang="lua">
Function memo()
memo = guiCreateMemo(500, 500, 500, 500, "This is a memo", false)-- We created a memo.
guiMemoSetReadOnly(false, true)--We made it read only.
end
addEventHandler("onClientResourceStart", getRootElement(), memo)</syntaxhighlight>

==See Also==
{{GUI_functions}}

GuiMemoSetReadOnly

2011-11-19T01:42:56Z

Capy: /* Example */

{{Client function}}
__NOTOC__
This function allows you to set or remove read-only status for a GUI memo. If read-only is set to ''true'', the contents are not editable.

==Syntax==
<syntaxhighlight lang="lua">
bool guiMemoSetReadOnly ( gui-memo theMemo, bool status )
</syntaxhighlight>

===Required Arguments===
*'''theMemo:''' The memo to change read-only status of.
*'''status:''' A boolean value indicating whether read-only is to be enabled or disabled.

===Returns===
Returns ''true'' if the status was successfully changed, ''false'' otherwise.

==Example==
[[Category:Needs Example]]

<nowiki>Function memo()
memo = guiCreateMemo(500, 500, 500, 500, "This is a memo", false)-- We created a memo.
guiMemoSetReadOnly(false, true)--We made it read only.
end
addEventHandler("onClientResourceStart", getRootElement(), memo)</nowiki>

==See Also==
{{GUI_functions}}

GuiMemoSetReadOnly

2011-11-19T01:42:22Z

Capy: /* Example */

{{Client function}}
__NOTOC__
This function allows you to set or remove read-only status for a GUI memo. If read-only is set to ''true'', the contents are not editable.

==Syntax==
<syntaxhighlight lang="lua">
bool guiMemoSetReadOnly ( gui-memo theMemo, bool status )
</syntaxhighlight>

===Required Arguments===
*'''theMemo:''' The memo to change read-only status of.
*'''status:''' A boolean value indicating whether read-only is to be enabled or disabled.

===Returns===
Returns ''true'' if the status was successfully changed, ''false'' otherwise.

==Example==
[[Category:Needs Example]]

Function memo()
memo = guiCreateMemo(500, 500, 500, 500, "This is a memo", false)-- We created a memo.
guiMemoSetReadOnly(false, true)--We made it read only.
end
addEventHandler("onClientResourceStart", getRootElement(), memo)

==See Also==
{{GUI_functions}}