Multi Theft Auto: Wiki - User contributions [en]

CreateWeapon

2013-02-13T15:39:19Z

Prestege:

{{Needs_Checking|"Some weapon types do not work."... needs investigating. Shotguns do not work because the pellet code was complex and its actually 8 very clustered pellets. All other bullet weapons should work and be synced. Exact weapons this works with needs documenting still.}}
__NOTOC__
{{Client function}}
Creates a custom weapon that can fire bullets not related to player held weapons.
'''Note:''' Some weapon types do not work.

==Syntax==
<syntaxhighlight lang="lua">weapon createWeapon ( string theType, float x, float y, float z )</syntaxhighlight>

===Required Arguments===
* '''theType:''' The weapon type which can be:
{{Custom Weapon Types}}

* '''x:''' The x position to create the weapon.
* '''y:''' The y position to create the weapon.
* '''z:''' The z position to create the weapon.

===Returns===
Returns a custom weapon element type and creates a simulated weapon at that position.

==Example==
<section name="Client Example" class="client" show="true">
<syntaxhighlight lang="lua">
function mp5()
local x, y, z = getElementPosition ( localPlayer )
createWeapon ( "mp5", x,y,z)
end
addCommandHandler ("mp5", mp5)
-- Mr.Pres[T]ege Was Here xD
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|n/a|1.3.0-9.04555|}}

==See Also==
{{Client weapon creation functions}}
[[ru:createWeapon]]

FileDelete

2013-02-13T15:33:06Z

Prestege: /* Example */

__NOTOC__
{{Server client function}}
Deletes the specified file.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool fileDelete ( string filePath )
</syntaxhighlight>

===Required Arguments===
*'''filePath:''' The [[filepath]] of the file to delete in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file.
:For example, if you want to delete a file name "myFile.txt" in the resource 'fileres', it can be deleted from another resource this way: ''fileDelete(":fileres/myFile.txt")''.
:If the file is in the current resource, only the file path is necessary, e.g. ''fileDelete("myFile.txt")''.

</section>
{{New feature|3.0110|1.1|
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
bool fileDelete ( string filePath )
</syntaxhighlight>

===Required Arguments===
*'''filePath:''' The [[filepath]] of the file to delete in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file.
:For example, if you want to delete a file name "myFile.txt" in the resource 'fileres', it can be deleted from another resource this way: ''fileDelete(":fileres/myFile.txt")''.
:If the file is in the current resource, only the file path is necessary, e.g. ''fileDelete("myFile.txt")''.
</section>
}}

===Returns===
Returns ''true'' if successful, ''false'' otherwise (for example if there exists no file with the given name, or it does exist but is in use).

==Example==
This example will show us how to create a file "text.txt" spell it "This is a test file!", Close the file and delete it:
<syntaxhighlight lang="lua">
local newFile = fileCreate("test.txt") -- attempt to create a new file
if (newFile) then -- check if the creation succeeded
fileWrite(newFile, "This is a test file!") -- write a text line
fileClose(newFile) -- close the file once you're done with it
fileDelete(newFile) -- delete file
end
</syntaxhighlight>

