Multi Theft Auto: Wiki - User contributions [en]

GetPlayerSerial

2009-12-25T15:48:21Z

Manuelhimmler:

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

==Syntax==
<syntaxhighlight lang="lua">
string getPlayerSerial ( player thePlayer )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' A [[player]] object referencing the specified player.

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

{{New feature|3|1.0|
The format of the serial has been changed.
}}

==Example==
<section name="Server" 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( "serial", checkMySerial )
</syntaxhighlight>
</section>

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

GetPlayerSerial

2009-12-25T15:48:04Z

Manuelhimmler:

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

==Syntax==
<syntaxhighlight lang="lua">
string getPlayerSerial ( player thePlayer )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' A [[player]] object referencing the specified player.

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

{{New feature|3|1.0|
The format of the serial has been changed.
}}

==Example==
<section name="Server" 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( "serial", checkMySerial )
</syntaxhighlight>
</section>

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

GuiCreateButton

2009-12-24T01:06:43Z

Manuelhimmler: /* Example */

__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}}

KickPlayer

2009-12-20T11:18:46Z

Manuelhimmler: /* Optional Arguments */

{{Server function}}

__NOTOC__
This function will kick the specified player from the server.

==Syntax==
<syntaxhighlight lang="lua">
bool kickPlayer ( player kickedPlayer [[, player responsiblePlayer = nil], string reason = "" ] )
</syntaxhighlight>

===Required Arguments===
*'''kickedPlayer:''' The player that will be kicked from the server

===Optional Arguments===
{{OptionalArg}}
*'''responsiblePlayer:''' The player that is responsible for the event (if nil leave this argument out!)
*'''reason:''' The reason for the kick. This argument can also be used as the 2nd argument, in this case responsible player for the kick will be "Console".

===Returns===
Returns ''true'' if the player was kicked succesfully, ''false'' if invalid arguments are specified.

==Example==
This example lets a player kick anyone who has a lower level.
<syntaxhighlight lang="lua">
function kickPlayerHandler ( sourcePlayer, commandname, kickedname, reason )
-- Get player element from the name
local kicked = getPlayerFromNick ( kickedname )
-- If the client who sent the command has a higher level
if ( hasObjectPermissionTo ( sourcePlayer, "function.kickPlayer" ) ) then
-- Kick the player
kickPlayer ( kicked, sourcePlayer, reason )
end
end
-- Add the "kick" command handler
addCommandHandler ( "kick", kickPlayerHandler )
</syntaxhighlight>

==See Also==
{{Admin_functions}}
[[ru:kickPlayer]]

KickPlayer

2009-12-20T11:18:02Z

Manuelhimmler:

{{Server function}}

__NOTOC__
This function will kick the specified player from the server.

==Syntax==
<syntaxhighlight lang="lua">
bool kickPlayer ( player kickedPlayer [[, player responsiblePlayer = nil], string reason = "" ] )
</syntaxhighlight>

===Required Arguments===
*'''kickedPlayer:''' The player that will be kicked from the server

===Optional Arguments===
{{OptionalArg}}
*'''responsiblePlayer:''' The player that is responsible for the event
*'''reason:''' The reason for the kick. This argument can also be used as the 2nd argument, in this case responsible player for the kick will be "Console".

===Returns===
Returns ''true'' if the player was kicked succesfully, ''false'' if invalid arguments are specified.

==Example==
This example lets a player kick anyone who has a lower level.
<syntaxhighlight lang="lua">
function kickPlayerHandler ( sourcePlayer, commandname, kickedname, reason )
-- Get player element from the name
local kicked = getPlayerFromNick ( kickedname )
-- If the client who sent the command has a higher level
if ( hasObjectPermissionTo ( sourcePlayer, "function.kickPlayer" ) ) then
-- Kick the player
kickPlayer ( kicked, sourcePlayer, reason )
end
end
-- Add the "kick" command handler
addCommandHandler ( "kick", kickPlayerHandler )
</syntaxhighlight>

==See Also==
{{Admin_functions}}
[[ru:kickPlayer]]

KickPlayer

2009-12-20T11:17:15Z

Manuelhimmler: /* Syntax */

{{Server function}}
{{Needs_Checking|Currently, to use with a reason but without a responsible player, the function has to be called: kickPlayer( kickedPlayer, reason )}}

__NOTOC__
This function will kick the specified player from the server.

==Syntax==
<syntaxhighlight lang="lua">
bool kickPlayer ( player kickedPlayer [[, player responsiblePlayer = nil], string reason = "" ] )
</syntaxhighlight>

