SetEffectDensity: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 2: Line 2:
{{Client function}}
{{Client function}}
{{New items|4.0132|1.4 r6208|
{{New items|4.0132|1.4 r6208|
This function sets the density for the effect.
This function sets the density of a specified [[effect]].
}}
}}


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
void    setEffectDensity(effect, density)
bool setEffectDensity(effect theEffect, float density)
</syntaxhighlight>
</syntaxhighlight>


===Required Arguments===  
===Required Arguments===  
*'''effect:''' The name of the [[Element/Effect#Effects_list|effect]].
*'''theEffect:''' The [[effect]] to change the speed of.
*'''density:''' The level of density.
*'''density:''' The level of density.


===Example===
===Example===
<section name="Client" class="client" show="true">
This example adds command ''sed'' that creates spray effect at the player's position and sets its density to 2.
<syntaxhighlight lang="lua">[Lua]
<syntaxhighlight lang="lua">[Lua]
addCommandHandler("sed",  
addCommandHandler("sed",  
function (cmd)
function (cmd)
   local x, y, z = getElementPosition (localPlayer)
   local x, y, z = getElementPosition(localPlayer)
   local effect = createEffect ("fire_large", x, y, z)
   local effect = createEffect("spraycan", x, y, z)
   setEffectDensity(effect, 2)
   setEffectDensity(effect, 2)
end)
end)
</syntaxhighlight>
</syntaxhighlight>
</section>


==See also==
==See also==
{{Client_Effects_functions}}
{{Client_Effects_functions}}
[[ru:setEffectDensity]]
[[ru:setEffectDensity]]

Revision as of 10:52, 30 June 2014

ADDED/UPDATED IN VERSION 1.4 r6208 :

This function sets the density of a specified effect.

Syntax

bool setEffectDensity(effect theEffect, float density)

Required Arguments

  • theEffect: The effect to change the speed of.
  • density: The level of density.

Example

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

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

See also