CreateEffect: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
(added another example)
Line 26: Line 26:
== Example ==  
== Example ==  


<section name="Example" class="client" show="true">
<section name="Example1" class="client" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addCommandHandler("effect",  
addCommandHandler("effect",  
Line 35: Line 35:
else
else
outputChatBox("Bad effect name.")
outputChatBox("Bad effect name.")
end
end
)
</syntaxhighlight>
</section>
<section name="Example2" class="client" show="true">
This example synchronize cam flash effect (without this only local player can see this).
<syntaxhighlight lang="lua">
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
end
end

Revision as of 13:59, 18 March 2014

ADDED/UPDATED IN VERSION 1.4 :

Creates an effect on specified position.


[[{{{image}}}|link=|]] Note: Not all effects support rotation (e.g. the "fire" - effect doesn't).

Syntax

effect createEffect ( string name, float x, floaty, 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

Click to collapse [-]
Example1
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
)
Click to collapse [-]
Example2

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