OnClientPlayerWeaponFire: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 8: Line 8:


==Parameters==
==Parameters==
*The '''source''' of this event refers to the player who made a shot.
*'''weapon''':  an [[int]] representing [[weapons|weapon]] used for making a shot.
*'''weapon''':  an [[int]] representing [[weapons|weapon]] used for making a shot.
*'''ammo''': an [[int]] ammount of ammo left for this weapon type.
*'''ammo''': an [[int]] ammount of ammo left for this weapon type.
Line 14: Line 13:
*'''hitX''', '''hitY''', '''hitZ''': [[float]] world coordinates representing a hit point.
*'''hitX''', '''hitY''', '''hitZ''': [[float]] world coordinates representing a hit point.
*'''hitElement''': an [[element]] which was hit by a shot.
*'''hitElement''': an [[element]] which was hit by a shot.
==Source==
The [[event system#Event source|source]] of this event is the player who fired the weapon.


==Example==  
==Example==  

Revision as of 12:15, 22 October 2007

This event is called when player shoots a weapon.

Syntax

void onClientPlayerWeaponFire ( int weapon, int ammo, int ammoInClip, float hitX, float hitY, float hitZ, element hitElement )

Parameters

  • 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 shows player a warning if he hits any other player with minigun.

-- trigger the event every time player shots
function onClientPlayerWeaponFireFunc(weapon, ammo, ammoInClip, hitX, hitY, hitZ, hitElement )
    if weapon == 38 and getElementType(hitElement)=="player" then -- if player shots from minigun and he hits another player...
         outputChatBox ( "Don't kill people with minigun, it's lame!", source ) -- then we output him a warning
    end
end
-- don't forget to add the onClientPlayerWeaponFireFunc function as a handler for onClientPlayerWeaponFire
addEventHandler ( "onPlayerSpawn", getRootElement(), onClientPlayerWeaponFireFunc )