View source for IfElse

{{Useful Function}} __NOTOC__
This function just adds a possibility to integrate a condition in e.g. some variable definition. It is as useful as simple. It's like the short “(c) ? t : f ;” statement that exists in e.g. PHP or JavaScript, or COALESCE in MySQL. It simulates a ternary operation.

''Note: This function is basically on the wiki to enable using it in other useful functions.''
<!--
The same can be achieved by using this syntax: x = a and b or c
Meaning: "If a is equal to true then x = b, else x = c"

This operation can be chained too: x = a and (b and ba or bb) or (c and ca or cc)
Meaning: "If a is equal to true then check if b is equal to true and if it is then x = ba, otherwise x = bb.
          Else check if c is equal to true and if it is then x = ca, otherwise x = cc."
-->

==Syntax==
<syntaxhighlight lang="lua">var IfElse( bool condition, var trueReturn, var falseReturn )</syntaxhighlight>

===Required Arguments===
* '''condition''': A condition like you could use it in an if-statement.
* '''trueReturn''': The value that should be returned if the condition is true.
* '''falseReturn''': The value that should be returned if the condition is false.

===Returns===
Returns the second argument if condition is true, the third otherwise.

==Code==
<section name="Server- and/or clientside Script" class="both" show="true">
<syntaxhighlight lang="lua">
function IfElse(condition, trueReturn, falseReturn)
    return condition and trueReturn or falseReturn
end
</syntaxhighlight>
</section>

==Example==
<section name="Server" class="server" show="true">
This example adds a command to retrieve the actual player count.
<syntaxhighlight lang="lua">
-- define the commandhandler function
function CmdPlayerCount(source)
    -- get the actual player count
    local playerCount = getPlayerCount()
    -- send message to the player
    outputChatBox("There "..IfElse(playerCount == 1, "is", "are").." actually "..playerCount.." Player"..IfElse(playerCount == 1, "", "s").." online.", source)
end
-- add the command handler
addCommandHandler("playerCount", CmdPlayerCount, false, false)
</syntaxhighlight>
</section>

Author: NeonBlack

==See Also==
{{Useful_Functions}}