SetEffectDensity: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
m (Added warning about variable upper limit.)
 
Line 4: Line 4:
This function sets the density of a specified [[effect]].
This function sets the density of a specified [[effect]].
}}
}}
{{Warning|Upper density limit of this function depends on client FX Quality setting.
The limit is 1 for Low, 1.5 for Medium, and 2 for High/Very high.|true}}


==Syntax==
==Syntax==

Latest revision as of 20:43, 22 August 2017

This function sets the density of a specified effect.


Dialog-warning.png Warning: Upper density limit of this function depends on client FX Quality setting.

The limit is 1 for Low, 1.5 for Medium, and 2 for High/Very high.


Syntax

bool setEffectDensity ( effect theEffect, float density )

OOP Syntax Help! I don't understand this!

Method: effect:setDensity(...)
Variable: .density
Counterpart: getEffectDensity


Required Arguments

  • theEffect: The effect to change the speed of.
  • density: The level of density (from 0 to 2).

Returns

Returns true if the density was succesfully changed, false otherwise.

Example

This example adds command sed that creates spray effect at the player's position and sets its density to 2.

addCommandHandler("sed", 
function (cmd)
   local x, y, z = getElementPosition(localPlayer)
   local effect = createEffect("spraycan", x, y, z)
   setEffectDensity(effect, 2)
end)

See also