===Required Arguments===
*'''kickedPlayer:''' The player that will be kicked from the server

===Optional Arguments===
{{OptionalArg}}
*'''responsiblePlayer:''' The player that is responsible for the event
*'''reason:''' The reason for the kick. This argument can also be used as the 2nd argument, in this case responsible player for the kick will be "Console".

===Returns===
Returns ''true'' if the player was kicked succesfully, ''false'' if invalid arguments are specified.

==Example==
This example lets a player kick anyone who has a lower level.
<syntaxhighlight lang="lua">
function kickPlayerHandler ( sourcePlayer, commandname, kickedname, reason )
-- Get player element from the name
local kicked = getPlayerFromNick ( kickedname )
-- If the client who sent the command has a higher level
if ( hasObjectPermissionTo ( sourcePlayer, "function.kickPlayer" ) ) then
-- Kick the player
kickPlayer ( kicked, sourcePlayer, reason )
end
end
-- Add the "kick" command handler
addCommandHandler ( "kick", kickPlayerHandler )
</syntaxhighlight>

==See Also==
{{Admin_functions}}
[[ru:kickPlayer]]

ToggleAllControls

2009-11-26T18:50:06Z

Manuelhimmler: /* Syntax */

__NOTOC__
{{Server client function}}
Enables or disables the use of all GTA controls for a specified player.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">bool toggleAllControls ( player thePlayer, bool enabled, [bool gtaControls=true, bool mtaControls=true] ) </syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player you wish to toggle the control ability of.
*'''enabled:''' A boolean value representing whether or not the controls will be usable.

===Optional Arguemnts===
{{OptionalArg}}
*'''gtaControls:''' A boolean deciding whether the ''enabled'' parameter will affect GTA's internal controls.
*'''mtaControls:''' A boolean deciding whether the ''enabled'' parameter will affect MTA's own controls., e.g. chatbox.
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">bool toggleAllControls ( bool enabled, [bool gtaControls=true, bool mtaControls=true] ) </syntaxhighlight>

===Required Arguments===
*'''enabled:''' A boolean value representing whether or not the controls will be usable or not.

===Optional Arguemnts===
{{OptionalArg}}
*'''gtaControls:''' A boolean deciding whether the ''enabled'' parameter will affect GTA's internal controls.
*'''mtaControls:''' A boolean deciding whether the ''enabled'' parameter will affect MTA's own controls., e.g. chatbox.
</section>

===Returns===
This function returns ''true'' if controls were toggled successfully, false otherwise.

==Example==
<section name="Server" class="server" show="true">
This function will disable the use of all controls in order to freeze a player, which will be used every time someone enters a vehicle.
<syntaxhighlight lang="lua">
function freezeThisDude ( thePlayer, freezeTime )
toggleAllControls ( thePlayer, false ) -- disable this player's controls
setTimer ( toggleAllControls, freezeTime, 1, thePlayer, true ) -- enable this player's controls after the specified time
end

function freezeOnEnterVehicle ( theVehicle, seat, jacked )
freezeThisDude ( source, 5000 ) -- 'freeze' him for 5000ms = 5 seconds
end
addEventHandler ( "onPlayerVehicleEnter", getRootElement(), freezeOnEnterVehicle )
</syntaxhighlight>
</section>

==See Also==
{{Input functions}}

GetDistanceBetweenPoints3D

2009-11-14T21:21:28Z

Manuelhimmler: /* Example */

{{Server client function}}
__NOTOC__
This function returns the distance between two 3 dimensional points using the pythagorean theorem.

==Syntax==
<section name="Server and client" class="both" show="true">
<syntaxhighlight lang="lua">float getDistanceBetweenPoints3D ( float x1, float y1, float z1, float x2, float y2, float z2 )</syntaxhighlight>

===Required Arguments===
* '''x1''': The X position of the first point
* '''y1''': The Y position of the first point
* '''z1''': The Z position of the first point
* '''x2''': The X position of the second point
* '''y2''': The Y position of the second point
* '''z2''': The Z position of the second point

===Returns===
Returns a float containing the distance between the two points as a [[float]]. Returns ''false'' if an argument passed was invalid.
</section>

==Example==
<section name="Server and client" class="both" show="true">
This example gets the distance between two vehicles and outputs it to the chat box.
<syntaxhighlight lang="lua">
vehicle1x, vehicle1y, vehicle1z = getElementPosition ( vehicle1 )
vehicle2x, vehicle2y, vehicle2z = getElementPosition ( vehicle2 )
outputChatBox ( "The distance between vehicle1 and vehicle2 is "..tostring(getDistanceBetweenPoints3D ( vehicle1x, vehicle1y, vehicle1z, vehicle2x,
vehicle2y, vehicle2z )) )</syntaxhighlight>
</section>

