CreateEffect - Revision history

Srslyyyy: /* Example */

2025-07-21T19:58:52Z

Example

← Older revision		Revision as of 19:58, 21 July 2025
Line 30:		Line 30:

	==Example==		==Example==
	This example allows you to create effect by 'B' key (use mouse scroll up/down to switch effect).		This example allows you to create effect by using 'B' key (use mouse scroll up/down to switch effect).
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local effectSwitchUpKey = "mouse_wheel_up"		local effectSwitchUpKey = "mouse_wheel_up"

Srslyyyy: /* Example */

2025-07-21T19:57:43Z

Example

← Older revision		Revision as of 19:57, 21 July 2025
Line 56:		Line 56:

	local function createEffectManually()		local function createEffectManually()
	local effectX, effectY, effectZ = ~~getElementPosition~~(~~localPlayer~~)		local playerX, playerY, playerZ = getElementPosition(localPlayer)
			local effectX, effectY, effectZ = playerX, playerY, (playerZ + 2)
	local effectRX, effectRY, effectRZ = 0, 0, 0		local effectRX, effectRY, effectRZ = 0, 0, 0
	local effectDrawDistance = 300		local effectDrawDistance = 300

Srslyyyy: Better example to preview effects

2025-07-21T19:55:47Z

Better example to preview effects

