Difference between revisions of "SetCondition (CMS)"

From The Official Visionaire Studio: Adventure Game Engine Wiki
Line 41: Line 41:
 
| cond || "string" || This should be a "string" value containing the name of the condition you want to update the boolean value of.
 
| cond || "string" || This should be a "string" value containing the name of the condition you want to update the boolean value of.
 
|-
 
|-
| val || boolean || This should contain a boolean value of <span style="color:green">true</span> or <span class="red">false</span> or nil if you want to toggle the condition.
+
| val || boolean || This should contain a boolean value of <span style="color:green">true</span> or <span class="red">false</span>, or <span class="vsyellow">nil</span> if you want to toggle the condition.
 
|-
 
|-
| path || path || This should contain the direct path to the condition, for example: <span class="inlinecode">game.CurrentScene</span>.
+
| 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.
 
|}
 
|}

Revision as of 21:50, 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

setCond("example", true)

2b. Usage example #2: toggle condition example, access condition belonging to current scene

setCond("example", nil, game.CurrentScene)


Main Script

function setCond(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 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.