SetCondition (CMS) - Revision history

AFRLme at 18:53, 23 August 2022

2022-08-23T18:53:02Z

AFRLme at 13:53, 23 August 2022

2022-08-23T13:53:13Z

AFRLme at 22:16, 20 August 2022

2022-08-20T22:16:39Z

AFRLme at 22:05, 20 August 2022

2022-08-20T22:05:14Z

AFRLme at 21:44, 20 August 2022

2022-08-20T21:44:21Z

AFRLme at 20:59, 20 August 2022

2022-08-20T20:59:57Z

AFRLme at 20:59, 20 August 2022

2022-08-20T20:59:11Z

AFRLme at 20:50, 20 August 2022

2022-08-20T20:50:12Z

AFRLme at 20:47, 20 August 2022

2022-08-20T20:47:58Z

David Stoffel: Text replacement - ""wikitable"" to ""ts""

2014-08-19T17:36:48Z

Text replacement - ""wikitable"" to ""ts""

@@ Line 42: / Line 42: @@
 | 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 <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.
+| val || boolean or nil || This should contain a boolean value of <span class="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> or <span class="inlinecode">Scenes["example"]</span> or <span class="inlinecode">Characters["Tom"]</span>, etc.
 |}{{toc}}

@@ Line 24: / Line 24: @@
 <syntaxhighlight lang="lua">
 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 access or direct link
   -- + --
   if val == nil then -- check if condition should be toggled

← Older revision		Revision as of 22:16, 20 August 2022
Line 7:		Line 7:

	This small function allows you to quickly set or toggle the boolean value of a condition.		This small function allows you to quickly set or toggle the boolean value of a condition.
		+

	== Instructions ==		== Instructions ==

@@ Line 44: / Line 44: @@
 |-
 | 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}}

@@ Line 6: / Line 6: @@
 |}
-This small function allows you to quickly set the boolean value of a condition.
+This small function allows you to quickly set or toggle the boolean value of a condition.
 == Instructions ==

@@ Line 12: / Line 12: @@
 a. Usage example #1: set condition example as true, access globally
 <syntaxhighlight lang="lua">
-setCond("example", true)
+setCondition("example", true)
 </syntaxhighlight>
 b. Usage example #2: toggle condition example, access condition belonging to current scene
 <syntaxhighlight lang="lua">
-setCond("example", nil, game.CurrentScene)
+setCondition("example", nil, game.CurrentScene)
 </syntaxhighlight>
@@ Line 22: / Line 22: @@
 == Main Script ==
 <syntaxhighlight lang="lua">
-function setCond(cond, val, path)
+function setCondition(cond, val, path)
   if path ~= nil then cond = path.Conditions[cond] else cond = Conditions[cond] end -- check global or direct path
   -- + --

@@ 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.
 |-
-| 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.
 |}

@@ Line 3: / Line 3: @@
 ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left" | By
 |-
-| setCondition("c", v) || Definition || AFRLme
+| setCondition("cond", val, path) || Definition || AFRLme
 |}
@@ Line 10: / Line 10: @@
 == Instructions ==
 . Add the [[#Main_Script|main script]] to the Visionaire Studio Script Editor & set the script as a definition script.<br/>
-. To use this function you should create an ''execute a script'' action containing...
+a. Usage example #1: set condition example as true, access globally
-<syntaxhighlight>
+<syntaxhighlight lang="lua">
-setCondition("condition_name", true)
+setCond("example", true)
 </syntaxhighlight>
 == Main Script ==
-<syntaxhighlight>
+<syntaxhighlight lang="lua">
-function setCondition(c, v)
+function setCond(cond, val, path)
-  getObject("Conditions[" .. c .. "]"):setValue(VConditionValue, v)
+  if path ~= nil then cond = path.Conditions[cond] else cond = Conditions[cond] end -- check global or direct path
 end
 </syntaxhighlight>
 == Syntax Breakdown ==
@@ Line 27: / Line 39: @@
 ! 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.
+| cond || "string" || This should be a "string" value containing the name of the condition you want to update the boolean value of.
 |-
-| v || boolean || This should contain a boolean value of <span style="color:green">true</span> or <span class="red">false</span>.
+| path || path || This should contain the direct path to the condition, for example: <span class="inlinecode">game.CurrentScene</span>.
 |}

@@ Line 1: / Line 1: @@
-{| class="wikitable" style="width:100%"
+{| class="ts" style="width:100%"
 |-
 ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left" | By
@@ Line 23: / Line 23: @@
 == Syntax Breakdown ==
-{| class="wikitable" style="width:100%"
+{| class="ts" style="width:100%"
 |-
 ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left;width:80%" | Description