← Older revision		Revision as of 19:55, 21 July 2025
Line 30:		Line 30:

	==Example==		==Example==
			This example allows you to create effect by 'B' key (use mouse scroll up/down to switch effect).
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~-- There are 82 effects~~		local effectSwitchUpKey = "mouse_wheel_up"
			local effectSwitchDownKey = "mouse_wheel_down"
			local effectCreateKey = "b"

	local effectNames = {		local effectNames = {
Line 46:		Line 49:
	}		}

	~~function createEff(_,~~ effectID)		local effectID = 1
	effectID = ~~tonumber~~(~~effectID~~)		local effectName = effectNames[effectID]
			local effectCount = (#effectNames) -- there are 82 effects

	~~if effectID then~~		outputChatBox("Effect set to: #ffa500"..effectName.."#ffffff (ID: #ffa500"..effectID.."#ffffff)", 255, 255, 255, true)
	~~local validID = effectID > 0 and~~ effectID <= #~~effectNames~~

	~~if validID then~~		local function createEffectManually()
	local ~~effectName = effectNames[effectID]~~		local effectX, effectY, effectZ = getElementPosition(localPlayer)
	local ~~playerX~~, ~~playerY~~, ~~playerZ~~ = getElementPosition(localPlayer)		local effectRX, effectRY, effectRZ = 0, 0, 0
			local effectDrawDistance = 300
			local effectSoundEnable = false

	createEffect(effectName, ~~playerX~~, ~~playerY~~, ~~playerZ~~, 0, 0, 0)		outputChatBox("Created effect: #ffa500"..effectName.."#ffffff (ID: #ffa500"..effectID.."#ffffff)", 255, 255, 255, true)
	~~end~~		createEffect(effectName, effectX, effectY, effectZ, effectRX, effectRY, effectRZ, effectDrawDistance, effectSoundEnable)
	~~end~~
	end		end
	~~addCommandHandler~~("~~effect~~", ~~createEff~~)		bindKey(effectCreateKey, "down", createEffectManually)

	-~~- Example~~: ~~/effect 3~~		local function switchEffect(keyName)
			local effectSwitchUp = (keyName == effectSwitchUpKey)
			local effectSwitchFactor = (effectSwitchUp and 1 or -1)
			local effectSwitchTempID = (effectID + effectSwitchFactor)
			local effectSwitchID = (effectSwitchTempID > effectCount and 1 or effectSwitchTempID < 1 and effectCount or effectSwitchTempID)

			effectID = effectSwitchID
			effectName = effectNames[effectID]

			outputChatBox("Effect set to: #ffa500"..effectName.."#ffffff (ID: #ffa500"..effectID.."#ffffff)", 255, 255, 255, true)
			end
			bindKey(effectSwitchDownKey, "down", switchEffect)
			bindKey(effectSwitchUpKey, "down", switchEffect)
	</syntaxhighlight>		</syntaxhighlight>

Srslyyyy: Improve example.

2021-12-20T22:56:58Z

Improve example.

← Older revision		Revision as of 22:56, 20 December 2021
Line 31:		Line 31:
	==Example==		==Example==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
			-- There are 82 effects
	--There are 82 effects

	local effectNames = {		local effectNames = {
	"blood_heli","boat_prop","camflash","carwashspray","cement","cloudfast","coke_puff","coke_trail","cigarette_smoke",		"blood_heli", "boat_prop", "camflash", "carwashspray", "cement", "cloudfast", "coke_puff", "coke_trail", "cigarette_smoke",
	"explosion_barrel","explosion_crate","explosion_door","exhale","explosion_fuel_car","explosion_large","explosion_medium",		"explosion_barrel", "explosion_crate", "explosion_door", "exhale", "explosion_fuel_car", "explosion_large", "explosion_medium",
	"explosion_molotov","explosion_small","explosion_tiny","extinguisher","flame","fire","fire_med","fire_large","flamethrower",		"explosion_molotov", "explosion_small", "explosion_tiny", "extinguisher", "flame", "fire", "fire_med", "fire_large", "flamethrower",
	"fire_bike","fire_car","gunflash","gunsmoke","insects","heli_dust","jetpack","jetthrust","nitro","molotov_flame",		"fire_bike", "fire_car", "gunflash", "gunsmoke", "insects", "heli_dust", "jetpack", "jetthrust", "nitro", "molotov_flame",
	"overheat_car","overheat_car_electric","prt_blood","prt_boatsplash","prt_bubble","prt_cardebris","prt_collisionsmoke",		"overheat_car", "overheat_car_electric", "prt_blood", "prt_boatsplash", "prt_bubble", "prt_cardebris", "prt_collisionsmoke",
	"prt_glass","prt_gunshell","prt_sand","prt_sand2","prt_smokeII_3_expand","prt_smoke_huge","prt_spark","prt_spark_2",		"prt_glass", "prt_gunshell", "prt_sand", "prt_sand2", "prt_smokeII_3_expand", "prt_smoke_huge", "prt_spark", "prt_spark_2",
	"prt_splash","prt_wake","prt_watersplash","prt_wheeldirt","petrolcan","puke","riot_smoke","spraycan","smoke30lit","smoke30m",		"prt_splash", "prt_wake", "prt_watersplash", "prt_wheeldirt", "petrolcan", "puke", "riot_smoke", "spraycan", "smoke30lit", "smoke30m",
	"smoke50lit","shootlight","smoke_flare","tank_fire","teargas","teargasAD","tree_hit_fir","tree_hit_palm","vent","vent2",		"smoke50lit", "shootlight", "smoke_flare", "tank_fire", "teargas", "teargasAD", "tree_hit_fir", "tree_hit_palm", "vent", "vent2",
	"water_hydrant","water_ripples","water_speed","water_splash","water_splash_big","water_splsh_sml","water_swim","waterfall_end",		"water_hydrant", "water_ripples", "water_speed", "water_splash", "water_splash_big", "water_splsh_sml", "water_swim", "waterfall_end",
	"water_fnt_tme","water_fountain","wallbust","WS_factorysmoke"		"water_fnt_tme", "water_fountain", "wallbust", "WS_factorysmoke"
	}		}

	~~addCommandHandler("createEffect",~~ function(_, ~~effectIndex~~)		function createEff(_, effectID)
	~~effectIndex~~ = tonumber(~~effectIndex~~)		effectID = tonumber(effectID)
	if ~~effectIndex and type(effectIndex) == "number"~~ then
	~~if effectIndex~~ > 0 and ~~effectIndex~~ <= #effectNames then		if effectID then
	~~createEffect(~~effectNames[~~effectIndex~~], ~~Vector3(~~ getElementPosition( ~~getLocalPlayer() ) ), 0, 0, 0)~~		local validID = effectID > 0 and effectID <= #effectNames
	~~end~~
	~~end~~		if validID then
	~~end~~)		local effectName = effectNames[effectID]
			local playerX, playerY, playerZ = getElementPosition(localPlayer)

	~~--Example Command: /~~createEffect 3		createEffect(effectName, playerX, playerY, playerZ, 0, 0, 0)
			end
			end
			end
			addCommandHandler("effect", createEff)

			-- Example: /effect 3
	</syntaxhighlight>		</syntaxhighlight>

NanoBob: /* Syntax */

2019-03-06T12:19:40Z

Syntax

← Older revision		Revision as of 12:19, 6 March 2019
Line 7:		Line 7:
	{{Note\|All effects have their own duration.}}		{{Note\|All effects have their own duration.}}
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">effect createEffect ( string name, float x, float y, float z [, float rX, float rY, float rZ, float drawDistance = 0, soundEnable = false ] )</syntaxhighlight>		<syntaxhighlight lang="lua">effect createEffect ( string name, float x, float y, float z [, float rX, float rY, float rZ, float drawDistance = 0, bool soundEnable = false ] )</syntaxhighlight>
	{{OOP\|\|[[Effect]]}}		{{OOP\|\|[[Effect]]}}

Zver-CR at 08:30, 8 November 2018

2018-11-08T08:30:40Z

← Older revision		Revision as of 08:30, 8 November 2018
Line 7:		Line 7:
	{{Note\|All effects have their own duration.}}		{{Note\|All effects have their own duration.}}
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">effect createEffect ( string name, float x, float y, float z [, float rX, float rY, float rZ, float drawDistance = 0, ~~soundEnabled~~ = false ] )</syntaxhighlight>		<syntaxhighlight lang="lua">effect createEffect ( string name, float x, float y, float z [, float rX, float rY, float rZ, float drawDistance = 0, soundEnable = false ] )</syntaxhighlight>
	{{OOP\|\|[[Effect]]}}		{{OOP\|\|[[Effect]]}}

Line 23:		Line 23:
	*'''drawDistance:''' A floating point number between 1 and 8191 which represents the draw distance of the effect, or 0 to use the default draw distance.		*'''drawDistance:''' A floating point number between 1 and 8191 which represents the draw distance of the effect, or 0 to use the default draw distance.
	{{New feature/item\|3.0155\|1.5.5\|\|		{{New feature/item\|3.0155\|1.5.5\|\|
	*'''~~soundEnabled~~:''' to enable the sound of the effect.		*'''soundEnable:''' to enable the sound of the effect.
	}}		}}

Line 63:		Line 63:
	{{ChangelogHeader}}		{{ChangelogHeader}}
	{{ChangelogItem\|1.4.0-9.06892\|Added drawDistance argument}}		{{ChangelogItem\|1.4.0-9.06892\|Added drawDistance argument}}
			{{ChangelogItem\|1.5.4-9.11631\|Added soundEnable argument}}

	== See Also ==		== See Also ==
	{{Client_Effects_functions}}		{{Client_Effects_functions}}
	[[ru:createEffect]]		[[ru:createEffect]]

JeViCo at 16:38, 14 September 2018

2018-09-14T16:38:32Z

← Older revision		Revision as of 16:38, 14 September 2018
Line 5:		Line 5:
	}}		}}
	{{Note\|Not all effects support rotation (e.g. the "fire" - effect doesn't).}}		{{Note\|Not all effects support rotation (e.g. the "fire" - effect doesn't).}}
	{{Note\|All effects have their own duration).}}		{{Note\|All effects have their own duration.}}
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">effect createEffect ( string name, float x, float y, float z [, float rX, float rY, float rZ, float drawDistance = 0, soundEnabled = false ] )</syntaxhighlight>		<syntaxhighlight lang="lua">effect createEffect ( string name, float x, float y, float z [, float rX, float rY, float rZ, float drawDistance = 0, soundEnabled = false ] )</syntaxhighlight>

