Multi Theft Auto: Wiki - User contributions [en]

GetElementColShape

2015-03-08T08:40:52Z

JR10: Corrected the OOP variable

{{Server client function}}
__NOTOC__
This function is used to get element's colshape.

==Syntax==
<syntaxhighlight lang="lua">
colshape getElementColShape ( element theElement )
</syntaxhighlight>
{{OOP||[[element]]:getColShape|colShape|}}

===Required Arguments===
*'''theElement:''' The element you want to get the colshape of

===Returns===
Returns ''colshape'' of the element, ''false'' if not or an invalid argument was passed to the function.

==Example==
<section class="server" name="Server" show="true">
This example creates a marker inside Toreno's house and adds a command to check whether you are standing on it.
<syntaxhighlight lang="lua">
theMarker = createMarker( -687.9, 937.8, 13.6, "cylinder", 2.0, 255, 0, 0, 80 ) -- create a red cylinder marker inside Toreno's house

function checkOnMarker ( thePlayer )
local isIn = isPlayerInMarker( thePlayer, theMarker ) -- use the function to check if player is in the marker
if isIn then
outputChatBox( "You are on the marker.", thePlayer )
else
outputChatBox( "You are not on the marker.", thePlayer )
end
end
addCommandHandler ( "amionmarker", checkOnMarker )

-- define the isPlayerInMarker function
function isPlayerInMarker( thePlayer, theMarker )
local theShape = getElementColShape( theMarker ) -- get markers colshape
if isElementWithinColShape( thePlayer, theShape ) then -- check if the player is in it
return true
else -- he isn't on the marker
return false
end
end
</syntaxhighlight>
</section>

==See Also==
{{Element_functions}}

XmlSaveFile

2015-02-13T23:00:25Z

JR10: Fixed OOP syntax

__NOTOC__
{{Server client function}}
This function saves a loaded XML file.

==Syntax==
<syntaxhighlight lang="lua">bool xmlSaveFile ( xmlnode rootNode ) </syntaxhighlight>
{{OOP||[[xmlnode]]:saveFile}}
===Required Arguments===
*'''rootNode:''' the root [[xmlnode]] of the loaded XML file.

===Returns===
Returns ''true'' if save was successful, ''false'' if the XML file does not exist.

==Example==
<section name="Client" class="client" show="true">
This example allows a player to use the command 'createfile' to create an .xml file.
<syntaxhighlight lang="lua">
-- Creates a file named "new.xml" with root node "newroot" and childnode "newchild".
function createFileHandler()
local RootNode = xmlCreateFile("new.xml"," newroot")
local NewNode = xmlCreateChild(RootNode, "newchild")
xmlSaveFile(RootNode)
end

addCommandHandler("createfile", createFileHandler)
</syntaxhighlight>
</section>

==See Also==
{{XML_functions}}
[[ru:xmlSaveFile]]

2011-09-13T15:33:53Z

JR10:

UtfChar

2011-09-13T15:32:46Z

JR10: Created page with "__NOTOC__ {{Server client function}} The function returns the string of the specified UTF code. ==Syntax== <syntaxhighlight lang="lua"> string utfChar ( int characterCode ) </syntaxhighlight> ===Require..."

UtfCode

2011-09-13T15:32:15Z

UtfSub

2011-09-13T15:30:23Z

JR10: Created page with "__NOTOC__ {{Server client function}} The function returns a sub string, from the specified positions on a character. ==Syntax== <syntaxhighlight lang="lua"> string utfSub( string theString, in..."

UtfSeek

2011-09-13T15:28:09Z

JR10: Created page with "__NOTOC__ {{Server client function}} The function returns the byte position at specified character position. ==Syntax== <syntaxhighlight lang="lua"> int utfSeek ( string theString, int positio..."

2011-09-04T00:44:48Z

JR10: /* Example */

{{Client function}}
__NOTOC__
Alpha represents the transparency of a gui element. This function allows retrieval of a gui element's current alpha.

==Syntax==
<syntaxhighlight lang="lua">
float guiGetAlpha ( element guiElement )
</syntaxhighlight>

===Required Arguments===
*'''guiElement:''' The gui element in which you want to retrieve the alpha of.

===Returns===
This function returns a positive integer in between 0 and 1 of the gui element's current alpha, or false if it could not be retrieved.

==Example==
This example provides a ''fadeElement'' function, which fades roughly over a period of 4 seconds. The user may fade in or fade out an element
<syntaxhighlight lang="lua">
function fadeElement ( guiElement, state )
if state == "out" then --if the user specifies he wants to fade out an element
local currentAlpha = guiGetAlpha ( guiElement )--get the current alpha
local newAlpha = currentAlpha - 0.4 --set the alpha to 4 less (more transparent)
--ensure that the alpha is not below 0, if it is, set it to 0
if newAlpha < 0 then newAlpha = 0 end
--set the new alpha
guiSetAlpha ( guiElement, newAlpha )
--if the new alpha is not completely invisible already
if newAlpha ~= 0 then
--call this function to fade out some more 50ms later
setTimer ( fadeElement, 50, 1, guiElement, state )
end
elseif state == "in" then --else, if the user specifies he wants to fade out an element
local currentAlpha = guiGetAlpha ( guiElement )--get the current alpha
local newAlpha = currentAlpha + 0.4 --set the alpha to 4 more(less transparent)
--ensure that the alpha is not above 255, if it is, set it to 255
if newAlpha > 1 then newAlpha = 1 end
--set the new alpha
guiSetAlpha ( guiElement, newAlpha )
--if the new alpha is not completely opaque already
if newAlpha ~= 1 then
--call this function to fade in some more 50ms later
setTimer ( fadeElement, 50, 1, guiElement, state )
end
end
end
</syntaxhighlight>

