Multi Theft Auto: Wiki - User contributions [en]

GuiCreateCheckBox

2010-05-24T11:12:29Z

Extrike:

__NOTOC__
{{Client function}}
This function creates a [[Element/GUI/Checkbox|checkbox]].

==Syntax==
<syntaxhighlight lang="lua">
element guiCreateCheckBox ( float x, float y, float width, float height, string text, bool selected, bool relative, [element parent = nil] )
</syntaxhighlight>

===Required Arguments===
[[Image:Checkbox.png|thumb|Test Checkbox]]
*'''x:''' A float of the 2D x position of the checkbox on a player's screen. This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the checkbox on a player's screen. This is affected by the ''relative'' argument.
*'''width:''' A float of the width of the text field next to the checkbox. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the text field next to the checkbox. This is affected by the ''relative'' argument.
*'''text:''' The text to be displayed next to the checkbox.
*'''selected:''' A boolean representing whether the checkbox created should be selected by default.
*'''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 checkbox 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 [[element]] of the checkbox if it was created succesfully, ''false'' otherwise.

==Example==

This example does...

<syntaxhighlight lang="lua">
--This line does...
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>

==See Also==
{{GUI_functions}}
[[Category:Needs Example]]

File:Checkbox.png

2010-05-24T11:06:50Z

Extrike:

GuiCreateButton

2010-05-24T11:05:13Z

Extrike:

__NOTOC__
{{Client function}}
This function allows creation of a GUI Button, which is a clickable item as part of GUI.

==Syntax==
<syntaxhighlight lang="lua">
element guiCreateButton ( float x, float y, float width, float height, string text, bool relative, [ element parent = nil ] )
</syntaxhighlight>

===Required Arguments===
[[Image:Button.png|thumb|GUI Test Button]]
*'''x:''' A float of the 2D x position of the GUI button on a player's screen. This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the GUI button on a player's screen. This is affected by the ''relative'' argument.
*'''width:''' A float of the width of the GUI button. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the GUI button. This is affected by the ''relative'' argument.
*'''text:''' A string of the text that will be displayed as a label on the button.
*'''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 sizes relative to the parent.


===Optional Arguments===
{{OptionalArg}}
*'''parent:''' This is the parent that the gui button 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 an element of the created button if it was successfully created, false otherwise.

==Example==
This example creates an edit box alongside an "Output!" button. When the button is clicked, it will output the message in the edit box into the Chat Box.
<syntaxhighlight lang="lua">
--create our button
button = guiCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )
--Create an edit box and define it as "editBox".
editBox = guiCreateEdit( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true )
-- and attach our button to the outputEditBox function
addEventHandler ( "onClientGUIClick", editBox, outputEditBox )
guiEditSetMaxLength ( editBox, 128 ) --the max chatbox length is 128, so force this

--setup our function to output the message to the chatbox
function outputEditBox ()
local text = guiGetText ( editBox )--get the text from the edit box
outputChatBox ( text ) --output that text
end
addEventHandler ( "onClientGUIClick", button, outputEditBox )
</syntaxhighlight>

==See Also==
{{GUI_functions}}

GuiCreateButton

2010-05-24T11:05:00Z

Extrike:

__NOTOC__
{{Client function}}
This function allows creation of a GUI Button, which is a clickable item as part of GUI.

==Syntax==
<syntaxhighlight lang="lua">
element guiCreateButton ( float x, float y, float width, float height, string text, bool relative, [ element parent = nil ] )
</syntaxhighlight>

===Required Arguments===
[[Image:Button.png|thumb|GUI Test Button]]
*'''x:''' A float of the 2D x position of the GUI button on a player's screen. This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the GUI button on a player's screen. This is affected by the ''relative'' argument.
*'''width:''' A float of the width of the GUI button. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the GUI button. This is affected by the ''relative'' argument.
*'''text:''' A string of the text that will be displayed as a label on the button.
*'''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 sizes relative to the parent.


===Optional Arguments===
{{OptionalArg}}
*'''parent:''' This is the parent that the gui button 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 an element of the created button if it was successfully created, false otherwise.

==Example==
[[Image:Button.png|thumb|GUI Test Button]]
This example creates an edit box alongside an "Output!" button. When the button is clicked, it will output the message in the edit box into the Chat Box.
<syntaxhighlight lang="lua">
--create our button
button = guiCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )
--Create an edit box and define it as "editBox".
editBox = guiCreateEdit( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true )
-- and attach our button to the outputEditBox function
addEventHandler ( "onClientGUIClick", editBox, outputEditBox )
guiEditSetMaxLength ( editBox, 128 ) --the max chatbox length is 128, so force this

--setup our function to output the message to the chatbox
function outputEditBox ()
local text = guiGetText ( editBox )--get the text from the edit box
outputChatBox ( text ) --output that text
end
addEventHandler ( "onClientGUIClick", button, outputEditBox )
</syntaxhighlight>

==See Also==
{{GUI_functions}}

GuiCreateButton

2010-05-24T11:04:15Z

Extrike:

__NOTOC__
{{Client function}}
This function allows creation of a GUI Button, which is a clickable item as part of GUI.

==Syntax==
<syntaxhighlight lang="lua">
element guiCreateButton ( float x, float y, float width, float height, string text, bool relative, [ element parent = nil ] )
</syntaxhighlight>

===Required Arguments===
*'''x:''' A float of the 2D x position of the GUI button on a player's screen. This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the GUI button on a player's screen. This is affected by the ''relative'' argument.
*'''width:''' A float of the width of the GUI button. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the GUI button. This is affected by the ''relative'' argument.
*'''text:''' A string of the text that will be displayed as a label on the button.
*'''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 sizes relative to the parent.


