Multi Theft Auto: Wiki - User contributions [en]

SetVehicleFuelTankExplodable

2021-06-13T14:11:32Z

Xerox8521: Added OOP Syntax Method

__NOTOC__
{{Server client function}}
This function changes the 'explodable state' of a vehicle's fuel tank, which toggles the ability to blow the vehicle up by shooting the tank. This function will have no effect on vehicles with tanks that cannot be shot in single player.

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleFuelTankExplodable ( vehicle theVehicle, bool explodable )
</syntaxhighlight>
{{OOP||[[vehicle]]:setFuelTankExplodable}}

===Required Arguments===
*'''theVehicle''': The [[vehicle]] you wish to change the fuel tank explodable state of.
*'''explodable''': A boolean value representing whether or not the fuel tank will be explodable.

===Returns===
Returns ''true'' if the vehicle's fuel tank explodable state was successfully changed, ''false'' otherwise.

==Example==
<section name="Serverside example" class="server" show="true">
This example will make vehicles' fuel tanks explodable for 10 seconds after they're entered.
<syntaxhighlight lang="lua">
-- create a table to keep track of vulnerable vehicles
-- so we don't set the state-reset timer twice when reentering a vulnerable vehicle
local isVulnerable = {}

-- this function makes a vehicle vulnerable and sets a timer to unset it in 10 seconds
function setVehicleVulnerable ( theVehicle, enteredSeat )
-- we'll ignore vehicles that are already vulnerable.
if not isVulnerable[theVehicle] then
-- if they're getting into the driver seat
if enteredSeat == 0 then
-- make the fuel tank explodable
setVehicleFuelTankExplodable ( theVehicle, true )
-- flag this vehicle as vulnerable
isVulnerable[theVehicle] = true
-- make it non vulnerable in 10 seconds
setTimer ( unsetVehicleVulnerable, 10000, 1, theVehicle )
end
end
end

-- this function makes a vehicle not vulnerable
function unsetVehicleVulnerable ( theVehicle )
-- make the fuel tank unexplodable
setVehicleFuelTankExplodable ( theVehicle, false )
-- remove the vulnerable flag
isVulnerable[theVehicle] = nil
end

-- add the 'makeVehicleVulnerable' function as a handler for "onPlayerVehicleEnter"
addEventHandler ( "onPlayerVehicleEnter", root, setVehicleVulnerable )
</syntaxhighlight>
</section>

==See Also==
{{Vehicle functions}}

SetElementCollidableWith

2019-11-04T17:06:25Z

Xerox8521: /* Example */

{{Client function}}
__NOTOC__
This function can be used to set an element to collide with another element. An element with collisions disabled does not interact physically with the other element.<br>
'''Note:''' You can only use this function with the element types listed below.
*[[Player]]
*[[Ped]]
*[[Vehicle]]
*[[Object]]

==Syntax==
<syntaxhighlight lang="lua">
bool setElementCollidableWith ( element theElement, element withElement, bool enabled )
</syntaxhighlight>
{{OOP||[[element]]:setCollidableWith||isElementCollidableWith}}

===Required Arguments===
*'''theElement:''' The [[element]] which colliding you want to change
*'''withElement:''' The other [[element]] you wish the first entity to collide with
*'''enabled:''' A boolean to indicate whether elements should be able to collide with eachother (''true'') or not (''false'')

===Returns===
Returns ''true'' if the collisions were set succesfully, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function ghostmode_on()
local playerVehicle = getPedOccupiedVehicle(localPlayer) -- Get the players vehicle
if(playerVehicle) then -- Check the return value.
for i,v in pairs(getElementsByType("vehicle")) do --LOOP through all vehicles
setElementCollidableWith(v, playerVehicle, false) -- Set the collison off with the other vehicles.
end
outputChatBox("You are now a Ghost")
end
end
addCommandHandler("ghostmode", ghostmode_on) -- Add the /ghostmode Command.
</syntaxhighlight>
</section>

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

SetElementCollidableWith

2019-11-04T17:04:58Z

Xerox8521: /* Example */