==See Also==
{{GUI_functions}}

GuiGetAlpha

2011-09-04T00:44:23Z

JR10:

GuiGetAlpha

2011-09-04T00:42:30Z

JR10: /* Returns */

{{Client function}}
__NOTOC__
Alpha represents the transparency of a gui element. This function allows retrieval of a gui element's current alpha.

==Syntax==
<syntaxhighlight lang="lua">
int guiGetAlpha ( element guiElement )
</syntaxhighlight>

===Required Arguments===
*'''guiElement:''' The gui element in which you want to retrieve the alpha of.

===Returns===
{{Needs Checking|Alpha is between 0 and 1 , see [[guiSetAlpha]] !}}
This function returns a positive integer in between 0 and 255 of the gui element's current alpha, or false if it could not be retrieved.

==Example==
This example provides a ''fadeElement'' function, which fades roughly over a period of 4 seconds. The user may fade in or fade out an element
<syntaxhighlight lang="lua">
function fadeElement ( guiElement, state )
if state == "out" then --if the user specifies he wants to fade out an element
local currentAlpha = guiGetAlpha ( guiElement )--get the current alpha
local newAlpha = currentAlpha - 4 --set the alpha to 4 less (more transparent)
--ensure that the alpha is not below 0, if it is, set it to 0
if newAlpha < 0 then newAlpha = 0 end
--set the new alpha
guiSetAlpha ( guiElement, newAlpha )
--if the new alpha is not completely invisible already
if newAlpha ~= 0 then
--call this function to fade out some more 50ms later
setTimer ( fadeElement, 50, 1, guiElement, state )
end
elseif state == "in" then --else, if the user specifies he wants to fade out an element
local currentAlpha = guiGetAlpha ( guiElement )--get the current alpha
local newAlpha = currentAlpha + 4 --set the alpha to 4 more(less transparent)
--ensure that the alpha is not above 255, if it is, set it to 255
if newAlpha > 255 then newAlpha = 255 end
--set the new alpha
guiSetAlpha ( guiElement, newAlpha )
--if the new alpha is not completely opaque already
if newAlpha ~= 255 then
--call this function to fade in some more 50ms later
setTimer ( fadeElement, 50, 1, guiElement, state )
end
end
end
</syntaxhighlight>

==See Also==
{{GUI_functions}}

GuiGetAlpha

2011-09-04T00:41:01Z

JR10: /* Returns */

{{Client function}}
__NOTOC__
Alpha represents the transparency of a gui element. This function allows retrieval of a gui element's current alpha.

==Syntax==
<syntaxhighlight lang="lua">
int guiGetAlpha ( element guiElement )
</syntaxhighlight>

===Required Arguments===
*'''guiElement:''' The gui element in which you want to retrieve the alpha of.

===Returns===
This function returns a positive integer in between 0 and 1 of the gui element's current alpha, or false if it could not be retrieved.

==Example==
This example provides a ''fadeElement'' function, which fades roughly over a period of 4 seconds. The user may fade in or fade out an element
<syntaxhighlight lang="lua">
function fadeElement ( guiElement, state )
if state == "out" then --if the user specifies he wants to fade out an element
local currentAlpha = guiGetAlpha ( guiElement )--get the current alpha
local newAlpha = currentAlpha - 4 --set the alpha to 4 less (more transparent)
--ensure that the alpha is not below 0, if it is, set it to 0
if newAlpha < 0 then newAlpha = 0 end
--set the new alpha
guiSetAlpha ( guiElement, newAlpha )
--if the new alpha is not completely invisible already
if newAlpha ~= 0 then
--call this function to fade out some more 50ms later
setTimer ( fadeElement, 50, 1, guiElement, state )
end
elseif state == "in" then --else, if the user specifies he wants to fade out an element
local currentAlpha = guiGetAlpha ( guiElement )--get the current alpha
local newAlpha = currentAlpha + 4 --set the alpha to 4 more(less transparent)
--ensure that the alpha is not above 255, if it is, set it to 255
if newAlpha > 255 then newAlpha = 255 end
--set the new alpha
guiSetAlpha ( guiElement, newAlpha )
--if the new alpha is not completely opaque already
if newAlpha ~= 255 then
--call this function to fade in some more 50ms later
setTimer ( fadeElement, 50, 1, guiElement, state )
end
end
end
</syntaxhighlight>

