SetEffectDensity - Revision history

Forkerer: Added warning about variable upper limit.

2017-08-22T20:43:10Z

Added warning about variable upper limit.

← Older revision		Revision as of 20:43, 22 August 2017
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==

Necktrox at 13:55, 7 May 2017

2017-05-07T13:55:16Z

← Older revision		Revision as of 13:55, 7 May 2017
Line 20:		Line 20:
	===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">~~[Lua]~~		<syntaxhighlight lang="lua">
	addCommandHandler("sed",		addCommandHandler("sed",
	function (cmd)		function (cmd)

AlexTMjugador: Added OOP syntax

2014-11-26T16:43:17Z

Added OOP syntax

← Older revision		Revision as of 16:43, 26 November 2014
Line 9:		Line 9:
	bool setEffectDensity ( effect theEffect, float density )		bool setEffectDensity ( effect theEffect, float density )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[effect]]:setDensity\|density\|getEffectDensity}}

	===Required Arguments===		===Required Arguments===

AlexTMjugador at 21:02, 16 November 2014

2014-11-16T21:02:40Z

← Older revision		Revision as of 21:02, 16 November 2014
Line 12:		Line 12:
	===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===

Miki785 at 09:58, 7 July 2014

2014-07-07T09:58:52Z

← Older revision		Revision as of 09:58, 7 July 2014
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	{{New ~~items~~\|4.~~0132~~\|1.4 ~~r6208~~\|		{{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]].
	}}		}}

Miki785 at 10:55, 30 June 2014

2014-06-30T10:55:14Z

← Older revision		Revision as of 10:55, 30 June 2014
Line 7:		Line 7:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool setEffectDensity(effect theEffect, float density)		bool setEffectDensity ( effect theEffect, float density )
	</syntaxhighlight>		</syntaxhighlight>

Miki785 at 10:54, 30 June 2014

2014-06-30T10:54:15Z

← Older revision		Revision as of 10:54, 30 June 2014
Line 13:		Line 13:
	*'''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.

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

	===Example===		===Example===

Miki785 at 10:52, 30 June 2014

2014-06-30T10:52:48Z

← Older revision		Revision as of 10:52, 30 June 2014
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]]

Roma ™ at 12:22, 22 June 2014

2014-06-22T12:22:19Z

← Older revision		Revision as of 12:22, 22 June 2014
Line 28:		Line 28:
	==See also==		==See also==
	{{Client_Effects_functions}}		{{Client_Effects_functions}}
	[[ru:~~SetEffectDensity~~]]		[[ru:setEffectDensity]]

Roma ™: create page

2014-06-22T12:13:24Z

create page

New page

__NOTOC__
{{Client function}}
{{New items|4.0132|1.4 r6208|
This function sets the density for the effect.
}}

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

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

===Example===
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">[Lua]
addCommandHandler("sed",
function (cmd)
local x, y, z = getElementPosition (localPlayer)
local effect = createEffect ("fire_large", x, y, z)
setEffectDensity(effect, 2)
end)
</syntaxhighlight>
</section>

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