===Optional Arguments===
{{OptionalArg}}
*'''parent:''' This is the parent that the gui button 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 an element of the created button if it was successfully created, false otherwise.

==Example==
[[Image:Button.png|thumb|GUI Test Button]]
This example creates an edit box alongside an "Output!" button. When the button is clicked, it will output the message in the edit box into the Chat Box.
<syntaxhighlight lang="lua">
--create our button
button = guiCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )
--Create an edit box and define it as "editBox".
editBox = guiCreateEdit( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true )
-- and attach our button to the outputEditBox function
addEventHandler ( "onClientGUIClick", editBox, outputEditBox )
guiEditSetMaxLength ( editBox, 128 ) --the max chatbox length is 128, so force this

--setup our function to output the message to the chatbox
function outputEditBox ()
local text = guiGetText ( editBox )--get the text from the edit box
outputChatBox ( text ) --output that text
end
addEventHandler ( "onClientGUIClick", button, outputEditBox )
</syntaxhighlight>

==See Also==
{{GUI_functions}}

GuiCreateButton

2010-05-24T11:04:00Z

Extrike:

[[Image:Button.png|thumb|GUI Test Button]]
__NOTOC__
{{Client function}}
This function allows creation of a GUI Button, which is a clickable item as part of GUI.

==Syntax==
<syntaxhighlight lang="lua">
element guiCreateButton ( float x, float y, float width, float height, string text, bool relative, [ element parent = nil ] )
</syntaxhighlight>

===Required Arguments===
*'''x:''' A float of the 2D x position of the GUI button on a player's screen. This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the GUI button on a player's screen. This is affected by the ''relative'' argument.
*'''width:''' A float of the width of the GUI button. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the GUI button. This is affected by the ''relative'' argument.
*'''text:''' A string of the text that will be displayed as a label on the button.
*'''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 sizes relative to the parent.


===Optional Arguments===
{{OptionalArg}}
*'''parent:''' This is the parent that the gui button 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 an element of the created button if it was successfully created, false otherwise.

==Example==
This example creates an edit box alongside an "Output!" button. When the button is clicked, it will output the message in the edit box into the Chat Box.
<syntaxhighlight lang="lua">
--create our button
button = guiCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )
--Create an edit box and define it as "editBox".
editBox = guiCreateEdit( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true )
-- and attach our button to the outputEditBox function
addEventHandler ( "onClientGUIClick", editBox, outputEditBox )
guiEditSetMaxLength ( editBox, 128 ) --the max chatbox length is 128, so force this

--setup our function to output the message to the chatbox
function outputEditBox ()
local text = guiGetText ( editBox )--get the text from the edit box
outputChatBox ( text ) --output that text
end
addEventHandler ( "onClientGUIClick", button, outputEditBox )
</syntaxhighlight>

==See Also==
{{GUI_functions}}

GuiCreateButton

2010-05-24T11:03:39Z

Extrike:

__NOTOC__
{{Client function}}
This function allows creation of a GUI Button, which is a clickable item as part of GUI.

[[Image:Button.png|thumb|GUI Test Button]]

==Syntax==
<syntaxhighlight lang="lua">
element guiCreateButton ( float x, float y, float width, float height, string text, bool relative, [ element parent = nil ] )
</syntaxhighlight>

===Required Arguments===
*'''x:''' A float of the 2D x position of the GUI button on a player's screen. This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the GUI button on a player's screen. This is affected by the ''relative'' argument.
*'''width:''' A float of the width of the GUI button. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the GUI button. This is affected by the ''relative'' argument.
*'''text:''' A string of the text that will be displayed as a label on the button.
*'''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 sizes relative to the parent.