{{Client function}}
__NOTOC__
This function can be used to set an element to collide with another element. An element with collisions disabled does not interact physically with the other element.<br>
'''Note:''' You can only use this function with the element types listed below.
*[[Player]]
*[[Ped]]
*[[Vehicle]]
*[[Object]]

==Syntax==
<syntaxhighlight lang="lua">
bool setElementCollidableWith ( element theElement, element withElement, bool enabled )
</syntaxhighlight>
{{OOP||[[element]]:setCollidableWith||isElementCollidableWith}}

===Required Arguments===
*'''theElement:''' The [[element]] which colliding you want to change
*'''withElement:''' The other [[element]] you wish the first entity to collide with
*'''enabled:''' A boolean to indicate whether elements should be able to collide with eachother (''true'') or not (''false'')

===Returns===
Returns ''true'' if the collisions were set succesfully, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function ghostmode_on()
local playerVehicle = getPedOccupiedVehicle(localPlayer) -- Get the players vehicle
if(playerVehicle) then -- Check the return value.
for index,vehicle in pairs(getElementsByType("vehicle")) do --LOOP through all vehicles
setElementCollidableWith(vehicle, playerVehicle, false) -- Set the collison off with the other vehicles.
end
outputChatBox("You are now a Ghost")
end
end
addCommandHandler("ghostmode", ghostmode_on) -- Add the /ghostmode Command.
</syntaxhighlight>
</section>

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

SetElementCollidableWith

2019-11-04T16:56:55Z

Xerox8521: No need for ipairs when pairs is more than enough. | Removed player argument in outputChatbox as the client version doesn't require it.

{{Client function}}
__NOTOC__
This function can be used to set an element to collide with another element. An element with collisions disabled does not interact physically with the other element.<br>
'''Note:''' You can only use this function with the element types listed below.
*[[Player]]
*[[Ped]]
*[[Vehicle]]
*[[Object]]

==Syntax==
<syntaxhighlight lang="lua">
bool setElementCollidableWith ( element theElement, element withElement, bool enabled )
</syntaxhighlight>
{{OOP||[[element]]:setCollidableWith||isElementCollidableWith}}

===Required Arguments===
*'''theElement:''' The [[element]] which colliding you want to change
*'''withElement:''' The other [[element]] you wish the first entity to collide with
*'''enabled:''' A boolean to indicate whether elements should be able to collide with eachother (''true'') or not (''false'')

===Returns===
Returns ''true'' if the collisions were set succesfully, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">

function ghostmode_on()
local v = getPedOccupiedVehicle(localPlayer) -- Get her's Vehicle ID
for index,vehicle in pairs(getElementsByType("vehicle")) do --LOOP through all Vehicles
setElementCollidableWith(vehicle, v, false) -- Set the Collison off with the other vehicles.
end
outputChatBox("You are now a Ghost :P")
end
addCommandHandler("ghostmode", ghostmode_on) -- Add the /ghostmode Command.

</syntaxhighlight>
</section>

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

GuiStaticImageLoadImage

2019-08-07T12:03:50Z

Xerox8521: Added OOP Method + Variable Information

{{Client function}}
__NOTOC__
This function allows you to change the image in GUI static image element to another one. '''Tip''': If you set other images as children you will have to use [[setElementCallPropagationEnabled]] to only affect the parent image.

==Syntax==
<syntaxhighlight lang="lua">
bool guiStaticImageLoadImage ( element theElement, string filename )
</syntaxhighlight>
{{OOP||[[Element/GUI/Static_image|GuiStaticImage]]:loadImage|image}}
===Required Arguments===
*'''theElement:''' The static image element to be changed.
*'''filename:''' A string specifying the [[filepath]] of the image file being loaded in current resource.

===Returns===
Returns ''true'' if the the image in the static image element was successfully changed, ''false'' otherwise.

