Multi Theft Auto: Wiki - User contributions [en]

GetPlayerSerial

2012-10-08T15:48:23Z

Tony: /* 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>

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

GetPlayerSerial

2012-10-08T15:48:06Z

Tony: /* 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( "serial", getMySerial )
</syntaxhighlight>
</section>

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

DxGetStatus

2012-08-20T13:57:29Z

Tony: /* Example */

{{Client function}}
__NOTOC__
This function gets information about various internal datum

==Syntax==
<syntaxhighlight lang="lua">
table dxGetStatus ()
</syntaxhighlight>

===Returns===
Returns a table with the following entries:
* '''TestMode :''' The current dx test mode. See [[dxSetTestMode]].
*'''VideoCardName :''' The name of the graphics card.
*'''VideoCardRAM :''' The installed memory in MB of the graphics card.
*'''VideoCardPSVersion :''' The maximum pixel shader version of the graphics card.
*'''VideoMemoryFreeForMTA :''' The amount of memory in MB available for MTA to use. '''When this gets to zero, [[guiCreateFont]], [[dxCreateFont]] and [[dxCreateRenderTarget]] will fail.'''
*'''VideoMemoryUsedByFonts :''' The amount of graphic memory in MB used by custom fonts.
*'''VideoMemoryUsedByTextures :''' The amount of graphic memory in MB used by textures.
*'''VideoMemoryUsedByRenderTargets :''' The amount of graphic memory in MB used by render targets.
*'''SettingWindowed :''' The windowed setting. (true/false)
*'''SettingFXQuality :''' The FX Quality. (0-3)
*'''SettingDrawDistance :''' The draw distance setting. (0-100)
*'''SettingVolumetricShadows :''' The volumetric shadows setting. (true/false)
*'''SettingStreamingVideoMemoryForGTA :''' The usable graphics memory setting. (50-4000)
*'''AllowScreenUpload :''' The allows screen uploads setting. (true/false)

==Example==
<syntaxhighlight lang="lua">
addCommandHandler("getinfo",function()
local info=dxGetStatus()
for k,v in pairs(info) do
outputChatBox(k.." : "..tostring(v),root,255,0,0,true)
end
end)
</syntaxhighlight>

==See Also==
{{Drawing_functions}}

SetVehicleWheelStates

2012-08-13T21:43:42Z

Tony: /* Example */

__NOTOC__
{{Server client function}}
This function sets the state of wheels on the vehicle.

Internally, no vehicles have more than 4 wheels. If they appear to, they will be duplicating other wheels.

==Syntax==
<syntaxhighlight lang="lua">bool setVehicleWheelStates ( vehicle theVehicle, int frontLeft, [ int rearLeft = -1, int frontRight = -1, int rearRight = -1 ])</syntaxhighlight>

==Required Arguments==
*'''theVehicle:''' A handle to the [[vehicle]] that you wish to change the wheel states of.
*'''frontLeft:''' A whole number representing the wheel state (-1 for no change)

==Optional Arguments==
*'''rearLeft:''' A whole number representing the wheel state (-1 for no change)
*'''frontRight:''' A whole number representing the wheel state (-1 for no change)
*'''rearRight:''' A whole number representing the wheel state (-1 for no change)

==Wheel-State values==
* '''0:''' Inflated
* '''1:''' Flat
* '''2:''' Fallen off
* '''3:''' Collisionless

==Returns==
Returns a boolean value ''true'' or ''false'' that tells you if it was successful or not.

==Example==
<section name="Server" class="server" show="true">
This example displays the states of the vehicle's wheels and changes their states if any arguments were passed.
<syntaxhighlight lang="lua">
function scriptWheelStates ( thePlayer, command, newFLeft, newRLeft, newFRight, newRRight )
local theVehicle = getPedOccupiedVehicle ( thePlayer )
if ( theVehicle ) then -- check if the player is in a car
if ( newFLeft ) then -- if there's at least one argument passed, we change the wheel states
if not setVehicleWheelStates ( theVehicle, newFLeft, newRLeft, newFRight, newRRight ) then
outputChatBox ( "Bad arguments." )
end
end
local states = { [0]="inflated", [1]="flat", [2]="fallen off" } -- we store the states in a table
local frontLeft, rearLeft, frontRight, rearRight = getVehicleWheelStates ( theVehicle )
outputChatBox ( "Your vehicle's wheel states:", thePlayer ) -- output them in the chatbox
outputChatBox ( "Front-Left: " .. states [ frontLeft ] .. ", Front-Right: " .. states [ frontRight ] ..
", Rear-Left: " .. states [ rearLeft ] .. ", Rear-Right: " .. states [ rearRight ], thePlayer )
else
outputChatBox ( "You have to be in a vehicle to use this command.", thePlayer )
end
end
addCommandHandler ( "wheelstates", scriptWheelStates )</syntaxhighlight>
</section>

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

SetPlayerMuted

2012-07-31T22:06:24Z

Tony: /* Example */

__NOTOC__
{{Server function}}
Use this function to mute or unmute the player.