JeViCo at 16:38, 14 September 2018

2018-09-14T16:38:15Z

← Older revision		Revision as of 16:38, 14 September 2018
Line 5:		Line 5:
	}}		}}
	{{Note\|Not all effects support rotation (e.g. the "fire" - effect doesn't).}}		{{Note\|Not all effects support rotation (e.g. the "fire" - effect doesn't).}}
			{{Note\|All effects have their own duration).}}
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">effect createEffect ( string name, float x, float y, float z [, float rX, float rY, float rZ, float drawDistance = 0, soundEnabled = false ] )</syntaxhighlight>		<syntaxhighlight lang="lua">effect createEffect ( string name, float x, float y, float z [, float rX, float rY, float rZ, float drawDistance = 0, soundEnabled = false ] )</syntaxhighlight>

Harrikan at 19:58, 7 October 2017

2017-10-07T19:58:44Z

← Older revision		Revision as of 19:58, 7 October 2017
Line 20:		Line 20:
	*'''rY:''' A floating point number representing the rotation about the Y axis in degrees.		*'''rY:''' A floating point number representing the rotation about the Y axis in degrees.
	*'''rZ:''' A floating point number representing the rotation about the Z axis in degrees.		*'''rZ:''' A floating point number representing the rotation about the Z axis in degrees.
	~~{{New items\|3.06892\|1.4\|~~
	*'''drawDistance:''' A floating point number between 1 and 8191 which represents the draw distance of the effect, or 0 to use the default draw distance.		*'''drawDistance:''' A floating point number between 1 and 8191 which represents the draw distance of the effect, or 0 to use the default draw distance.
	~~\|6892}}~~
	{{New feature/item\|3.0155\|1.5.5\|\|		{{New feature/item\|3.0155\|1.5.5\|\|
	*'''soundEnabled:''' to enable the sound of the effect.		*'''soundEnabled:''' to enable the sound of the effect.

Harrikan at 19:58, 7 October 2017

2017-10-07T19:58:10Z

← Older revision		Revision as of 19:58, 7 October 2017
Line 6:		Line 6:
	{{Note\|Not all effects support rotation (e.g. the "fire" - effect doesn't).}}		{{Note\|Not all effects support rotation (e.g. the "fire" - effect doesn't).}}
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">effect createEffect ( string name, float x, float y, float z [, float rX, float rY, float rZ, float drawDistance = 0 ] )</syntaxhighlight>		<syntaxhighlight lang="lua">effect createEffect ( string name, float x, float y, float z [, float rX, float rY, float rZ, float drawDistance = 0, soundEnabled = false ] )</syntaxhighlight>
	{{OOP\|\|[[Effect]]}}		{{OOP\|\|[[Effect]]}}

Line 23:		Line 23:
	*'''drawDistance:''' A floating point number between 1 and 8191 which represents the draw distance of the effect, or 0 to use the default draw distance.		*'''drawDistance:''' A floating point number between 1 and 8191 which represents the draw distance of the effect, or 0 to use the default draw distance.
	\|6892}}		\|6892}}
			{{New feature/item\|3.0155\|1.5.5\|\|
			*'''soundEnabled:''' to enable the sound of the effect.
			}}

	=== Returns ===		=== Returns ===