==See Also==
{{GUI_functions}}

CreateVehicle

2011-07-10T00:48:50Z

JR10: /* Example */

{{Needs_Checking|Numberplates only seem to work for some vehicles, and then only for the front or rear plate only}}
__NOTOC__
{{Server client function}}
This function creates a vehicle at the specified location.

Its worth noting that the position of the vehicle is the center point of the vehicle, not its base. As such, you need to ensure that the z value (vertical axis) is some height above the ground. You can find the exact height using the client side function [[getElementDistanceFromCentreOfMassToBaseOfModel]], or you can estimate it yourself and just spawn the vehicle so it drops to the ground.

'''Important Note:''' Vehicles (and other elements) created client-side are only seen by the client that created them, aren't synced and players cannot enter them. They are essentially for display only.

==Syntax==
<syntaxhighlight lang="lua">
vehicle createVehicle ( int model, float x, float y, float z, [float rx, float ry, float rz, string numberplate] )
</syntaxhighlight>

===Required Arguments===
* '''model''': The [[Vehicle IDs|vehicle ID]] of the vehicle being created.
* '''x''': A floating point number representing the X coordinate on the map.
* '''y''': A floating point number representing the Y coordinate on the map.
* '''z''': A floating point number representing the Z coordinate on the map.

===Optional Arguments===
{{OptionalArg}}
* '''rx''': A floating point number representing the rotation about the X axis in degrees.
* '''ry''': A floating point number representing the rotation about the Y axis in degrees.
* '''rz''': A floating point number representing the rotation about the Z axis in degrees.
* '''numberplate''': A string that will go on the number plate of the car (max 8 characters). This is only applicable to cars.

===Returns===
Returns the [[vehicle]] element that was created. Returns ''false'' if the arguments are incorrect, or if the vehicle limit of 65535 is exceeded.

==Using trains==
Trains are created using the createVehicle function. They are placed at the nearest point of the GTASA train pathing (railroad tracks) from their spawning point.

==Example==
<section name="Example 1: Server" class="server" show="true">
This script spawns a Rhino on top of one lucky individual.
<syntaxhighlight lang="lua">
function scriptCreateTank ( player, command )
local luckyBugger = getRandomPlayer() -- get a random player
local x, y, z = getElementPosition ( luckyBugger ) -- retrive the player's position
createVehicle ( 432, x, y, z + 10 ) -- create the tank 10 units above them
outputChatBox ( "You got Tank'd!", luckyBugger )
end
--Attach the 'scriptCreateTank' function to the "tank" command
addCommandHandler ( "tank", scriptCreateTank )
</syntaxhighlight>
</section>

<section name="Example 2: Client" class="client" show="true">
This script spawns a Rhino on top of the local player.
<syntaxhighlight lang="lua">
function scriptCreateTank ( commandName )
local luckyBugger = getLocalPlayer() -- get the local player
local x, y, z = getElementPosition ( luckyBugger ) -- retrive the player's position
createVehicle ( 432, x, y, z + 10 ) -- create the tank 10 units above them
outputChatBox ( "You got Tank'd!", 255, 0, 0)
end
--Attach the 'scriptCreateTank' function to the "tank" command
addCommandHandler ( "tank", scriptCreateTank )
</syntaxhighlight>
</section>

<section name="Example 3: Server" class="server" show="true">
This example creates a vehicle five units to the right of a player when they type ''createvehicle'' and its name in the console:
<syntaxhighlight lang="lua">
local distance = 5 --units

-- define our handler (we'll take a variable number of parameters where the name goes, because there are vehicle names with more than one word)
function consoleCreateVehicle ( sourcePlayer, commandName, ... )
-- if a player triggered it, not the admin,
if ( sourcePlayer ) then
-- calculate the position of the vehicle based on the player's position and rotation:
local x, y, z = getElementPosition ( sourcePlayer ) -- get the player's position
local rotZ = getPedRotation ( sourcePlayer ) -- get the player's rotation around the Z axis in degrees
x = x + ( ( math.cos ( math.rad ( rotZ ) ) ) * distance ) -- calculate the X position of the vehicle
y = y + ( ( math.sin ( math.rad ( rotZ ) ) ) * distance ) -- calculate the Y position of the vehicle

-- get the complete vehicle name by joining all passed parameters using Lua function table.concat
local vehicleName = table.concat({...}, " ")
-- get the vehicle's model ID from the name
local vehicleID = getVehicleModelFromName ( vehicleName )
-- if vehicle ID is valid,
if vehicleID then
-- create the vehicle using the information gathered above:
local newVehicle = createVehicle ( vehicleID, x, y, z, 0, 0, rotZ )
-- if vehicle creation failed, give the player a message
if not newVehicle then
outputConsole ( "Failed to create vehicle.", sourcePlayer )
end
end
end
end

-- Attach the 'consoleCreateVehicle' function to the "createvehicle" command
addCommandHandler ( "createvehicle", consoleCreateVehicle )
</syntaxhighlight>
</section>

==See Also==

{{IDs}}

{{Vehicle functions}}