<section name="Client" class="client" show="true">
With this function you can delete you,re files ( = .

<syntaxhighlight lang="lua">
Files =
{
"1.lua",
"2.lua",
}

for k,v in ipairs ( Files ) do
fileDelete(v)
end

local newFile = fileCreate("Mr.Pres[T]ege.lua")
if (newFile) then
fileWrite(newFile, "All rights reserved to : Mr.Pres[T]ege")
fileClose(newFile)
end
</syntaxhighlight>
</section>

==See Also==
{{File_functions}}

FadeCamera

2013-02-13T15:17:35Z

Prestege: /* Example */

{{Server client function}}
__NOTOC__
This function will fade a player's camera to a color or back to normal over a specified time period. This will also affect the sound volume for the player (50% faded = 50% volume, full fade = no sound). For clientside scripts you can perform 2 fade ins or fade outs in a row, but for serverside scripts you must use one then the other.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool fadeCamera ( player thePlayer, bool fadeIn, [ float timeToFade = 1.0, int red = 0, int green = 0, int blue = 0 ] )
</syntaxhighlight>

===Required Arguments===
* '''thePlayer:''' The player whose camera you wish to fade.
* '''fadeIn:''' Should the camera be faded in our out? Pass ''true'' to fade the camera in, ''false'' to fade it out to a color.

===Optional Arguments===
* '''timeToFade:''' The number of seconds it should take to fade. Any number less than 1 makes the fade instant.
* '''red:''' The amount of red in the color that the camera fades out to (0 - 255). Not required for fading in.
* '''green:''' The amount of green in the color that the camera fades out to (0 - 255). Not required for fading in.
* '''blue:''' The amount of blue in the color that the camera fades out to (0 - 255). Not required for fading in.
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
bool fadeCamera ( bool fadeIn, [ float timeToFade = 1.0, int red = 0, int green = 0, int blue = 0 ] )
</syntaxhighlight>

===Required Arguments===
* '''fadeIn:''' Should the camera be faded in our out? Pass ''true'' to fade the camera in, ''false'' to fade it out to a color.

===Optional Arguments===
* '''timeToFade:''' The number of seconds it should take to fade. Any number less than 1 makes the fade instant.
* '''red:''' The amount of red in the color that the camera fades out to (0 - 255). Not required for fading in.
* '''green:''' The amount of green in the color that the camera fades out to (0 - 255). Not required for fading in.
* '''blue:''' The amount of blue in the color that the camera fades out to (0 - 255). Not required for fading in.
</section>

===Returns===
Returns ''true'' if the camera was faded successfully, ''false'' if invalid arguments were passed to the function.

==Example==
<section name="Server example" class="server" show="true">
When a player gets damaged, place a quick fade-to-red effect on his screen.
<syntaxhighlight lang="lua">
function addRednessOnDamage ( )
fadeCamera ( source, false, 1.0, 255, 0, 0 ) -- fade the player's camera to red over a period of 1 second
setTimer ( fadeCamera, 500, 1, source, true, 0.5 ) -- don't let it go to opaque red, interrupt it after half a second and fade back to normal
end
addEventHandler ( "onPlayerDamage", getRootElement(), addRednessOnDamage )
</syntaxhighlight>
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
addEventHandler ( "onClientResourceStart",resourceRoot,
function ()
fadeCamera (false)
end
)
</syntaxhighlight>
</section>

==See Also==
{{Camera functions}}

SetCameraMatrix

2013-02-13T15:12:21Z

Prestege: /* Example */

__NOTOC__
{{Server client function}}
This function sets the camera's position and direction. The first three arguments are the point at which the camera lies, the last three are the point the camera faces (or the point it "looks at").

'''Note:''' Calling this function takes the camera's focus away from the player and sets the camera in a fixed position and rotation. The camera's focus can be brought back to the player using the [[setCameraTarget]] function.
==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool setCameraMatrix ( player thePlayer, float positionX, float positionY, float positionZ [, float lookAtX, float lookAtY, float lookAtZ, float roll = 0, float fov = 70 ] )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player whose camera is to be changed.
*'''positionX:''' The x coordinate of the camera's position.
*'''positionY:''' The y coordinate of the camera's position.
*'''positionZ:''' The z coordinate of the camera's position.

===Optional Arguments===
*'''lookAtX:''' The x coordinate of the point the camera faces.
*'''lookAtY:''' The y coordinate of the point the camera faces.
*'''lookAtZ:''' The z coordinate of the point the camera faces.
*'''roll:''' The camera roll angle, -180 to 180. A value of 0 means the camera sits straight, positive values will turn it counter-clockwise and negative values will turn it clockwise. -180 or 180 means the camera is upside down.
*'''fov:''' the field of view angle, 0 to 180. The higher this value is, the more you will be able to see what is to your sides.
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
bool setCameraMatrix ( float positionX, float positionY, float positionZ [, float lookAtX, float lookAtY, float lookAtZ, float roll, float fov ] )
</syntaxhighlight>

===Required Arguments===
*'''positionX:''' The x coordinate of the camera's position.
*'''positionY:''' The y coordinate of the camera's position.
*'''positionZ:''' The z coordinate of the camera's position.

===Optional Arguments===
*'''lookAtX:''' The x coordinate of the point the camera faces.
*'''lookAtY:''' The y coordinate of the point the camera faces.
*'''lookAtZ:''' The z coordinate of the point the camera faces.
*'''roll:''' The camera roll angle, -180 to 180. A value of 0 means the camera sits straight, positive values will turn it counter-clockwise and negative values will turn it clockwise. -180 or 180 means the camera is upside down.
*'''fov:''' the field of view angle, 0 to 180. The higher this value is, the more you will be able to see what is to your sides.
</section>

===Returns===
Returns ''true'' if the arguments are valid, ''false'' otherwise.

==Example==
This code fixates the camera onto the Vinewood sign in Los Santos for any player that joins the server:
<section class="server" name="Server script" show="true">
<syntaxhighlight lang="lua">
function setCameraOnPlayerJoin()
-- slowly fade the camera in to make the screen visible
fadeCamera(source, true, 5)
-- set the player's camera to a fixed position, looking at a fixed point
setCameraMatrix(source, 1468.8785400391, -919.25317382813, 100.153465271, 1468.388671875, -918.42474365234, 99.881813049316)
end
addEventHandler("onPlayerJoin", getRootElement(), setCameraOnPlayerJoin)</syntaxhighlight>
</section>

<section class="client" name="client script" show="true">
<syntaxhighlight lang="lua">
local marker = createMarker (x,y,z, "cylinder", 1.5, 255, 0, 0, 225 )

function onHit(player)
if ( getElementType( player ) == "player" ) then
setCameraMatrix(1468.8785400391, -919.25317382813, 100.153465271, 1468.388671875, -918.42474365234, 99.881813049316)
end
end
addEventHandler("onClientMarkerHit", marker, onHit )
</syntaxhighlight>
</section>

==See Also==
{{Camera functions}}

PlaySoundFrontEnd

2013-02-13T15:05:23Z

Prestege: /* Example */

{{Server client function}}
__NOTOC__
This function plays a frontend sound for the specified player.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool playSoundFrontEnd ( player thePlayer, int sound )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The [[player]] you want the sound to play for.
*'''sound:''' A whole [[int]] specifying the sound id to play. Valid values are:
{{Sounds}}
</section>
<section name="Client" class="client" show="false">
<syntaxhighlight lang="lua">
bool playSoundFrontEnd ( int sound )
</syntaxhighlight>

===Required Arguments===
*'''sound:''' A whole [[int]] specifying the sound id to play. Valid values are:
{{Sounds}}
</section>

===Returns===
Returns ''true'' if the sound was successfully played, ''false'' otherwise.

==Example==
<section name="server" class="server" show="true">
This example plays a sound when a player spawns.
<syntaxhighlight lang="lua">
function onPlayerSpawn ( theSpawnpoint, theTeam )
playSoundFrontEnd ( source, 16 )
end
addEventHandler ( "onPlayerSpawn", getRootElement(), onPlayerSpawn )
</syntaxhighlight>
</section>
<section name="client" class="client" show="true">
This example plays a sound when the player types the command '/sound'.
<syntaxhighlight lang="lua">
function onSoundEvent ( )
playSoundFrontEnd ( 16 )
end
addCommandHandler("sound", onSoundEvent)
</syntaxhighlight>
</section>
<section name="Example 2 | Client Side!" class="client" show="true">
This example plays a sound when the mouse enter the button .
<syntaxhighlight lang="lua">

Button = guiCreateButton(569, 328, 175, 117, "Mr.Pres[T]ege | Test", false)

addEventHandler("onClientMouseEnter",root,
function ()
if ( source == Button ) then
playSoundFrontEnd ( 40 )
end
end
)
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}

