Difference between revisions of "SetCondition (CMS)"
From The Official Visionaire Studio: Adventure Game Engine Wiki
Line 12: | Line 12: | ||
2a. Usage example #1: set condition example as true, access globally | 2a. Usage example #1: set condition example as true, access globally | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
− | + | setCondition("example", true) | |
</syntaxhighlight> | </syntaxhighlight> | ||
2b. Usage example #2: toggle condition example, access condition belonging to current scene | 2b. Usage example #2: toggle condition example, access condition belonging to current scene | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
− | + | setCondition("example", nil, game.CurrentScene) | |
</syntaxhighlight> | </syntaxhighlight> | ||
Line 22: | Line 22: | ||
== Main Script == | == Main Script == | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
− | function | + | function setCondition(cond, val, path) |
if path ~= nil then cond = path.Conditions[cond] else cond = Conditions[cond] end -- check global or direct path | if path ~= nil then cond = path.Conditions[cond] else cond = Conditions[cond] end -- check global or direct path | ||
-- + -- | -- + -- |
Revision as of 21:59, 20 August 2022
Name | Type | By |
---|---|---|
setCondition("cond", val, path) | Definition | AFRLme |
This small function allows you to quickly set the boolean value of a condition.
Instructions
1. Add the main script to the Visionaire Studio Script Editor & set the script as a definition script.
2a. Usage example #1: set condition example as true, access globally
setCondition("example", true)
2b. Usage example #2: toggle condition example, access condition belonging to current scene
setCondition("example", nil, game.CurrentScene)
Main Script
function setCondition(cond, val, path)
if path ~= nil then cond = path.Conditions[cond] else cond = Conditions[cond] end -- check global or direct path
-- + --
if val == nil then -- check if condition should be toggled
if cond.Value then cond.Value = false else cond.Value = true end -- toggle condition
else
cond.Value = val -- update condition based on val (true or false)
end
end
Syntax Breakdown
Name | Type | Description |
---|---|---|
cond | "string" | This should be a "string" value containing the name of the condition you want to update the boolean value of. |
val | boolean or nil | This should contain a boolean value of true or false, or nil if you want to toggle the condition. |
path | path | This should contain the direct path to the condition, for example: game.CurrentScene or Scenes["example"] or Characters["Tom"], etc. |