==Syntax==
<syntaxhighlight lang="lua">bool setPlayerMuted ( player thePlayer, bool state )</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The [[player]] you are muting or unmuting.
*'''state:''' Use '''true''' to mute and '''false''' to unmute the player.

===Returns===
Returns ''true'' if the player was successfully muted or unmuted, ''false'' otherwise.

==Example==
This adds a /mute command that can be used to mute a player.
<syntaxhighlight lang="lua">
-- create the function
function mutePlayer(player,command,victimName)
-- if the player has specified a victim name to mute
if victimName then
-- get the victim player element from their name
local victim = getPlayerFromName(victimName)
-- if the player exists
if victim then
-- if they arent already muted
if ( not isPlayerMuted(victim) ) then
-- mute them and output a message to the chat
setPlayerMuted(victim, true)
outputChatBox("You have been muted.",victim)
end
else
outputChatBox("Could not find player with name: "..tostring(victimName),player)
end
else
outputChatBox("Usage: /mute <player name>",player)
end
end
-- add the /mute command
addCommandHandler("mute",mutePlayer)
</syntaxhighlight>

==See Also==
{{Player functions}}

CreateRadarArea

2012-07-23T18:25:36Z

Tony: /* Example */

__NOTOC__
{{Server client function}}
This function can be used to create custom radar areas on the radar.

==Syntax==
<syntaxhighlight lang="lua">
radararea createRadarArea ( float leftX, float bottomY, float sizeX, float sizeY,
[ int r = 255, int g = 0, int b = 0, int a = 255,
element visibleTo = getRootElement() ] )
</syntaxhighlight>

===Required Arguments===
*'''leftX:''' A float representing the left 'x' position of the radar area.
*'''bottomY:''' A float representing the bottom 'y' position of the radar area.
*'''sizeX:''' A float representing the width of the radar area.
*'''sizeY:''' A float representing the height of the radar area.

*'''r:''' An integer representing the amount of red in the color. Maximum value is 255
*'''g:''' An integer representing the amount of green in the color. Maximum value is 255
*'''b:''' An integer representing the amount of blue in the color. Maximum value is 255
*'''a:''' An integer representing the amount of alpha in the color. This allows setting the transparency of the radar area. 255 is opaque and 0 is transparent.

===Optional Arguments===
{{OptionalArg}}
*'''visibleTo:''' An [[element]] that you wish to restrict the [[visibility]] of the radar area to. (Server function only)

==Example==
<section name="Server" class="server" show="true">
This example creates a radar area for the King of the hill script, and a colsquare. When the player enters the radar area it flashes, and stops flashing when a player leaves it.
<syntaxhighlight lang="lua">
-- create our hill area for our gamemode
local hillArea = createColRectangle ( -2171.0678710938, 678.17950439453, 15, 15 )
local hillRadar = createRadarArea ( -2183.5678710938, 705.67950439453, 40, -40, 0, 255, 0, 175 )

-- add hill_Enter as a handler for when a player enters the hill area
function hill_Enter ( thePlayer, matchingDimension )
-- announce to everyone that the player entered the hill
if (getElementType(thePlayer) == "player") then
outputChatBox( getPlayerName(thePlayer) .. " entered the zone!", getRootElement(), 255, 255, 109 )
setRadarAreaFlashing ( hillRadar, true )
end
end
addEventHandler ( "onColShapeHit", hillArea, hill_Enter )

-- add hill_Enter as a handler for when a player leaves the hill area
function hill_Exit ( thePlayer, matchingDimension )
-- check if the player is not dead
if (getElementType(thePlayer) == "player") then
if isPedDead ( thePlayer ) ~= true then
-- if he was alive, announce to everyone that the player has left the hill
outputChatBox ( getPlayerName(thePlayer) .. " left the zone!", getRootElement(), 255, 255, 109 )
setRadarAreaFlashing ( hillRadar, false )
end
end
end
addEventHandler ( "onColShapeLeave", hillArea, hill_Exit )
</syntaxhighlight>
</section>

==See Also==
{{Radar area_functions}}

GetAccountName

2012-06-21T23:31:23Z

Tony: /* Example */

{{Server function}}
__NOTOC__
This function retrieves the name of an account.

==Syntax==
<syntaxhighlight lang="lua">
string getAccountName ( account theAccount )
</syntaxhighlight>

===Required Arguments===
*'''theAccount:''' The account you wish to get the name of

===Returns===
Returns a string containing the account's name, ''false'' if the account does not exist or an invalid argument was passed to the function.

==Example==
This example announces into the console when a player logs into his account.
<syntaxhighlight lang="lua">
function outputOnLogin ( previous_account, current_account, auto_login ) --when a player logs in
outputConsole(getAccountName(previous_account).." Logged into "..getAccountName(current_account)) -- announce it into chatbox
end
addEventHandler("onPlayerLogin",getRootElement(),outputOnLogin ) --add an event handler
</syntaxhighlight>

==See Also==
{{Account_functions}}

[[es:getAccountName]]

FxAddGunshot

2012-06-09T00:51:59Z

Tony: /* Example */

