Pair: getEffectDensity

This function sets the density of a specified effect.

Caution

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.

OOP Syntax Help! I don't understand this!

• Method:effect:setDensity(...)
• Variable: .density

Syntax

​bool setEffectDensity ( ​effect theEffect, ​float density )

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.

• bool: result

Code Examples

Example 1 Example 2 (OOP)

client

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)

client

OOP Required

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 = localPlayer:getPosition()
    local effect = Effect("spraycan", x, y, z)
    effect.density = 2
end)

See Also

Effects Functions

• createEffect
• fxAddBlood
• fxAddBulletImpact
• fxAddBulletSplash
• fxAddDebris
• fxAddFootSplash
• fxAddGlass
• fxAddGunshot
• fxAddPunchImpact
• fxAddSparks
• fxAddTankFire
• fxAddTyreBurst
• fxAddWaterHydrant
• fxAddWaterSplash
• fxAddWood
• fxCreateParticleNew
• getEffectDensity
• getEffectSpeed
• setEffectDensity
• setEffectSpeed

Effects Elements

• effect

Reference

• Scripting Functions