GetEffectSpeed: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Added OOP syntax)
mNo edit summary
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 gets the speed of a specified [[effect]].
This function gets the speed of a specified [[effect]].
}}
}}

Revision as of 13:06, 30 November 2014

This function gets the speed of a specified effect.

Syntax

float getEffectSpeed ( effect theEffect )

OOP Syntax Help! I don't understand this!

Method: effect:getSpeed(...)
Variable: .speed
Counterpart: setEffectSpeed


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