FireWeapon: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(added another example that does more than fire a single shot)
 
(9 intermediate revisions by 5 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
Fires one shot from a custom weapon.
Fires one shot from a [[Element/Weapon|custom weapon]].


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">bool fireWeapon ( weapon theWeapon )</syntaxhighlight>
<syntaxhighlight lang="lua">bool fireWeapon ( weapon theWeapon )</syntaxhighlight>
{{OOP||[[Element/Weapon|weapon]]:fire}}


===Required Arguments===
===Required Arguments===
Line 11: Line 12:
===Returns===
===Returns===
Returns ''true'' if the shot weapon is valid and therefore the shot was fired, ''false'' otherwise.
Returns ''true'' if the shot weapon is valid and therefore the shot was fired, ''false'' otherwise.
==Example==
<section name="Example 1" class="client" show="true">
This function creates and fires a weapon.
<syntaxhighlight lang="lua">
function createAndFire()
    local weapon = createWeapon("mp5", 0, 0, 3) -- Create a MP5 at the coordinates 0, 0, 3
    fireWeapon(weapon) -- Fire the weapon we spawned
end
addEventHandler("onClientResourceStart", resourceRoot, createAndFire)
</syntaxhighlight>
</section>
<section name="Example 2" class="client" show="true">
This example will create an M4, attach it to the local player and fire it every frame. Be aware that neither the weapon nor the shots are synced between players and that normally weapons don't fire every frame.
<syntaxhighlight lang="lua">
local wep
function resStart()
wep = createWeapon("m4",0,0,0) -- when the resource starts, create the M4 and attach it to the local player with an offset to place it above their head facing forwards
attachElements(wep,getLocalPlayer(),0,0,1,0,0,90)
end
addEventHandler("onClientResourceStart",getResourceRootElement(getThisResource()), resStart)
function wepFire() -- fire the M4 every frame using the "onClientRender" event
fireWeapon(wep)
end
addEventHandler("onClientRender",getRootElement(),wepFire)
</syntaxhighlight>
</section>


==Requirements==
==Requirements==
{{Requirements|1.3.0-4555|1.3.0-4555|}}
{{Requirements|n/a|1.3.0-9.04555|}}


==See Also==
==See also==
{{Client weapon creation functions}}
{{Client weapon creation functions}}

Latest revision as of 15:43, 23 January 2023

Fires one shot from a custom weapon.

Syntax

bool fireWeapon ( weapon theWeapon )

OOP Syntax Help! I don't understand this!

Method: weapon:fire(...)


Required Arguments

  • theWeapon: The weapon to be fired.

Returns

Returns true if the shot weapon is valid and therefore the shot was fired, false otherwise.

Example

Click to collapse [-]
Example 1

This function creates and fires a weapon. 

function createAndFire()
    local weapon = createWeapon("mp5", 0, 0, 3) -- Create a MP5 at the coordinates 0, 0, 3
    fireWeapon(weapon) -- Fire the weapon we spawned
end
addEventHandler("onClientResourceStart", resourceRoot, createAndFire)
Click to collapse [-]
Example 2

This example will create an M4, attach it to the local player and fire it every frame. Be aware that neither the weapon nor the shots are synced between players and that normally weapons don't fire every frame. 

local wep
function resStart()
	wep = createWeapon("m4",0,0,0) -- when the resource starts, create the M4 and attach it to the local player with an offset to place it above their head facing forwards
	attachElements(wep,getLocalPlayer(),0,0,1,0,0,90)
end
addEventHandler("onClientResourceStart",getResourceRootElement(getThisResource()), resStart)

function wepFire() -- fire the M4 every frame using the "onClientRender" event
	fireWeapon(wep)
end
addEventHandler("onClientRender",getRootElement(),wepFire)

Requirements

Minimum server version n/a
Minimum client version 1.3.0-9.04555

Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version client="1.3.0-9.04555" />

See also


Retrieved from "https://wiki.multitheftauto.com/wiki/FireWeapon?oldid=76046"