==See Also==
{{Utility functions}}

GetDistanceBetweenPoints3D

2009-11-14T21:21:00Z

Manuelhimmler: /* Example */

{{Server client function}}
__NOTOC__
This function returns the distance between two 3 dimensional points using the pythagorean theorem.

==Syntax==
<section name="Server and client" class="both" show="true">
<syntaxhighlight lang="lua">float getDistanceBetweenPoints3D ( float x1, float y1, float z1, float x2, float y2, float z2 )</syntaxhighlight>

===Required Arguments===
* '''x1''': The X position of the first point
* '''y1''': The Y position of the first point
* '''z1''': The Z position of the first point
* '''x2''': The X position of the second point
* '''y2''': The Y position of the second point
* '''z2''': The Z position of the second point

===Returns===
Returns a float containing the distance between the two points as a [[float]]. Returns ''false'' if an argument passed was invalid.
</section>

==Example==
<section name="Server and client" class="both" show="true">
This example gets the distance between two vehicles and outputs it to the chat box.
<syntaxhighlight lang="lua">
vehicle1x, vehicle1y, vehicle1z = getElementPosition ( vehicle1 )
vehicle2x, vehicle2y, vehicle2z = getElementPosition ( vehicle2 )
outputChatBox ( "The distance between vehicle1 and vehicle2 is "..tostring(getDistanceBetweenPoints3D ( vehicle1x, vehicle1y, vehicle1z, vehicle2x, vehicle2y, vehicle2z )) )</syntaxhighlight>
</section>

==See Also==
{{Utility functions}}

EngineReplaceModel

2009-11-14T15:14:01Z

Manuelhimmler: /* Example */

__NOTOC__
{{Client function}}
This function replaces the given model in the given model ID with the DFF file passed. This function supports vehicles and objects at the moment.

==Syntax==
<syntaxhighlight lang="lua">
bool engineReplaceModel ( dff theModel, int modelID )
</syntaxhighlight>

===Required Arguments===
*'''theModel:''' The model to replace the given model ID with
*'''modelID:''' The model it to replace the model of

===Returns===
Returns ''true'' if the model was successfully replaced, ''false'' if it failed for some reason, ie. the DFF or the model ID is not valid.

==Example==
'''Example 1:'''
<section name="Client" class="client" show="true">
Client-Side example for replacing vehicle model and texture with custom ones.
<syntaxhighlight lang="lua">
function ReplaceVehicle ( )
outputChatBox ( "> replacing the euros vehicle" )

txd = engineLoadTXD ( "data/euros.txd" )
engineImportTXD ( txd, 587 )
dff = engineLoadDFF ( "data/euros.dff", 587 )
engineReplaceModel ( dff, 587 )
end

addEvent ( "replaceVeh", true )
addEventHandler ( "replaceVeh", getRootElement(), ReplaceVehicle )
</syntaxhighlight>
</section>
<section name="Server" class="server" show="true">
Server-side example function for triggering the replace.
<syntaxhighlight lang="lua">
function ReplaceCommand ( )
triggerClientEvent( "replaceVeh", getRootElement(), replaceVeh )
end
addCommandHandler( "replace", ReplaceCommand )
</syntaxhighlight>
</section>

'''Example 2:'''
<section name="Client" class="client" show="true">
Client-Side example for replacing object model, collision and texture with custom ones.
<syntaxhighlight lang="lua">
function ReplaceObject ( )

txd = engineLoadTXD( "MyModel.txd" )
col = engineLoadCOL( "MyModel.col" )
dff = engineLoadDFF( "MyModel.dff", 0 ) --modelid is everytime 0, when you replace no vehicle

engineImportTXD( txd, 1234 )
engineReplaceCOL( col, 1234 )
engineReplaceModel( dff, 1234 )-- replace the model at least

end

addEvent ( "replaceObj", true )
addEventHandler ( "replaceObj", getRootElement(), ReplaceObject )
</syntaxhighlight>
</section>
<section name="Server" class="server" show="true">
Server-side example function for triggering the replace.
<syntaxhighlight lang="lua">
function ReplaceCommand ( )
triggerClientEvent( "replaceObj", getRootElement(), replaceObj )
end
addCommandHandler( "replace", ReplaceCommand )
</syntaxhighlight>
</section>

==See Also==
{{Engine_functions}}