CreateEffect: Difference between revisions
Jump to navigation
Jump to search
m (Improved see also section) |
mNo edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
{{New items| | {{New items|3.0140|1.4| | ||
Creates an [[Element/Effect|effect]] on specified position. | Creates an [[Element/Effect|effect]] on specified position. | ||
}} | }} | ||
| Line 7: | Line 7: | ||
{{Note|Not all effects support rotation (e.g. the "fire" - effect doesn't).}} | {{Note|Not all effects support rotation (e.g. the "fire" - effect doesn't).}} | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">effect createEffect ( string name, float x, float y, float z, | <syntaxhighlight lang="lua">effect createEffect ( string name, float x, float y, float z [, float rX, float rY, float rZ ] )</syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
Revision as of 21:49, 5 July 2014
Creates an effect on specified position.
Syntax
effect createEffect ( string name, float x, float y, float z [, float rX, float rY, float rZ ] )
Required Arguments
- name: A string contains effect name.
- x: A floating point number representing the X coordinate on the map.
- y: A floating point number representing the Y coordinate on the map.
- z: A floating point number representing the Z coordinate on the map.
Optional Arguments
NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.
- rX: A floating point number representing the rotation about the X axis in degrees.
- rY: A floating point number representing the rotation about the Y axis in degrees.
- rZ: A floating point number representing the rotation about the Z axis in degrees.
Returns
Returns the effect element if creation was successful, false otherwise.
Example
addCommandHandler("effect",
function(cmd, name)
local x, y, z = getElementPosition(localPlayer)
if createEffect(name, x, y, z) then
outputChatBox("Effect created!")
else
outputChatBox("Bad effect name.")
end
end
)
This example synchronize cam flash effect (without this only local player can see this).
addEventHandler("onClientPlayerWeaponFire", root,
function(weapon)
if weapon == 43 and source ~= localPlayer then
local x, y, z = getPedWeaponMuzzlePosition(source)
createEffect("camflash", x, y, z)
end
end
)
See Also
- createEffect
- fxAddBlood
- fxAddBulletImpact
- fxAddBulletSplash
- fxAddDebris
- fxAddFootSplash
- fxAddGlass
- fxAddGunshot
- fxAddPunchImpact
- fxAddSparks
- fxAddTankFire
- fxAddTyreBurst
- fxAddWaterHydrant
- fxAddWaterSplash
- fxAddWood
- getEffectDensity
- getEffectSpeed
- setEffectDensity
- setEffectSpeed