View source for CheckCond (CMS)

{| class="ts" style="width:100%"
|-
! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left" | By
|-
| checkCond("c", path) || Definition || AFRLme
|}

This small function allows you to quickly return the boolean value of a condition.


== Instructions ==
1. Add the [[#Main_Script|main script]] to the Visionaire Studio Script Editor & set the script as a definition script.<br/>
2a. Usage Example #1: check if globally accessed condition returns <span style="color:lightgreen">true</span>.
<syntaxhighlight lang="lua">
if checkCond("condition_name") then
 -- add some actions here...
end
</syntaxhighlight>
2b. Usage Example #2: check if globally accessed condition returns <span class="red">false</span>.
<syntaxhighlight lang="lua">
if not checkCond("condition_name") then
 -- add some actions here...
end
</syntaxhighlight>
2c. Usage Example #3: check if direct link condition returns <span class="lightgreen">true</span>.
<syntaxhighlight lang="lua>
if checkCond("condition_name", game.CurrentScene) then
 -- add some actions here...
end
</syntaxhighlight>
2d. Usage Example #4: check if globally accessed condition returns <span class="lightgreen">true</span> via if lua result action part.
<syntaxhighlight lang="lua">
return checkCond("condition_name")
</syntaxhighlight>


== Main Script ==
<syntaxhighlight lang="lua">
function checkCond(c, path)
 if path == nil then c = Conditions[c] else c = path.Conditions[c] end -- check global access or direct link
 return c -- return the boolean value belonging to the condition
end
</syntaxhighlight>


== Syntax Breakdown ==
{| class="ts" style="width:100%"
|-
! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left;width:80%" | Description
|-
| c || "string" || This should be a "string" value containing the name of the condition you want to check the boolean value of.
|-
| path || path || This should contain the direct path to the condition, for example: <span class="inlinecode">game.CurrentScene</span> or <span class="inlinecode">Scenes["example"]</span> or <span class="inlinecode">Characters["Tom"]</span>, etc.
|}{{toc}}