===Optional Arguments===
{{OptionalArg}}
*'''parent:''' This is the parent that the gui button 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 an element of the created button if it was successfully created, false otherwise.

==Example==
This example creates an edit box alongside an "Output!" button. When the button is clicked, it will output the message in the edit box into the Chat Box.
<syntaxhighlight lang="lua">
--create our button
button = guiCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )
--Create an edit box and define it as "editBox".
editBox = guiCreateEdit( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true )
-- and attach our button to the outputEditBox function
addEventHandler ( "onClientGUIClick", editBox, outputEditBox )
guiEditSetMaxLength ( editBox, 128 ) --the max chatbox length is 128, so force this

--setup our function to output the message to the chatbox
function outputEditBox ()
local text = guiGetText ( editBox )--get the text from the edit box
outputChatBox ( text ) --output that text
end
addEventHandler ( "onClientGUIClick", button, outputEditBox )
</syntaxhighlight>

==See Also==
{{GUI_functions}}

File:Button.png

2010-05-24T11:03:19Z

Extrike:

IsMTAWindowActive

2010-05-24T10:29:27Z

Extrike: /* Example */

__NOTOC__
{{Client function}}
This function returns whether the any system windows that take focus are active. This includes the chatbox input, console window, main menu and transferbox.
To get the status of the debug view, see [[isDebugViewActive]].

==Syntax==
<syntaxhighlight lang="lua">
bool isMTAWindowActive ()
</syntaxhighlight>

===Returns===
Returns ''true'' if the focus is on the MTA window, ''false'' if isn't.

==Example==
<section name="Client" class="client" show="true">
This function kill a player if it comes out in the standard menu MTA
<syntaxhighlight lang="lua">
function(thePlayer)
if isMTAWindowActive() then
setElementHealth ( thePlayer, 0.0 )
end
end
</syntaxhighlight>
</section>
==See Also==
{{GUI_functions}}

IsMTAWindowActive

2010-05-24T10:29:06Z

Extrike: /* Example */

GetElementRadius

2010-05-24T10:23:25Z

Extrike:

{{Client function}}
__NOTOC__
This function gets the radius from a element.


[[Category:Incomplete]] 

==Syntax==
<syntaxhighlight lang="lua">
float getElementRadius ( element theElement )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The element.

===Returns===
Returns ''float'' as radius, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
Example of how to derive the radius of a player:
<syntaxhighlight lang="lua">
function myCommandHandler(source, command)
local myradius = getElementRadius ( source )
if (myradius) then
outputChatBox("Radius of my player is: " .. myradius)
else
outputChatBox("Error")
end
end

addCommandHandler("getmyradius", myCommandHandler)
</syntaxhighlight>
</section>

==See Also==
{{Client element functions}}

GetElementRadius

2010-05-24T10:22:31Z

Extrike: /* Example */

SpawnVehicle

2010-05-24T10:17:19Z

Extrike: /* Example */

{{Server function}}
__NOTOC__
Spawns a vehicle at any given position and rotation

==Syntax==
<syntaxhighlight lang="lua">
bool spawnVehicle ( vehicle theVehicle, float x, float y, float z [, float rx, float ry, float rz ] )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The vehicle you wish to spawn
*'''x:''' The x position you wish to spawn the vehicle at
*'''y:''' The x position you wish to spawn the vehicle at
*'''z:''' The x position you wish to spawn the vehicle at

===Optional Arguments===
{{OptionalArg}}
*'''rx:''' The x rotation you wish to spawn the vehicle at
*'''ry:''' The y rotation you wish to spawn the vehicle at
*'''rz:''' The z rotation you wish to spawn the vehicle at

===Returns===
Returns ''true'' if the vehicle spawned successfully, ''false'' if the passed argument does not exist or is not a vehicle.

==Example==
<section name="Server" class="server" show="true">
With this feature, we spawn vehicle
<syntaxhighlight lang="lua">
local x, y, z = getElementPosition(source)

function myCommandHandler(source, command)
local RaceVehicle = createVehicle ( 411, 0, 0, 0 )
local spawnVeh = spawnVehicle ( RaceVehicle, x+3, y+3, z ) end
if spawnVeh then outputChatBox("Vehicle was spawned", source) else outputChatBox("Error",source) end
end

addCommandHandler("spawnvehicle", myCommandHandler)
</syntaxhighlight>
</section>

==Related scripting functions==
{{Vehicle functions}}
[[Category:Element Types]]