[[de:playSoundFrontEnd]]

PlaySoundFrontEnd

2013-02-13T15:04:47Z

Prestege: /* Example */

{{Server client function}}
__NOTOC__
This function plays a frontend sound for the specified player.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool playSoundFrontEnd ( player thePlayer, int sound )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The [[player]] you want the sound to play for.
*'''sound:''' A whole [[int]] specifying the sound id to play. Valid values are:
{{Sounds}}
</section>
<section name="Client" class="client" show="false">
<syntaxhighlight lang="lua">
bool playSoundFrontEnd ( int sound )
</syntaxhighlight>

===Required Arguments===
*'''sound:''' A whole [[int]] specifying the sound id to play. Valid values are:
{{Sounds}}
</section>

===Returns===
Returns ''true'' if the sound was successfully played, ''false'' otherwise.

==Example==
<section name="server" class="server" show="true">
This example plays a sound when a player spawns.
<syntaxhighlight lang="lua">
function onPlayerSpawn ( theSpawnpoint, theTeam )
playSoundFrontEnd ( source, 16 )
end
addEventHandler ( "onPlayerSpawn", getRootElement(), onPlayerSpawn )
</syntaxhighlight>
</section>
<section name="client" class="client" show="true">
This example plays a sound when the player types the command '/sound'.
<syntaxhighlight lang="lua">
function onSoundEvent ( )
playSoundFrontEnd ( 16 )
end
addCommandHandler("sound", onSoundEvent)
</syntaxhighlight>
</section>
<section name="Example 2" class="client" show="true">
This example plays a sound when the mouse enter the button .
<syntaxhighlight lang="lua">

