Multi Theft Auto: Wiki - User contributions [en]

CountPlayersInRange

2010-08-18T11:54:55Z

Varez: /* Example */

{{Useful Function}}
This function allows you to set '''moving''' element speed in kph or mph units.
==Syntax==
<syntaxhighlight lang="lua">
bool setElementSpeed (element theElement, [ int/string unit="kph", int speed=0 ])
</syntaxhighlight>

===Required Arguments===
* '''theElement''': Element you want to set speed of

===Optional Arguments===
{{OptionalArg}}
* '''unit''': Units in which speed should be set. This can be 1 or "mph" for mph, any other value for kph.
* '''speed''': Speed in selected unit

==Code==
{{RequiredFunctions|getElementSpeed}}
<section name="Function source" class="both" show="true">
<syntaxhighlight lang="lua">
function setElementSpeed(element, unit, speed) -- only work if element is moving!
if (unit == nil) then unit = 0 end
if (speed == nil) then speed = 0 end
speed = tonumber(speed)
local acSpeed = getElementSpeed(element, unit)
if (acSpeed~=false) then -- if true - element is valid, no need to check again
local diff = speed/acSpeed
local x,y,z = getElementVelocity(element)
setElementVelocity(element,x*diff,y*diff,z*diff)
return true
else
return false
end
end
</syntaxhighlight>
</section>

==Example==
<section name="Server-side example" class="server" show="true">
This example adds command that set player vehicle speed to provided one (in predefined unit kph). Note: It doesn't care if player is driver or passenger.
<syntaxhighlight lang="lua">
addCommandHandler("setmyspeed",
function (player, cmd, arg1)
local veh = getPedOccupiedVehicle(player)
if (veh) then
setElementSpeed(veh, "kph", tonumber(arg1))
else
outputChatBox("You have to sit in vehicle", player)
end
end
)
</syntaxhighlight>
</section>

By '''varez'''.

==See Also==
{{Useful_Functions}}
<nowiki>Insert non-formatted text here</nowiki>

OnPedWasted

2010-08-16T12:25:15Z

Varez: /* Example */

OnPedWasted

2010-08-16T12:25:05Z

Varez: /* Example */

OnPedWasted

2010-08-16T12:17:09Z

Varez: /* Example */

__NOTOC__
{{Server event}}
This event is triggered when a ped is killed or dies.

==Parameters==
<syntaxhighlight lang="lua">int totalAmmo, element killer, int killerWeapon, int bodypart [, bool stealth ]
</syntaxhighlight>

*'''totalAmmo''': an integer representing the total ammo the victim had when he died.
*'''killer''': an [[element]] representing the player or vehicle who was the killer. If there was no killer this is ''false''.
*'''killerWeapon''': an integer representing the [[weapon]] the killer used to kill the player.
*'''bodypart''': an integer representing the bodypart ID the victim was hit on when he died.
{{BodyParts}}
*'''stealth''': boolean value representing whether or not this was a stealth kill

