CreateEffect

From Multi Theft Auto: Wiki
Revision as of 22:19, 20 November 2014 by Lopez (talk | contribs) (→‎Example: commented second example due to #8641)
Jump to navigation Jump to search

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, float y, float z [, float rX, float rY, float rZ, float drawDistance = 0 ] )

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.
ADDED/UPDATED IN VERSION 1.4 r6892 :
  • drawDistance: A floating point number between 1 and 8191 which represents the draw distance of the effect, or 0 to use the default draw distance.

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
)


Changelog

Version Description
1.4.0-9.06892 Added drawDistance argument

See Also