GetEffectSpeed: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 11: Line 11:


===Required Arguments===  
===Required Arguments===  
*'''tehEffect:''' The [[effect]] to get the speed of.
*'''theEffect:''' The [[effect]] to get the speed of.


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

Revision as of 11:11, 30 June 2014

ADDED/UPDATED IN VERSION 1.4 r6208 :

This function gets the speed of a specified effect.

Syntax

float getEffectSpeed ( effect theEffect )

Required Arguments

  • theEffect: The effect to get the speed of.

Returns

Returns float containing the effect's speed, false if invalid arguments were specified.

Example

This example adds command ges that creates crate explosion effect at the player's position and outputs its speed to the chatbox.

[Lua]
addCommandHandler("ges", 
function (cmd)
   local x, y, z = getElementPosition(localPlayer)
   local effect = createEffect("explosion_crate", x, y, z)
   outputChatBox("The speed: " .. tostring(getEffectSpeed(effect)))
end)

See also