FxAddTyreBurst: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
(add oop syntax) |
||
| (3 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
[[Image:Fxtyreburst.png|thumb|200px|Tyre burst]] | |||
Creates a tyre burst particle effect (a small white smoke puff). | Creates a tyre burst particle effect (a small white smoke puff). | ||
| Line 8: | Line 8: | ||
bool fxAddTyreBurst ( float posX, float posY, float posZ, float dirX, float dirY, float dirZ ) | bool fxAddTyreBurst ( float posX, float posY, float posZ, float dirX, float dirY, float dirZ ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[Effect]].addTyreBurst}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
*'''posX, posY, posZ:''' the world coordinates where the puff originates. | *'''posX, posY, posZ:''' the world coordinates where the puff originates. | ||
*'''dirX, dirY, dirZ:''' a vector indicating the movement direction of the effect. | *'''dirX, dirY, dirZ:''' a vector indicating the movement direction of the effect. | ||
===Returns=== | |||
Returns a true if the operation was successful, false otherwise. | |||
==Example== | |||
<section name="Client" class="client" show="true"> | |||
This example will create a Tyre Burst Effect next to you when typing ''/tyreburst'' in the Chatbox. | |||
<syntaxhighlight lang="lua"> | |||
addCommandHandler("tyreburst", function() | |||
local x, y, z = getElementPosition(localPlayer) | |||
local gz = getGroundPosition(x, y, z) | |||
fxAddTyreBurst(x, y, gz, 0, 0, 0) | |||
end) | |||
</syntaxhighlight> | |||
</section> | |||
==See Also== | ==See Also== | ||
{{Client Effects functions}} | {{Client Effects functions}} | ||
Latest revision as of 20:59, 2 January 2015
Creates a tyre burst particle effect (a small white smoke puff).
Syntax
bool fxAddTyreBurst ( float posX, float posY, float posZ, float dirX, float dirY, float dirZ )
OOP Syntax Help! I don't understand this!
- Method: Effect.addTyreBurst(...)
Required Arguments
- posX, posY, posZ: the world coordinates where the puff originates.
- dirX, dirY, dirZ: a vector indicating the movement direction of the effect.
Returns
Returns a true if the operation was successful, false otherwise.
Example
Click to collapse [-]
ClientThis example will create a Tyre Burst Effect next to you when typing /tyreburst in the Chatbox.
addCommandHandler("tyreburst", function()
local x, y, z = getElementPosition(localPlayer)
local gz = getGroundPosition(x, y, z)
fxAddTyreBurst(x, y, gz, 0, 0, 0)
end)
See Also
- createEffect
- fxAddBlood
- fxAddBulletImpact
- fxAddBulletSplash
- fxAddDebris
- fxAddFootSplash
- fxAddGlass
- fxAddGunshot
- fxAddPunchImpact
- fxAddSparks
- fxAddTankFire
- fxAddTyreBurst
- fxAddWaterHydrant
- fxAddWaterSplash
- fxAddWood
- getEffectDensity
- getEffectSpeed
- setEffectDensity
- setEffectSpeed