OnClientPlayerWeaponFire: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
(Minor Example Edits)
Line 17: Line 17:


==Example==  
==Example==  
This example shows player a warning if he hits any other player with minigun.
This example sends a warning to a player, if the player shoots another player with a minigun.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- trigger the event every time player shots
--First, we create a function for the event handler to use.
function onClientPlayerWeaponFireFunc(weapon, ammo, ammoInClip, hitX, hitY, hitZ, hitElement )
function onClientPlayerWeaponFireFunc(weapon, ammo, ammoInClip, hitX, hitY, hitZ, hitElement )
     if weapon == 38 and getElementType(hitElement)=="player" then -- If the player shoots with a minigun, and hits another player...
     if weapon == 38 and getElementType(hitElement)=="player" then -- If the player shoots with a minigun, and hits another player...
Line 25: Line 25:
     end
     end
end
end
-- Don't forget to add the onClientPlayerWeaponFireFunc function as a handler for onClientPlayerWeaponFire
-- Add this as a handler so that the function will be triggered every time the player fires.
addEventHandler ( "onClientPlayerWeaponFire", getRootElement(), onClientPlayerWeaponFireFunc )
addEventHandler ( "onClientPlayerWeaponFire", getRootElement(), onClientPlayerWeaponFireFunc )
</syntaxhighlight>
</syntaxhighlight>

Revision as of 14:09, 5 March 2008

This event is called when player shoots a weapon. This does not trigger for projectiles based, or melee weapons. Also note that this event is only triggered for players nearby the local player's camera. This is due to elements far away being streamed out.

Parameters

int weapon, int ammo, int ammoInClip, float hitX, float hitY, float hitZ, element hitElement
  • weapon: an int representing weapon used for making a shot.
  • ammo: an int ammount of ammo left for this weapon type.
  • ammoInClip: an int ammount of ammo left for this weapon type in clip.
  • hitX, hitY, hitZ: float world coordinates representing a hit point.
  • hitElement: an element which was hit by a shot.

Source

The source of this event is the player who fired the weapon.

Example

This example sends a warning to a player, if the player shoots another player with a minigun.

--First, we create a function for the event handler to use.
function onClientPlayerWeaponFireFunc(weapon, ammo, ammoInClip, hitX, hitY, hitZ, hitElement )
    if weapon == 38 and getElementType(hitElement)=="player" then -- If the player shoots with a minigun, and hits another player...
         outputChatBox ( "Don't kill people with minigun, it's lame!", source ) -- We output a warning to him.
    end
end
-- Add this as a handler so that the function will be triggered every time the player fires.
addEventHandler ( "onClientPlayerWeaponFire", getRootElement(), onClientPlayerWeaponFireFunc )

See Also

Client player events


Client event functions