==Source==
The [[event system#Event source|source]] of this event is the [[ped]] that died or got killed.

==Example==
This example outputs a text to chatbox when somebody dies/get killed
<syntaxhighlight lang="lua">
addEventHandler("onPedWasted", getRootElement(), function(totalAmmo,killer,killerWeapon,bodypart)
if (getElementType(source)=="player") then -- we are checking if player died (not ped [bot])
if (isElement(killer)) then -- if killer is element that means somebody killed player
if (killer==source) then -- if killer is same as player who died - he killed himself
outputChatBox(getPlayerName(source).." commited suicide")
else -- if killer is different than player who died -- somebody killed him
outputChatBox(getPlayerName(source).." got killed by "..getPlayerName(killer))
end
else -- if killer is not element - player just died, without a "killer"
outputChatBox(getPlayerName(source).." died")
end
end
end)
</syntaxhighlight>

==See Also==
{{Ped_events}}

CountPlayersInRange

2010-08-15T16:08:17Z

Varez: /* Code */

{{Useful Function}}
This function allows you to set '''moving''' element speed in kph or mph units.
==Syntax==
<syntaxhighlight lang="lua">
bool setElementSpeed (element theElement, [ int/string unit="kph", int speed=0 ])
</syntaxhighlight>

===Required Arguments===
* '''theElement''': Element you want to set speed of

===Optional Arguments===
{{OptionalArg}}
* '''unit''': Units in which speed should be set. This can be 1 or "mph" for mph, any other value for kph.
* '''speed''': Speed in selected unit

==Code==
{{RequiredFunctions|getElementSpeed}}
<section name="Function source" class="both" show="true">
<syntaxhighlight lang="lua">
function setElementSpeed(element, unit, speed) -- only work if element is moving!
if (unit == nil) then unit = 0 end
if (speed == nil) then speed = 0 end
speed = tonumber(speed)
local acSpeed = getElementSpeed(element, unit)
if (acSpeed~=false) then -- if true - element is valid, no need to check again
local diff = speed/acSpeed
local x,y,z = getElementVelocity(element)
setElementVelocity(element,x*diff,y*diff,z*diff)
return true
else
return false
end
end
</syntaxhighlight>
</section>

==Example==
<section name="Server-side example" class="server" show="true">
This example adds command that set player vehicle speed to provided one (in predefined unit kph). Note: It doesn't care if player is driver or passenger.
<syntaxhighlight lang="lua">
addCommandHandler("getmyspeed",
function (player, cmd, arg1)
local veh = getPedOccupiedVehicle(player)
if (veh) then
setElementSpeed(veh, "kph", tonumber(arg1))
else
outputChatBox("You have to sit in vehicle", player)
end
end
)
</syntaxhighlight>
</section>

By '''varez'''.

==See Also==
{{Useful_Functions}}
<nowiki>Insert non-formatted text here</nowiki>

ResetTimer

2010-08-12T15:45:21Z

Varez:

{{Needs_Checking|Is this really only server side?}}
{{Server function}}
__NOTOC__
This function allows you to reset the elapsed time in existing timers to zero. The function does not reset the 'times to execute' count on timers which have a limited amout of repetitions.

==Syntax==
<syntaxhighlight lang="lua">
bool resetTimer ( timer theTimer )
</syntaxhighlight>

===Required Arguments===
*'''theTimer:''' The [[timer]] whose elapsed time you wish to reset.

===Returns===
Returns ''true'' if the timer was successfully reset, ''false'' otherwise.

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

==See Also==
{{Utility functions}}
[[Category:Needs_Example]]

SetCameraViewMode

2010-08-12T15:43:21Z

Varez:

__NOTOC__
{{Client function}}
This function allows you to set the camera's view mode. This indicates at what distance the camera will follow the player.
*'''Note:''' It can currently only set vehicle view modes

==Syntax==
<syntaxhighlight lang="lua">
bool setCameraView ( int viewMode )
</syntaxhighlight>

===Required Arguments===
*'''viewMode''': The view mode you wish to use
{{Camera view modes}}

===Returns===
Returns ''true'' if the view was set correctly, ''false'' otherwise.

==Example==
This example sets camera to bumper view when local player enter any vehicle
<syntaxhighlight lang="lua">
addEventHandler("onClientPlayerVehicleEnter", getLocalPlayer(), function()
setCameraView(0)
end)
</syntaxhighlight>

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

SetCameraViewMode

2010-08-12T15:43:07Z

Varez: /* Example */

OnClientVehicleExplode

2010-08-12T15:31:43Z

Varez:

{{Client event}}
__NOTOC__
This event is triggered when a vehicle explodes.

==Parameters==
This event has no parameters.

==Source==
The source of this event is the vehicle that exploded.

==Example==
This example will output some text to chat on vehicle explosion
<syntaxhighlight lang="lua">
addEventHandler("onClientVehicleExplode", getRootElement(), function()
local modelname = getVehicleName(source)
outputChatBox(modelname.." just exploded!")
end)
</syntaxhighlight>

==See Also==
===Client vehicle events===
{{Client_vehicle_events}}
===Client event functions===
{{Client_event_functions}}

OnClientVehicleExplode

2010-08-12T15:31:08Z

Varez: /* Example */

CountPlayersInRange

2010-08-08T20:20:57Z

Varez: Created page with '{{Useful Function}} This function allows you to set '''moving''' element speed in kph or mph units. ==Syntax== <syntaxhighlight lang="lua"> bool setElementSpeed (element theElement, [ int/strin…'

{{Useful Function}}
This function allows you to set '''moving''' element speed in kph or mph units.
==Syntax==
<syntaxhighlight lang="lua">
bool setElementSpeed (element theElement, [ int/string unit="kph", int speed=0 ])
</syntaxhighlight>

===Required Arguments===
* '''theElement''': Element you want to set speed of

===Optional Arguments===
{{OptionalArg}}
* '''unit''': Units in which speed should be set. This can be 1 or "mph" for mph, any other value for kph.
* '''speed''': Speed in selected unit

==Code==
{{RequiredFunctions|getElementSpeed}}
<section name="Function source" class="both" show="true">
<syntaxhighlight lang="lua">
function setElementSpeed(element, unit, speed) -- only work if element is moving!
if (unit == nil) then unit = 0 end
if (speed == nil) then speed = 0 end
speed = tonumber(speed)
local acSpeed = getElementSpeed(element, unit)
if (acSpeed~=false) then -- if true - element is valid, no need to check again
local diff = speed/acSpeed
local x,y,z = getElementVelocity(element)
outputChatBox(x.."x"..y.."y"..z)
outputChatBox(x*diff.."x"..y*diff.."y"..z*diff)
setElementVelocity(element,x*diff,y*diff,z*diff)
return true
else
return false
end
end
</syntaxhighlight>
</section>

==Example==
<section name="Server-side example" class="server" show="true">
This example adds command that set player vehicle speed to provided one (in predefined unit kph). Note: It doesn't care if player is driver or passenger.
<syntaxhighlight lang="lua">
addCommandHandler("getmyspeed",
function (player, cmd, arg1)
local veh = getPedOccupiedVehicle(player)
if (veh) then
setElementSpeed(veh, "kph", tonumber(arg1))
else
outputChatBox("You have to sit in vehicle", player)
end
end
)
</syntaxhighlight>
</section>

By '''varez'''.

==See Also==
{{Useful_Functions}}
<nowiki>Insert non-formatted text here</nowiki>

GetElementSpeed

2010-08-08T16:48:46Z

Varez:

{{Useful Function}}
This function allows you to get element speed in kph or mph units.
==Syntax==
<syntaxhighlight lang="lua">
int/bool getElementSpeed (element theElement, [ int/string unit="kph" ])
</syntaxhighlight>

===Required Arguments===
* '''theElement''': Element you want to get speed of

===Optional Arguments===
{{OptionalArg}}
* '''unit''': Units in which speed should be returned. This can be 1 or "mph" for mph, any other value for kph.

==Code==
<section name="Function source" class="both" show="true">
<syntaxhighlight lang="lua">
function getElementSpeed(element,unit)
if (unit == nil) then unit = 0 end
if (isElement(element)) then
local x,y,z = getElementVelocity(element)
if (unit=="mph" or unit==1 or unit =='1') then
return (x^2 + y^2 + z^2) ^ 0.5 * 100
else
return (x^2 + y^2 + z^2) ^ 0.5 * 1.61 * 100
end
else
outputDebugString("Not an element. Can't get speed")
return false
end
end
</syntaxhighlight>
</section>

==Example==
<section name="Server-side example" class="server" show="true">
This example adds command that outputs to chat current player speed in both mph and kph. Notice: When player is in car his ped is having same velocity as car, so it isn't needed to get his car element.
<syntaxhighlight lang="lua">
addCommandHandler("getmyspeed",
function (player, cmd)
outputChatBox ("Your speed in mph: "..getElementSpeed(player, "mph"),player)
outputChatBox ("Your speed in kph: "..getElementSpeed(player, "kph"),player)
end
)
</syntaxhighlight>
</section>

Original function by author of '''speedx''' resource. Modified, wiki-fied etc by '''varez'''.

==See Also==
{{Useful_Functions}}
<nowiki>Insert non-formatted text here</nowiki>

GetElementSpeed

2010-08-08T13:25:52Z

Varez: Created page with '{{Useful Function}} test :)'

{{Useful Function}}
test :)

ToggleControl

2010-08-03T14:58:05Z

Varez: /* Example */

__NOTOC__
{{Server client function}}
{{Needs Checking|By enabling a control all bindings belonging to it seem to be deleted. (tested clientside) --[[User:NeonBlack|NeonBlack]] 16:48, 28 August 2009 (UTC)}}
Enables or disables the use of a GTA control for a specific player.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">bool toggleControl ( player thePlayer, string control, bool enabled ) </syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player you wish to toggle the control ability of.
*'''control:''' The control that you want to toggle the ability of. See [[control names]] for a list of possible controls.
*'''enable:''' A boolean value representing whether or not the key will be usable or not.
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">bool toggleControl ( string control, bool enabled ) </syntaxhighlight>

===Required Arguments===
*'''control:''' The control that you want to toggle the ability of. See [[control names]] for a list of possible controls.
*'''enable:''' A boolean value representing whether or not the key will be usable or not.
</section>

==Returns==
This function ''true'' if the control was set successfully, ''false'' otherwise.

==Example==
<section name="Example 1" class="server" show="true">
This function will disable the use of the vehicle secondary-fire key for anyone in a Hydra, consequently removing the ability to fire rockets.
<syntaxhighlight lang="lua">
function disableFireForHydra ( theVehicle, seat, jacked )
if ( getElementModel ( theVehicle ) == 520 ) then -- if they entered a hydra
toggleControl ( source, "vehicle_secondary_fire", false ) -- disable their fire key
else -- if they entered another vehicle
toggleControl ( source, "vehicle_secondary_fire", true ) -- enable their fire key
end
end
addEventHandler ( "onPlayerVehicleEnter", getRootElement(), disableFireForHydra )
</syntaxhighlight>
''Note: The same can be achieved by using [[setVehicleGunsEnabled]]''.
</section>
<section name="Example 2" class="client" show="true">
This function will disable the use of the vehicle secondary-fire key for anyone in a Hydra, consequently removing the ability to fire rockets.
<syntaxhighlight lang="lua">
function disableFireForHydra ( theVehicle, seat )
if ( getElementModel ( theVehicle ) == 520 ) then -- if they entered a hydra
toggleControl ( "vehicle_secondary_fire", false ) -- disable their fire key
else -- if they entered another vehicle
toggleControl ( "vehicle_secondary_fire", true ) -- enable their fire key
end
end
addEventHandler ( "onClientPlayerVehicleEnter", getLocalPlayer(), disableFireForHydra )
</syntaxhighlight>
''Note: The same can be achieved by using [[setVehicleGunsEnabled]]''.
</section>

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

OnElementDataChange

2010-05-23T21:45:38Z

Varez:

__NOTOC__
{{Server event}}
This event is triggered when an elementdata entry for an element changes. A client can perform this change on the element or it can be done using [[setElementData]].

==Parameters==
<syntaxhighlight lang="lua">
string theName, var theOldValue
</syntaxhighlight>

*'''theName''': The name of the element data entry that changed
*'''theOldValue''': The old value of this entry before it changed. The new value can be accessed using [[getElementData]] ( source, theName ).

==Source==
The [[event system#Event source|source]] of this event is the [[element]] whose elementdata changed.

==Example==
<section name="Server" class="server" show="true">

This example outputs a message to players when any of their element data values is changed.

<syntaxhighlight lang="lua">
function outputChange(dataName,oldValue)
if getElementType(source) == "player" then -- check if the element is a player
local newValue = getElementData(source,dataName) -- find the new value
outputChatBox("Your element data '"..tostring(dataName).."' has changed from '"..tostring(oldValue).."' to '"..tostring(newValue).."'",source) -- output the change for the affected player
end
end
addEventHandler("onElementDataChange",getRootElement(),outputChange)
</syntaxhighlight>
</section>

{{See also/Server event|Element events}}

IsMTAWindowActive

2010-02-18T11:50:59Z

Varez: /* Example */

__NOTOC__
{{Client function}}
This function returns whether the any system windows that take focus are active. This includes the chatbox input, console window, main menu and transferbox.
To get the status of the debug view, see [[isDebugViewActive]].

==Syntax==
<syntaxhighlight lang="lua">
bool isMTAWindowActive ()
</syntaxhighlight>

===Returns===
Returns ''true'' if the focus is on the MTA window, ''false'' if isn't.

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

==See Also==
{{GUI_functions}}
[[Category:Needs Example]]