SetEffectDensity: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Added warning about variable upper limit.) |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
{{New | {{New feature/item|3.0140|1.4|6208| | ||
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== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool setEffectDensity(effect theEffect, float density) | bool setEffectDensity ( effect theEffect, float density ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[effect]]:setDensity|density|getEffectDensity}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
*'''theEffect:''' The [[effect]] to change the speed of. | *'''theEffect:''' The [[effect]] to change the speed of. | ||
*'''density:''' The level of density. | *'''density:''' The level of density (from 0 to 2). | ||
===Returns=== | |||
Returns ''true'' if the density was succesfully changed, ''false'' otherwise. | |||
===Example=== | ===Example=== | ||
This example adds command ''sed'' that creates spray effect at the player's position and sets its density to 2. | This example adds command ''sed'' that creates spray effect at the player's position and sets its density to 2. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
addCommandHandler("sed", | addCommandHandler("sed", | ||
function (cmd) | function (cmd) | ||
Latest revision as of 20:43, 22 August 2017
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. |
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)