==Example==
This example creates a static image ("myimage.png") and replaces it with other image ("otherimage.png") 10 seconds after creation.
<syntaxhighlight lang="lua">
local myImage = guiCreateStaticImage( 0.45, 0.48, 0.2, 0.5, "myimage.png", true )
setTimer( guiStaticImageLoadImage, 10000, 1, myImage, "otherimage.png" )
</syntaxhighlight>

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

GuiCreateStaticImage

2019-08-07T11:57:39Z

Xerox8521: Added OOP Method Information

__NOTOC__
{{Client function}}
This function creates a static image using a .png image in the resource.

==Syntax==
<syntaxhighlight lang="lua">
element guiCreateStaticImage ( float x, float y, float width, float height, string path, bool relative, [element parent = nil] )
</syntaxhighlight>
{{OOP||[[Element/GUI/Static_image|GuiStaticImage]]}}
===Required Arguments===
[[Image:gui-staticimage.png|frame|Example GUI static image.]]
*'''x:''' A float of the 2D x position of the image on a player's screen. This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the image on a player's screen. This is affected by the ''relative'' argument.
*'''width:''' A float of the width of the image. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the image. This is affected by the ''relative'' argument.
*'''path:''' The [[filepath]] of the image file that is being loaded.
*'''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 image 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]] if image was created successfully, ''false'' otherwise.

==Example==
This example will display an image (imagename.png) on the client's (player's) screen.
<section name="Client-side script (example.lua)" class="client" show="true">
<syntaxhighlight lang="lua">
function showClientImage()
guiCreateStaticImage( 20, 200, 100, 100, "imagename.png", false )
end
addEventHandler( "onClientResourceStart", getResourceRootElement( getThisResource() ), showClientImage )
</syntaxhighlight>
</section>

<section name="meta.xml" class="server" show="true">
In this example [[Meta.xml]] is used to tell the server which files it will be using.
<syntaxhighlight lang="xml">
<meta>
<info author="Yourname" version="1.0" />
<script src="example.lua" type="client" />
<file src="imagename.png" />
</meta>
</syntaxhighlight>
</section>

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

GuiDeleteTab

2019-08-07T11:51:33Z

Xerox8521: Added OOP Method Information

__NOTOC__
{{Client function}}
This function deletes a tab from a tab panel.

==Syntax==
<syntaxhighlight lang="lua">
bool guiDeleteTab ( element tabToDelete, element tabPanel )
</syntaxhighlight>
{{OOP||[[Element/GUI/Tab|GuiTab]]:delete}}
===Required Arguments===
*'''tabToDelete:''' This is an element representing the tab that you want to delete.
*'''tabPanel:''' This is the [[guiCreateTabPanel|tab panel]] parent that the tab is attached to.

===Returns===
Returns ''true'' the tab was successfully deleted, ''false'' otherwise.

==Example==
This example removes a tab panel if a user LeftCtrl+Clicks a tab panel.
<syntaxhighlight lang="lua">
function deleteTabOnClick ()
if ( getKeyState ( "lctrl" ) == true ) and ( getElementType( source ) == "gui-tab" ) then -- if the user is holding down left control
guiDeleteTab ( source, getElementParent(source) ) -- delete the tab. No need to check if it was actually a tab that was clicked, as this function doesn't work on other controls anyway
end
end
addEventHandler ( "onClientGUIClick", getRootElement(), deleteTabOnClick ) -- add an event handler for clicks
</syntaxhighlight>

==See Also==
{{GUI functions}}
{{GUI_events}}

GuiLabelSetVerticalAlign

2019-08-07T11:48:29Z

Xerox8521: Added OOP Method + Variable Information

{{Client function}}
__NOTOC__
This function sets the vertical alignment of a text label.

==Syntax==
<syntaxhighlight lang="lua">
bool guiLabelSetVerticalAlign ( element theLabel, string align )
</syntaxhighlight>
{{OOP||[[Element/GUI/Text label|GuiLabel]]:setVerticalAlign|verticalAlign}}
===Required Arguments===
*'''theLabel:''' The text label to set the vertical alignment on.
*'''align:''' The alignment type. Valid type strings are:
**"top"
**"center"
**"bottom"

===Returns===
Returns ''true'' on success, ''false'' otherwise.

==Example==
<section name="Example 1" class="client" show="true"><syntaxhighlight lang="lua">local label = guiCreateLabel(300,200,100,500,"Text",false)
guiLabelSetVerticalAlign(label,"bottom")</syntaxhighlight></section>
==See Also==
{{GUI functions}}
{{GUI_events}}

GuiLabelSetHorizontalAlign

2019-08-07T11:47:25Z

Xerox8521: Added OOP Method + Variable Information

{{Client function}}
__NOTOC__
This function sets the horizontal alignment of a text label.

==Syntax==
<syntaxhighlight lang="lua">
bool guiLabelSetHorizontalAlign ( element theLabel, string align, [ bool wordwrap = false ] )
</syntaxhighlight>
{{OOP||[[Element/GUI/Text label|GuiLabel]]:setHorizontalAlign|horizontalAlign}}
===Required Arguments===
*'''theLabel:''' The text label to set the horizontal alignment on.
*'''align:''' The alignment type. Valid type strings are:
**"left"
**"center"
**"right"
*'''wordwrap:''' Whether or not to enable wordwrap for the gui-label.

===Returns===
Returns ''true'' on success, ''false'' otherwise.

==Example==
<section name="Example 1" class="client" show="true"><syntaxhighlight lang="lua">local label = guiCreateLabel(300,200,500,50,"Text",false)
guiLabelSetHorizontalAlign(label,"center")</syntaxhighlight></section>
==See Also==
{{GUI functions}}
{{GUI_events}}

GuiLabelGetTextExtent

2019-08-07T11:45:41Z

Xerox8521: Added OOP Method + Variable Information

{{Client function}}
__NOTOC__
This function returns the extent, or width, of the current text inside a GUI text label.

==Syntax==
<syntaxhighlight lang="lua">
float guiLabelGetTextExtent ( element theLabel )
</syntaxhighlight>
{{OOP||[[Element/GUI/Text label|GuiLabel]]:getTextExtent|textExtent}}
===Required Arguments===
*'''theLabel:''' The text label to get the text extent from.

===Returns===
Returns the absolute width of the current text inside the text label if the function is successful, ''false'' otherwise.

==Example==
This example creates a window, a text label, gets the text extent and font height, and sets the text label size according to these values.
<syntaxhighlight lang="lua">
-- create the window (the container for our label)
local myWindow = guiCreateWindow ( 0, 0, 0.5, 0.4, "Information", true )

-- create the label
local myLabel = guiCreateLabel ( 10, 10, 0, 0, "This is my text container", false, myWindow )

-- get the (absolute) text extent and font height, and use these to size the label
guiSetSize ( myLabel, guiLabelGetTextExtent ( myLabel ), guiLabelGetFontHeight ( myLabel ), false )
</syntaxhighlight>

==See Also==
{{GUI functions}}
{{GUI_events}}

GuiLabelGetFontHeight

2019-08-07T11:44:52Z

Xerox8521: Added OOP Method + Variable Information

{{Client function}}
__NOTOC__
This function returns the height of the font currently used in a GUI text label.

==Syntax==
<syntaxhighlight lang="lua">
float guiLabelGetFontHeight ( element theLabel )
</syntaxhighlight>
{{OOP||[[Element/GUI/Text label|GuiLabel]]:getFontHeight|fontHeight}}
===Required Arguments===
*'''theLabel:''' The text label to get the font height from.

===Returns===
Returns the absolute height of the font currently used in the text label if the function is successful, ''false'' otherwise.

==Example==
This example creates a window, a text label, gets the text extent and font height, and sets the text label size according to these values.
<syntaxhighlight lang="lua">
-- create the window (the container for our label)
local myWindow = guiCreateWindow ( 0, 0, 0.5, 0.4, "Information", true )

-- create the label
local myLabel = guiCreateLabel ( 10, 10, 0, 0, "This is my text container", false, myWindow )

-- get the (absolute) text extent and font height, and use these to size the label
guiSetSize ( myLabel, guiLabelGetTextExtent ( myLabel ), guiLabelGetFontHeight ( myLabel ), false )
</syntaxhighlight>

==See Also==
{{GUI functions}}
{{GUI_events}}

GuiLabelSetColor

2019-08-07T11:41:19Z

Xerox8521: Added OOP Method + Counterpart Information

{{Client function}}
__NOTOC__

This function allows you to set the color of a GUI label.

==Syntax==

<syntaxhighlight lang="lua">
bool guiLabelSetColor ( element theElement, int red, int green, int blue )
</syntaxhighlight>
{{OOP||[[Element/GUI/Text label|GuiLabel]]:setColor||guiLabelGetColor}}

===Required Arguments===

*'''theElement:''' The label to be changed.
*'''red:''' An integer specifying the amount of red (0 to 255).
*'''green:''' An integer specifying the amount of green (0 to 255).
*'''blue:''' An integer specifying the amount of blue (0 to 255).

===Returns===

Returns ''true'' if the the color of the gui label was successfully changed, ''false'' otherwise.

==Example==
This example creates a label with text "Hello World!" and sets it to a random color.
<syntaxhighlight lang="lua">local myLabel = guiCreateLabel ( 0.45, 0.48, 0.2, 0.5, "Hello world", true )
guiLabelSetColor ( myLabel, math.random(0, 255), math.random(0, 255), math.random(0, 255) )</syntaxhighlight>

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

GuiLabelGetColor

2019-08-07T11:40:07Z

Xerox8521: Added OOP Method + Counterpart Information

__NOTOC__
{{Client function}}
{{New feature/item|3.0132|1.3.1|4670|
This function gets the color of a label.
}}

==Syntax==
<syntaxhighlight lang="lua">
int int int guiLabelGetColor ( gui-element theLabel )
</syntaxhighlight>
{{OOP||[[Element/GUI/Text label|GuiLabel]]:getColor||guiLabelSetColor}}
===Required Arguments===
*'''theLabel:''' The label to get color.

===Returns===
Returns three ''int'' values, representing the amount of red, green, blue if successful. ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">local pLabel = guiCreateLabel( 0.5, 0.5, 0.5, 0.5, 'Text', true )
guiLabelSetColor( pLabel, math.random( 0, 255 ), math.random( 0, 255 ), math.random( 0, 255 ) )

addCommandHandler( 'get_color_label',
function()
local iR, iG, iB = guiLabelGetColor( pLabel )
outputChatBox( ( 'Label color is r = %d, g = %d, b = %d' ):format( iR, iG, iB ) )
end
)</syntaxhighlight>

==See Also==
{{GUI functions}}
{{GUI_events}}

GuiWindowSetSizable

2019-08-07T11:35:01Z

Xerox8521: Added OOP Counterpart Information

{{Client function}}
__NOTOC__
This function enables or disables user resizing of a GUI window.

==Syntax==
<syntaxhighlight lang="lua">
bool guiWindowSetSizable ( element theElement, bool status )
</syntaxhighlight>
{{OOP||[[Element/GUI/Window|GuiWindow]]:setSizable|sizable|guiWindowIsSizable}}

===Required Arguments===
*'''theElement:''' The window to be changed.
*'''status:''' A boolean value indicating whether user resizing is to be enabled or disabled.

===Returns===
Returns ''true'' if the function is successful, ''false'' otherwise.

==Example==
This example creates a gui window and sets it to be not sizable
<syntaxhighlight lang="lua">
function initialize ()
-- Create a gui window
local window = guiCreateWindow ( 0.50, 0.50, 0.25, 0.25, "Test", true )
-- set it to be not sizable
guiWindowSetSizable ( window, false )
-- Show cursor to check if our changes work fine
showCursor ( true )
end
addEventHandler ( "onClientResourceStart", resourceRoot, initialize )
</syntaxhighlight>

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

GuiWindowIsSizable

2019-08-07T11:34:29Z

Xerox8521: Added OOP Variable + Counterpart Information

{{Client function}}
__NOTOC__
{{New feature/item|3.0156|1.5.5|13823|This function checks if a GUI window is sizable.}}

==Syntax==
<syntaxhighlight lang="lua">
bool guiWindowIsSizable ( gui-window guiWindow )
</syntaxhighlight>
{{OOP|||sizable|guiWindowSetSizable}}
===Required Arguments===
*'''guiWindow:''' the window to check the sizable flag of

===Returns===
Returns ''true'' if the window is sizable, ''false'' if not, ''nil'' if an invalid window was provided.

==Example==
<syntaxhighlight lang="lua">
addEventHandler( "onClientResourceStart", resourceRoot,
function( )
local window = guiCreateWindow( 0.5, 0.5, 0.22, 0.22, "isSizable window", true )
guiWindowSetSizable( window, false ) -- make it unsizable
addCommandHandler( "isSizable",
function( )
local sizable = guiWindowIsSizable( window ) -- check the window sizable flag
outputChatBox( "Window is " .. ( sizable and "sizable" or "unsizable" ) ) -- show info about the window
end
)
end
)
</syntaxhighlight>

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

GuiWindowSetMovable

2019-08-07T11:31:42Z

Xerox8521: Added OOP Counterpart Information

{{Client function}}
__NOTOC__
This function allows you to specify whether or not a user can move a GUI window.

==Syntax==
<syntaxhighlight lang="lua">
bool guiWindowSetMovable ( element theElement, bool status )
</syntaxhighlight>
{{OOP||[[Element/GUI/Window|GuiWindow]]:setMovable|movable|guiWindowIsMovable}}

===Required Arguments===
*'''theElement:''' The window to be changed.
*'''status:''' A boolean value indicating whether the window is movable or not.

===Returns===
Returns ''true'' if the function is successful, ''false'' otherwise.

==Example==
This example creates a gui window and sets it to be not movable
<syntaxhighlight lang="lua">
function initialize ()
-- Create a gui window
local window = guiCreateWindow ( 0.50, 0.50, 0.25, 0.25, "Test", true )
-- set it to be not movable
guiWindowSetMovable ( window, false )
-- Show cursor to check if our changes work fine
showCursor ( true )
end
addEventHandler ( "onClientResourceStart", resourceRoot, initialize )
</syntaxhighlight>

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

GuiWindowIsMovable

2019-08-06T18:21:59Z

Xerox8521: Added OOP Variable + Counterpart Information

{{Client function}}
__NOTOC__
{{New feature/item|3.0156|1.5.5|13823|This function checks if a GUI window is movable.}}

==Syntax==
<syntaxhighlight lang="lua">
bool guiWindowIsMovable ( gui-window guiWindow )
</syntaxhighlight>
{{OOP|||movable|guiWindowSetMovable}}
===Required Arguments===
*'''guiWindow:''' the window to check the movable flag of

===Returns===
Returns ''true'' if the window is movable, ''false'' if not, ''nil'' if an invalid window was provided.

==Example==
<syntaxhighlight lang="lua">
addEventHandler( "onClientResourceStart", resourceRoot,
function( )
local window = guiCreateWindow( 0.5, 0.5, 0.22, 0.22, "isMovable window", true )
guiWindowSetMovable( window, false ) -- make it unmovable
addCommandHandler( "isMovable",
function( )
local movable = guiWindowIsMovable( window ) -- check the window movable flag
outputChatBox( "Window is " .. ( movable and "movable" or "unmovable" ) ) -- show info about the window
end
)
end
)
</syntaxhighlight>

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

GuiWindowSetMovable

2019-08-06T18:16:24Z

Xerox8521: Added OOP Variable declaration.

{{Client function}}
__NOTOC__
This function allows you to specify whether or not a user can move a GUI window.

==Syntax==
<syntaxhighlight lang="lua">
bool guiWindowSetMovable ( element theElement, bool status )
</syntaxhighlight>
{{OOP||[[Element/GUI/Window|GuiWindow]]:setMovable|movable}}

===Required Arguments===
*'''theElement:''' The window to be changed.
*'''status:''' A boolean value indicating whether the window is movable or not.

===Returns===
Returns ''true'' if the function is successful, ''false'' otherwise.

==Example==
This example creates a gui window and sets it to be not movable
<syntaxhighlight lang="lua">
function initialize ()
-- Create a gui window
local window = guiCreateWindow ( 0.50, 0.50, 0.25, 0.25, "Test", true )
-- set it to be not movable
guiWindowSetMovable ( window, false )
-- Show cursor to check if our changes work fine
showCursor ( true )
end
addEventHandler ( "onClientResourceStart", resourceRoot, initialize )
</syntaxhighlight>

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

GuiWindowSetSizable

2019-08-06T18:15:40Z

Xerox8521: Added OOP Variable declaration.

{{Client function}}
__NOTOC__
This function enables or disables user resizing of a GUI window.

==Syntax==
<syntaxhighlight lang="lua">
bool guiWindowSetSizable ( element theElement, bool status )
</syntaxhighlight>
{{OOP||[[Element/GUI/Window|GuiWindow]]:setSizable|sizable}}

===Required Arguments===
*'''theElement:''' The window to be changed.
*'''status:''' A boolean value indicating whether user resizing is to be enabled or disabled.

===Returns===
Returns ''true'' if the function is successful, ''false'' otherwise.

==Example==
This example creates a gui window and sets it to be not sizable
<syntaxhighlight lang="lua">
function initialize ()
-- Create a gui window
local window = guiCreateWindow ( 0.50, 0.50, 0.25, 0.25, "Test", true )
-- set it to be not sizable
guiWindowSetSizable ( window, false )
-- Show cursor to check if our changes work fine
showCursor ( true )
end
addEventHandler ( "onClientResourceStart", resourceRoot, initialize )
</syntaxhighlight>

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

GuiWindowSetSizable

2019-08-06T18:12:39Z

Xerox8521: Added OOP Method declaration

{{Client function}}
__NOTOC__
This function enables or disables user resizing of a GUI window.

==Syntax==
<syntaxhighlight lang="lua">
bool guiWindowSetSizable ( element theElement, bool status )
</syntaxhighlight>
{{OOP||[[Element/GUI/Window|GuiWindow]]:setSizable}}

===Required Arguments===
*'''theElement:''' The window to be changed.
*'''status:''' A boolean value indicating whether user resizing is to be enabled or disabled.

===Returns===
Returns ''true'' if the function is successful, ''false'' otherwise.

==Example==
This example creates a gui window and sets it to be not sizable
<syntaxhighlight lang="lua">
function initialize ()
-- Create a gui window
local window = guiCreateWindow ( 0.50, 0.50, 0.25, 0.25, "Test", true )
-- set it to be not sizable
guiWindowSetSizable ( window, false )
-- Show cursor to check if our changes work fine
showCursor ( true )
end
addEventHandler ( "onClientResourceStart", resourceRoot, initialize )
</syntaxhighlight>

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

GuiWindowSetMovable

2019-08-06T18:08:09Z

Xerox8521: Added OOP Method declaration

{{Client function}}
__NOTOC__
This function allows you to specify whether or not a user can move a GUI window.

==Syntax==
<syntaxhighlight lang="lua">
bool guiWindowSetMovable ( element theElement, bool status )
</syntaxhighlight>
{{OOP||[[Element/GUI/Window|GuiWindow]]:setMovable}}

===Required Arguments===
*'''theElement:''' The window to be changed.
*'''status:''' A boolean value indicating whether the window is movable or not.

===Returns===
Returns ''true'' if the function is successful, ''false'' otherwise.

==Example==
This example creates a gui window and sets it to be not movable
<syntaxhighlight lang="lua">
function initialize ()
-- Create a gui window
local window = guiCreateWindow ( 0.50, 0.50, 0.25, 0.25, "Test", true )
-- set it to be not movable
guiWindowSetMovable ( window, false )
-- Show cursor to check if our changes work fine
showCursor ( true )
end
addEventHandler ( "onClientResourceStart", resourceRoot, initialize )
</syntaxhighlight>

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