Multi Theft Auto: Wiki - User contributions [en]

OnPlayerWeaponFire

2018-07-05T20:41:43Z

Adolfram: /* Example */

{{Server event}}
__NOTOC__
{{New feature/item|3.0153|1.5.3|9921|
This event is called when a player fires a weapon. This does not trigger for projectiles, melee weapons, or camera.
}}
{{Note|This event works only with weapons which have enabled bullet sync.}}
==Parameters==
<syntaxhighlight lang="lua">
int weapon, float endX, float endY, float endZ, element hitElement, float startX, float startY, float startZ
</syntaxhighlight>
*'''weapon''': an [[int]] representing [[weapons|weapon]] used for making a shot.
*'''endX''', '''endY''', '''endZ''': [[float]] world coordinates representing an end point.
*'''hitElement''': an [[element]] which was hit by a shot. Currently this can be only another [[player]]. '''Note: hitElement could be incorrect and should not be relied upon.'''
*'''startX''', '''startY''', '''startZ''': [[float]] world coordinates representing the start of the bullet. '''Note: This is not the gun muzzle.'''

==Source==
The [[event system#Event source|source]] of this event is the [[player]] who fired the weapon.

==Example==
This code creates explosions when the source players shoots.
<syntaxhighlight lang="lua">
addEventHandler ("onPlayerWeaponFire", root,
function (weapon, endX, endY, endZ, hitElement, startX, startY, startZ)
createExplosion(endX, endY, endZ, 2, source);
end
)
</syntaxhighlight>

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

GetThisResource

2016-12-22T21:26:48Z

Adolfram: changed "event" to "command"

{{Server client function}}
__NOTOC__
This function retrieves the resource from which the function call was made.

Note: every resource has a predefined global variable called ''resource'' that contains the resource pointer for that resource, in other words, the value that this function returns.

==Syntax==
<syntaxhighlight lang="lua">
resource getThisResource ( )
</syntaxhighlight>

===Returns===
Returns the resource in which the current script is.

==Example==
This example retrieves the current resource's root element and attaches it to an onResourceStart event handler. This causes the event handler to get called only when the ''current'' resource is started rather than when ''any'' resource is started, thereby reducing unnecessary overhead.
<syntaxhighlight lang="lua">
-- get the root element of this resource (the resource that the script is a part of)
resourceRoot = getResourceRootElement(getThisResource())
--getThisResource() is the same thing as MTA's secret global variable
--"resource" as explained in the note above.

-- create a function to handle the command
function onResourceCommand()
local thisResource = getThisResource()
local resourceName = getResourceName(thisResource)
outputChatBox("You are in the " .. resourceName .. " resource!")
end

-- add the command handler
addCommandHandler("what", onResourceCommand)
</syntaxhighlight>

==See Also==
{{Resource_functions}}

OnPlayerWeaponFire

2016-10-11T23:13:09Z

Adolfram: /* Example */

{{Server event}}
__NOTOC__
{{New feature/item|3.0160|1.5.3|9921|
This event is called when a player fires a weapon. This does not trigger for projectiles, melee weapons, or camera.
}}
{{Note|This event works only with weapons which have enabled bullet sync.}}
==Parameters==
<syntaxhighlight lang="lua">
int weapon, float endX, float endY, float endZ, element hitElement, float startX, float startY, float startZ
</syntaxhighlight>
*'''weapon''': an [[int]] representing [[weapons|weapon]] used for making a shot.
*'''endX''', '''endY''', '''endZ''': [[float]] world coordinates representing an end point.
*'''hitElement''': an [[element]] which was hit by a shot.
*'''startX''', '''startY''', '''startZ''': [[float]] world coordinates representing the start of the bullet. Note: This is not the gun muzzle.

==Example==
{{Example}}

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

<section name="Server" class="server" show="true">
This code outputs the information on debug screen when a player shoots.
<syntaxhighlight lang="lua">
addEventHandler ("onPlayerWeaponFire", root,
function (weapon, endX, endY, endZ, hitElement, startX, startY, startZ)
iprint (getPlayerName(source).. " just shot a " .. getElementType (hitElement) .. " at X: ".. endX .. " Y: " .. endY .. " Z: " .. endZ .. " from X: " .. startX .. " Y: ".. startY .. " Z: " .. startZ .. " with a ".. getWeaponNameFromID (weapon))
end
)
</syntaxhighlight>
</section>