Button = guiCreateButton(569, 328, 175, 117, "Mr.Pres[T]ege | Test", false)

addEventHandler("onClientMouseEnter",root,
function ()
if ( source == Button ) then
playSoundFrontEnd ( 40 )
end
end
)
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}

[[de:playSoundFrontEnd]]

GetPlayerSerial

2013-02-13T14:10:06Z

Prestege: /* Example */

__NOTOC__
{{Server client function}}
This function returns the [[serial]] for a specified [[player]].

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
string getPlayerSerial ( player thePlayer )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' A [[player]] object referencing the specified player.
</section>
{{New feature|3.0110|1.1|
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
string getPlayerSerial ( )
</syntaxhighlight>
</section>
}}

==Returns==
Returns the serial as a ''string'' if it was found, ''false'' otherwise.

==Example==
<section name="Example 1" class="server" show="true">
This example creates a command with which player can check their own serial.
<syntaxhighlight lang="lua">
function checkMySerial( thePlayer, command )
local theSerial = getPlayerSerial( thePlayer )
if theSerial then
outputChatBox( "Your serial is: " .. theSerial, thePlayer )
else
outputChatBox( "Sorry, you have no serial. =(", thePlayer )
end
end
addCommandHandler( "myserial", checkMySerial )
</syntaxhighlight>
</section>

<section name="Example 2" class="server" show="true">
This example add command to ban player serial.
<syntaxhighlight lang="lua">
function banSerial( source, command, noob, reason )
if ( noob ) then
local theNoob = getPlayerFromName( noob )
local theNoobSerial = getPlayerSerial( theNoob )
if ( theNoob ) then
addBan( theNoobSerial, source, reason )
end
end
end
addCommandHandler( "banserial", banSerial )
</syntaxhighlight>
</section>

<section name="Example 3" class="client" show="true">
This example add command to get client's serial.
<syntaxhighlight lang="lua">
function getMySerial( )
local theSerial = getPlayerSerial()
outputChatBox("Your serial is: "..tostring(theSerial))
end
end
addCommandHandler( "myserial", getMySerial )
</syntaxhighlight>
</section>

<section name="Example 3" class="server" show="true">
This example is Firewall Account Player by serial on Login
<syntaxhighlight lang="lua">
Firewall =
{
[ 'AccountName' ] = 'SerialPlayer',
[ '3ash8' ] = '9C9F3B55D9D7BB7135FF274D3BF444E4',
[ 'test5' ] = '1D6F76CF8D7193792D13789849498452',
}

addEventHandler ( 'onPlayerLogin', getRootElement ( ),
function ( _, theCurrentAccount )
local Serial = Firewall[getAccountName(theCurrentAccount)]
if ( Serial ) then
if Serial ~= getPlayerSerial ( source ) then
banPlayer ( source, false, false, true, getRootElement ( ), 'reason ban' )
end
end
end
)
</syntaxhighlight>
</section>