__NOTOC__
{{Client function}}
[[Image:Fxgunshot.png|thumb|200px|Gunshot]]
This function creates a gunshot particle effect.

==Syntax==
<syntaxhighlight lang="lua">
bool fxAddGunshot ( float posX, float posY, float posZ, float dirX, float dirY, float dirZ, [bool includeSparks=true] )
</syntaxhighlight>

===Required Arguments===
*'''posX, posY, posZ:''' the world coordinates where the effect originates.
*'''dirX, dirY, dirZ:''' a direction vector indicating where the bullet is fired.

===Optional Arguments===
{{OptionalArg}}
* '''includeSparks:''' A bool representing whether the particle effect will generate sparks.

===Returns===
Returns a true if the operation was successful, false otherwise.

==Example==
<section name="Client" class="client" show="true">
This example adds a sparks in front of your face.
<syntaxhighlight lang="lua">
addCommandHandler("sshot", function()
local x, y, z = getElementPosition(localPlayer)
fxAddGunshot(x, y+0.5, z+0.5, 0, 0, 0, true)
end)
</syntaxhighlight>
</section>

==See Also==
{{Client Effects functions}}
[[Category:Needs_Example]]

FxAddGunshot

2012-06-09T00:49:55Z

Tony: /* Example */

__NOTOC__
{{Client function}}
[[Image:Fxgunshot.png|thumb|200px|Gunshot]]
This function creates a gunshot particle effect.

==Syntax==
<syntaxhighlight lang="lua">
bool fxAddGunshot ( float posX, float posY, float posZ, float dirX, float dirY, float dirZ, [bool includeSparks=true] )
</syntaxhighlight>

===Required Arguments===
*'''posX, posY, posZ:''' the world coordinates where the effect originates.
*'''dirX, dirY, dirZ:''' a direction vector indicating where the bullet is fired.

===Optional Arguments===
{{OptionalArg}}
* '''includeSparks:''' A bool representing whether the particle effect will generate sparks.

===Returns===
Returns a true if the operation was successful, false otherwise.

==Example==
This example adds a sparks in front of your face
<syntaxhighlight lang="lua">
addCommandHandler("fshot", function()
local x, y, z = getElementPosition(localPlayer)
fxAddGunshot(x, y+0.5, z+0.5, 0, 0, 0, true)
end)
</syntaxhighlight>

==See Also==
{{Client Effects functions}}
[[Category:Needs_Example]]

FxAddGunshot

2012-06-09T00:48:33Z

Tony: /* Example */

__NOTOC__
{{Client function}}
[[Image:Fxgunshot.png|thumb|200px|Gunshot]]
This function creates a gunshot particle effect.

==Syntax==
<syntaxhighlight lang="lua">
bool fxAddGunshot ( float posX, float posY, float posZ, float dirX, float dirY, float dirZ, [bool includeSparks=true] )
</syntaxhighlight>

===Required Arguments===
*'''posX, posY, posZ:''' the world coordinates where the effect originates.
*'''dirX, dirY, dirZ:''' a direction vector indicating where the bullet is fired.

===Optional Arguments===
{{OptionalArg}}
* '''includeSparks:''' A bool representing whether the particle effect will generate sparks.

===Returns===
Returns a true if the operation was successful, false otherwise.

==Example==
This page lacks an example
<syntaxhighlight lang="lua">
addCommandHandler("fshot", function()
local x, y, z = getElementPosition(localPlayer)
fxAddGunshot(x, y+0.5, z+0.5, 0, 0, 0, true)
end)[/lua]
</syntaxhighlight>

==See Also==
{{Client Effects functions}}
[[Category:Needs_Example]]

DxSetBlendMode

2012-04-17T00:26:38Z

Tony: /* Example */

{{Client function}}
__NOTOC__
This function sets the current blend mode for the dxDraw functions. Changing the blend mode can increase the quality when drawing text or certain other images to a render target. As a general guide use '''modulate_add''' when drawing text to a render target, and '''add''' when drawing the render target to the screen. Don't forget to restore the default '''blend''' at the end.

==Syntax==
<syntaxhighlight lang="lua">
bool dxSetBlendMode( string blendMode )
</syntaxhighlight>

===Required Arguments===
*'''blendMode :''' The blend mode to use which can be one of:
**'''blend:''' The source textures are alpha blended to the screen/render target. The is the default mode for drawing and gives the results we all know and love.
**'''add:''' The source textures are added to the screen/render target.
**'''modulate_add:''' The source textures are multiplied by the alpha and then added to the screen/render target.

==Returns==
Returns true if successful, or ''false'' if invalid arguments were passed to the function.

==Example==
<syntaxhighlight lang="lua">
--TODO
</syntaxhighlight>

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

==See Also==
{{Drawing_functions}}

[[Category:Needs Example]]

User:Tony

2012-04-17T00:07:32Z

Tony:

== Tony ==

I'm Tony and I don't have nothing to put here ;)

User:Tony

2012-04-17T00:02:38Z

Tony: Created page with "basadsdaasd"

basadsdaasd