GetWeaponClipAmmo: Difference between revisions
Jump to navigation
Jump to search
(This function works only for custom weapons!) |
(Added OOP syntax and improved example (using a table to store a single value makes no sense)) |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
This function gets the amount of ammo in a custom | This function gets the amount of ammo left in a [[Element/Weapon|custom weapon]]'s magazine/clip. | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">int getWeaponClipAmmo ( weapon theWeapon )</syntaxhighlight> | <syntaxhighlight lang="lua">int getWeaponClipAmmo ( weapon theWeapon )</syntaxhighlight> | ||
{{OOP||[[Element/Weapon|weapon]]:getClipAmmo|clipAmmo|setWeaponClipAmmo}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
| Line 10: | Line 11: | ||
===Returns=== | ===Returns=== | ||
Returns the amount of ammo in the custom | Returns the amount of ammo in the [[Element/Weapon|custom weapon]]'s clip, ''false'' if an error occured. | ||
===Example=== | ===Example=== | ||
This function outputs the remaining ammo in clip of a specific weapon using the command 'getammoinclip'. | This function outputs the remaining ammo in clip of a specific weapon using the command ''/getammoinclip''. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
[lua] | [lua] | ||
customWeapon | local customWeapon | ||
addEventHandler( "onClientResourceStart", resourceRoot, | addEventHandler( "onClientResourceStart", resourceRoot, | ||
function() | function() | ||
local x, y, z = getElementPosition(localPlayer) -- Get | local x, y, z = getElementPosition(localPlayer) -- Get player position | ||
customWeapon | customWeapon = createWeapon("m4", x, y, z + 1) -- Create a M4 | ||
setWeaponClipAmmo(customWeapon | setWeaponClipAmmo(customWeapon, 99999) -- Set the ammo in clip of the weapon to 99999, so it never should reload | ||
setWeaponState(customWeapon | setWeaponState(customWeapon, "firing") -- Fire it permanently | ||
-- Add the 'getammoinclip' command to get the remaining ammo in clip of the weapon | -- Add the 'getammoinclip' command to get the remaining ammo in clip of the weapon | ||
addCommandHandler("getammoinclip", getM4WeaponAmmo) | addCommandHandler("getammoinclip", getM4WeaponAmmo) | ||
end | end | ||
| Line 31: | Line 32: | ||
function getM4WeaponAmmo() | function getM4WeaponAmmo() | ||
-- Tell the player the remaining ammo in clip | -- Tell the player the remaining ammo in clip | ||
outputChatBox | outputChatBox(getWeaponClipAmmo(customWeapon)) | ||
end | end | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==See | ==See also== | ||
{{Client weapon creation functions}} | {{Client weapon creation functions}} | ||
Revision as of 16:45, 23 December 2014
This function gets the amount of ammo left in a custom weapon's magazine/clip.
Syntax
int getWeaponClipAmmo ( weapon theWeapon )
OOP Syntax Help! I don't understand this!
- Method: weapon:getClipAmmo(...)
- Variable: .clipAmmo
- Counterpart: setWeaponClipAmmo
Required Arguments
- theWeapon: the weapon to get the clip ammo of.
Returns
Returns the amount of ammo in the custom weapon's clip, false if an error occured.
Example
This function outputs the remaining ammo in clip of a specific weapon using the command /getammoinclip.
[lua]
local customWeapon
addEventHandler( "onClientResourceStart", resourceRoot,
function()
local x, y, z = getElementPosition(localPlayer) -- Get player position
customWeapon = createWeapon("m4", x, y, z + 1) -- Create a M4
setWeaponClipAmmo(customWeapon, 99999) -- Set the ammo in clip of the weapon to 99999, so it never should reload
setWeaponState(customWeapon, "firing") -- Fire it permanently
-- Add the 'getammoinclip' command to get the remaining ammo in clip of the weapon
addCommandHandler("getammoinclip", getM4WeaponAmmo)
end
)
function getM4WeaponAmmo()
-- Tell the player the remaining ammo in clip
outputChatBox(getWeaponClipAmmo(customWeapon))
end
See also
- createWeapon
- fireWeapon
- getWeaponAmmo
- getWeaponClipAmmo
- getWeaponFiringRate
- getWeaponFlags
- getWeaponOwner
- getWeaponProperty
- getWeaponState
- getWeaponTarget
- resetWeaponFiringRate
- setWeaponAmmo
- setWeaponClipAmmo
- setWeaponFiringRate
- setWeaponFlags
- setWeaponProperty
- setWeaponState
- setWeaponTarget