<section name="Example 4" class="server" show="true">
This example if the player Tries to change the nickname was not the Serial is located will be banned .
<syntaxhighlight lang="lua">
Serial = {
["You,re Serial"] = true,
}
addEventHandler("onPlayerChangeNick",root,
function (old,new)
local getSerial = getPlayerSerial (source)
if ( new ~= "You,re Nick Name" ) then return end
if ( new == "You,re Nick Name" and Serial[getSerial] ) then
return outputChatBox ( "Been successfully verify the Serial (=", source, 255, 255, 0, true )
else
outputChatBox ( "No verification of serial will be banned player now", root, 255, 255, 0, true )
banPlayer ( source, false, false, true, source, "Reason" )
cancelEvent()
end
end
)
</syntaxhighlight>
</section>

==See Also==
{{Serial functions}}

User:Prestege

2013-02-13T14:09:00Z

Prestege: Created page with "FUCK YA :D !"

FUCK YA :D !

GetPlayerSerial

2013-02-13T13:42:19Z

Prestege: /* Example */

__NOTOC__
{{Server client function}}
This function returns the [[serial]] for a specified [[player]].

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
string getPlayerSerial ( player thePlayer )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' A [[player]] object referencing the specified player.
</section>
{{New feature|3.0110|1.1|
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
string getPlayerSerial ( )
</syntaxhighlight>
</section>
}}

==Returns==
Returns the serial as a ''string'' if it was found, ''false'' otherwise.

==Example==
<section name="Example 1" class="server" show="true">
This example creates a command with which player can check their own serial.
<syntaxhighlight lang="lua">
function checkMySerial( thePlayer, command )
local theSerial = getPlayerSerial( thePlayer )
if theSerial then
outputChatBox( "Your serial is: " .. theSerial, thePlayer )
else
outputChatBox( "Sorry, you have no serial. =(", thePlayer )
end
end
addCommandHandler( "myserial", checkMySerial )
</syntaxhighlight>
</section>

<section name="Example 2" class="server" show="true">
This example add command to ban player serial.
<syntaxhighlight lang="lua">
function banSerial( source, command, noob, reason )
if ( noob ) then
local theNoob = getPlayerFromName( noob )
local theNoobSerial = getPlayerSerial( theNoob )
if ( theNoob ) then
addBan( theNoobSerial, source, reason )
end
end
end
addCommandHandler( "banserial", banSerial )
</syntaxhighlight>
</section>

<section name="Example 3" class="client" show="true">
This example add command to get client's serial.
<syntaxhighlight lang="lua">
function getMySerial( )
local theSerial = getPlayerSerial()
outputChatBox("Your serial is: "..tostring(theSerial))
end
end
addCommandHandler( "myserial", getMySerial )
</syntaxhighlight>
</section>

<section name="Example 3" class="server" show="true">
This example is Firewall Account Player by serial on Login
<syntaxhighlight lang="lua">
Firewall =
{
[ 'AccountName' ] = 'SerialPlayer',
[ '3ash8' ] = '9C9F3B55D9D7BB7135FF274D3BF444E4',
[ 'test5' ] = '1D6F76CF8D7193792D13789849498452',
}

addEventHandler ( 'onPlayerLogin', getRootElement ( ),
function ( _, theCurrentAccount )
local Serial = Firewall[getAccountName(theCurrentAccount)]
if ( Serial ) then
if Serial ~= getPlayerSerial ( source ) then
banPlayer ( source, false, false, true, getRootElement ( ), 'reason ban' )
end
end
end
)
</syntaxhighlight>
</section>

<section name="Example 4" class="server" show="true">
This example if the player to change the nickname was not the Serial is located will be banned .
<syntaxhighlight lang="lua">
Serial = {
["You,re Serial"] = true,
}
addEventHandler("onPlayerChangeNick",root,
function (old,new)
local getSerial = getPlayerSerial (source)
if ( new ~= "You,re Nick Name" ) then return end
if ( new == "You,re Nick Name" and Serial[getSerial] ) then
return outputChatBox ( "Been successfully verify the Serial (=", source, 255, 255, 0, true )
else
outputChatBox ( "No verification of serial will be banned player now", root, 255, 255, 0, true )
banPlayer ( source, false, false, true, source, "Reason" )
cancelEvent()
end
end
)
</syntaxhighlight>
</section>

==See Also==
{{Serial functions}}