ObjVisibility (CMS) - Revision history

AFRLme at 21:59, 16 November 2022

2022-11-16T21:59:38Z

AFRLme at 21:57, 16 November 2022

2022-11-16T21:57:55Z

AFRLme at 16:49, 23 August 2022

2022-08-23T16:49:37Z

AFRLme at 16:09, 21 August 2022

2022-08-21T16:09:20Z

AFRLme at 16:08, 21 August 2022

2022-08-21T16:08:47Z

AFRLme at 16:08, 21 August 2022

2022-08-21T16:08:27Z

AFRLme at 16:06, 21 August 2022

2022-08-21T16:06:26Z

AFRLme: Created page with "{| class="ts" style="width:100%" |- ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left" | By |- | onjVisibility({t}, val, duration, e..."

2022-08-21T16:05:55Z

Created page with "{| class="ts" style="width:100%" |- ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left" | By |- | onjVisibility({t}, val, duration, e..."

New page

{| class="ts" style="width:100%"
|-
! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left" | By
|-
| onjVisibility({t}, val, duration, easing) || Definition || AFRLme
|}

This small function allows you to quickly adjust the visibility of multiple scene objects, which can be useful for setting up scenes without having to create tons of set visibility action parts.

== 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: immediately update the visibility of all listed scene objects to 0
<syntaxhighlight lang="lua">
objVisibility({"obj1", "obj2", "obj3"}, 0)
</syntaxhighlight>
2b. Usage example #3: update the visibility of all listed scene objects in the linked table to 50% over 250ms with easeQuadOut easing
<syntaxhighlight lang="lua">
local tbl = {"obj1", "obj2", "obj3"}

objVisibility(t, 50, 250, easeQuadOut)
</syntaxhighlight>

== Main Script ==
<syntaxhighlight lang="lua">
function objVisibility(t, val, duration, easing)
duration = duration or 0 -- fallback in case duration equals nil or empty
easing = easing or easeLinearInOut -- fallback in case duration equals nil or emptyObject
-- + --
for i = 1, #t do -- iterate through the tables
game.CurrentScene.Objects[ t[i] ]:to(duration, {Visibility = val}, easing) -- update visibility of currently listed scene object
end
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
|-
| t || table || This should be a table or linked table containing the "names" of the scene objects that you want to update visibility (opacity) value of.
|-
| val || integer || This should contain a number value between 0 & 100, with zero being invisible & 100 being fully visible.
|-
| duration || integer || This should contain a number value in milliseconds of how long you want the visibility to change from the current value to the target value. Use 0 for immediate update.
|-
| easing || integer || This should contain a number value, or the variable name of the easing type that you want to use. Here is a list of available [https://easings.net easing options], however in Visionaire Studio the InOut bits are added to the end instead of the middle.
|}{{toc}}

@@ Line 27: / Line 27: @@
 function objVisibility(t, val, duration, easing)
    duration = duration or 0 -- fallback in case duration equals nil or empty
-   easing = easing or easeLinearInOut -- fallback in case duration equals nil or emptyObject
+   easing = easing or easeLinearInOut -- fallback in case easing equals nil
    -- + --
    for i = 1, #t do -- iterate through the tables

@@ Line 15: / Line 15: @@
 objVisibility({"obj1",  "obj2", "obj3"}, 0)
 </syntaxhighlight>
-b. Usage example #3: update the visibility of all listed scene objects in the linked table to 50% over 250ms with easeQuadOut easing
+b. Usage example #2: update the visibility of all listed scene objects in the linked table to 50% over 250ms with easeQuadOut easing
 <syntaxhighlight lang="lua">
 local tbl = {"obj1", "obj2", "obj3"}

@@ Line 45: / Line 45: @@
 | val || integer || This should contain a number value between 0 & 100, with zero being invisible & 100 being fully visible.
 |-
-| duration || integer || This should contain a number value in milliseconds of how long you want the visibility to change from the current value to the target value.
+| duration || integer || This should contain a number value in milliseconds of how long you want the visibility to take to change from the current value to the target value.
 |-
 | easing || integer || This should contain a number value, or the variable name of the easing type that you want to use. Here is a list of available [https://www.visionaire-studio.com/luadocs/lua.html#easing easing options].
 |}{{toc}}

@@ Line 3: / Line 3: @@
 ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left" | By
 |-
-| onjVisibility({t}, val, duration, easing) || Definition || AFRLme
+| objVisibility({t}, val, duration, easing) || Definition || AFRLme
 |}

@@ Line 47: / Line 47: @@
 | duration || integer || This should contain a number value in milliseconds of how long you want the visibility to change from the current value to the target value. Use 0 for immediate update.
 |-
-| easing || integer || This should contain a number value, or the variable name of the easing type that you want to use. Here is a list of available [https://easings.net easing options], however in Visionaire Studio the InOut bits are added to the end instead of the middle.
+| easing || integer || This should contain a number value, or the variable name of the easing type that you want to use. Here is a list of available [https://www.visionaire-studio.com/luadocs/lua.html#easing easing options].
 |}{{toc}}

@@ Line 19: / Line 19: @@
 local tbl = {"obj1", "obj2", "obj3"}
-objVisibility(t, 50, 250, easeQuadOut)
+objVisibility(tbl, 50, 250, easeQuadOut)
 </syntaxhighlight>