GetEffectSpeed: Difference between revisions
Jump to navigation
Jump to search
(Created page with "__NOTOC__ {{Client function}} {{New items|4.0132|1.4 r6208| This function gets the speed the effect. }} ==Syntax== <syntaxhighlight lang="lua"> float getEffectSpeed(effect) </syntaxhighlight> ===Requ...") |
mNo edit summary |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
{{New items| | {{New items|3.014|1.4 r6208| | ||
This function gets the speed | This function gets the speed of a specified [[effect]]. | ||
}} | }} | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
float | float getEffectSpeed ( effect theEffect ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[effect]]:getSpeed|speed|setEffectSpeed}} | |||
===Required Arguments=== | ===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=== | ===Example=== | ||
This example adds command ''ges'' that creates crate explosion effect at the player's position and outputs its speed to the chatbox. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
addCommandHandler("ges", | addCommandHandler("ges", | ||
function (cmd) | function (cmd) | ||
local x, y, z = getElementPosition (localPlayer) | local x, y, z = getElementPosition(localPlayer) | ||
local effect = createEffect (" | local effect = createEffect("explosion_crate", x, y, z) | ||
getEffectSpeed (effect) | outputChatBox("The speed: " .. tostring(getEffectSpeed(effect))) | ||
end) | end) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==See also== | ==See also== | ||
{{Client_Effects_functions}} | {{Client_Effects_functions}} | ||
[[ru: | [[ru:getEffectSpeed]] | ||
Latest revision as of 13:55, 7 May 2017
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.
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)