SetVal (CMS) - Revision history

AFRLme at 18:44, 23 August 2022

2022-08-23T18:44:25Z

AFRLme at 17:05, 23 August 2022

2022-08-23T17:05:30Z

AFRLme at 17:02, 23 August 2022

2022-08-23T17:02:10Z

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

2014-08-19T17:21:45Z

Text replacement - "wikitable" to "ts"

AFRLme at 19:53, 14 August 2014

2014-08-14T19:53:07Z

AFRLme: Created page with "{| class="wikitable" style="width:100%" |- ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left" | By |- | setVal("v", n) || Definition..."

2014-08-14T19:48:51Z

Created page with "{| class="wikitable" style="width:100%" |- ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left" | By |- | setVal("v", n) || Definition..."

New page

{| class="wikitable" style="width:100%"
|-
! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left" | By
|-
| setVal("v", n) || Definition || AFRLme
|}

This small function allows you to quickly set the string or integer value of a value; ''automatically determines if '''n''' is a string or integer''.

== Instructions ==
1. Add the [[#Main_Script|main script]] to the Visionaire Studio Script Editor & set the script as a definition script.<br/>
2a. To use this function you should create an ''execute a script'' action containing...
<syntaxhighlight>
setVal("value_name", 7) -- set integer value of "value_name" to 7
</syntaxhighlight>
2b. Alternatively to set string value of a value...
<syntaxhighlight>
setVal("value_name", "hello world") -- set string value of "value name" to "hello world"
</syntaxhighlight>

== Main Script ==
<syntaxhighlight>
function setCondition(v, n)
if n:type = "number" then
getObject("Values[" .. v .. "]"):setValue(VValueInt, n) else getObject("Values[" .. v .. "]"):setValue(VValueString, n)
end
end
</syntaxhighlight>

== Syntax Breakdown ==
{| class="wikitable" style="width:100%"
|-
! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left;width:80%" | Description
|-
| v || "string" || This should be a "string" value containing the name of the value you want to affect.
|-
| n || "string" or integer (number) || This should contain a "string" or integer value.
|}

@@ Line 6: / Line 6: @@
 |}
-This small function allows you to quickly set the string or immediately update the integer number belonging to to the specified value; or over x time, just in case you need that functionality for some reason or other.
+This small function allows you to quickly set the string or immediately update the integer number belonging to to the specified value; or over x duration, just in case you need that functionality for some reason or other.
 <hr>
 {| class="ts"

@@ Line 3: / Line 3: @@
 ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left" | By
 |-
-| setVal("v", d) || Definition || AFRLme
+| setVal("v", d, duration) || Definition || AFRLme
 |}
-This small function allows you to quickly set the string or integer number belonging to a value with optional duration for integers, in case you need it.
+This small function allows you to quickly set the string or immediately update the integer number belonging to to the specified value; or over x time, just in case you need that functionality for some reason or other.
 <hr>
 {| class="ts"

@@ Line 3: / Line 3: @@
 ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left" | By
 |-
-| setVal("v", n) || Definition || AFRLme
+| setVal("v", d) || Definition || AFRLme
 |}
-This small function allows you to quickly set the string or integer value of a value; ''automatically determines if '''n''' is a string or integer''.
+This small function allows you to quickly set the string or integer number belonging to a value with optional duration for integers, in case you need it.
 == Instructions ==
 . Add the [[#Main_Script|main script]] to the Visionaire Studio Script Editor & set the script as a definition script.<br/>
-a. To use this function you should create an ''execute a script'' action containing...
+a. Usage Example #1: immediately update integer value of specified value to 7.
-<syntaxhighlight>
+<syntaxhighlight lang="lua">
-setVal("value_name", 7) -- set integer value of "value_name" to 7
+setVal("value_name", 7)
 </syntaxhighlight>
-b. Alternatively to set string value of a value...
+c. Usage Example #3: update string belonging to the specified value to "hello world!".
-<syntaxhighlight>
+<syntaxhighlight lang="lua">
-setVal("value_name", "hello world") -- set string value of "value name" to "hello world"
+setVal("value_name", "hello world!")
 </syntaxhighlight>
 == Main Script ==
-<syntaxhighlight>
+<syntaxhighlight lang="lua">
-function setVal(v, n)
+function setVal(v, d, duration)
-  if type(n) == "number" then
+ duration = duration or 0 -- fallback in case duration equals nil
-   getObject("Values[" .. v .. "]"):setValue(VValueInt, n)
+ -- + --
-  elseif type(n) == "string" then
+  if type(d) == "number" then -- check if number
-   getObject("Values[" .. v .. "]"):setValue(VValueString, n)
+   Values[v]:to(duration, {Int = d}) -- update integer belonging to the specified value
   end
 end
 </syntaxhighlight>
 == Syntax Breakdown ==
@@ Line 37: / Line 52: @@
 | v || "string" || This should be a "string" value containing the name of the value you want to affect.
 |-
-| n || "string" or integer (number) || This should contain a "string" or integer value.
+| d || "string" or integer || This should contain a "string" or number value.
-|}
+|-

@@ 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 31: / Line 31: @@
 == 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