SetEffectSpeed: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Added OOP syntax)
mNo edit summary
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
{{New items|4.0132|1.4 r6208|
{{New items|3.014|1.4 r6208|
This function sets the speed of a specified [[effect]].
This function sets the speed of a specified [[effect]].
}}
}}
Line 20: Line 20:
===Example===
===Example===
This example adds command ''ses'' that creates effect of a smoke at player's position and sets its speed to 5.
This example adds command ''ses'' that creates effect of a smoke at player's position and sets its speed to 5.
<syntaxhighlight lang="lua">[Lua]
<syntaxhighlight lang="lua">
addCommandHandler("ses",  
addCommandHandler("ses",  
function (cmd)
function (cmd)

Latest revision as of 13:55, 7 May 2017

This function sets the speed of a specified effect.

Syntax

bool setEffectSpeed ( effect theEffect, float speed )

OOP Syntax Help! I don't understand this!

Method: effect:setSpeed(...)
Variable: .speed
Counterpart: getEffectSpeed


Required Arguments

  • theEffect: The effect to change the speed of.
  • speed: The speed to set.

Returns

Returns true if the effect speed was succesfuly changed, false otherwise.

Example

This example adds command ses that creates effect of a smoke at player's position and sets its speed to 5.

addCommandHandler("ses", 
function (cmd)
   local x, y, z = getElementPosition(localPlayer)
   local effect = createEffect("smoke30lit", x, y, z)
   setEffectSpeed(effect, 5)
end)

See also