SetSceneBrightness (CMS) - Revision history

AFRLme at 18:50, 23 August 2022

2022-08-23T18:50:07Z

AFRLme at 18:46, 23 August 2022

2022-08-23T18:46:33Z

AFRLme at 18:45, 23 August 2022

2022-08-23T18:45:29Z

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

2014-08-19T17:22:30Z

Text replacement - "wikitable" to "ts"

AFRLme at 19:00, 14 August 2014

2014-08-14T19:00:10Z

AFRLme: Created page with "{| class="wikitable" style="width:100%" |- ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left" | By |- | setSceneBrightness("scn" ''o..."

2014-08-14T18:59:20Z

Created page with "{| class="wikitable" style="width:100%" |- ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left" | By |- | setSceneBrightness("scn" ''o..."

New page

{| class="wikitable" style="width:100%"
|-
! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left" | By
|-
| setSceneBrightness("scn" ''or'' nil, n) || Definition || AFRLme
|}

This small function allows you to quickly set the brightness value of the current scene or a specific scene.

== Instructions ==
1. Add the [[#Main_Script|main script]] to the Visionaire Studio Script Editor & set the script as a definition script. 
2a. To use this function you should create an ''execute a script'' action containing...
<syntaxhighlight>
setSceneBrightness("scene_name", 80) -- sets the linked scenes brightness value to 80%
</syntaxhighlight>
2b. Alternatively to automatically link to current scene use this method...
<syntaxhighlight>
setSceneBrightness(nil, 80) -- sets the current scenes brightness value to 80%
</syntaxhighlight>

== Main Script ==
<syntaxhighlight>
function setSceneBrightness(scn, n)
if scn ~= nil then
getObject("Scenes[" .. scn .. "]"):setValue(VSceneBrightness, n)
else
game:getLink(VGameCurrentScene):setValue(VSceneBrightness, 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:70%" | Description
|-
| scn || "string" ''or'' nil || This should be a "string" value containing the name of the scene you want to affect else it should contain the word ''nil''.
|-
| n || integer || This should be an integer (number) value which will determine the brightness value of the linked scene (scn) or the current scene if ''nil'' was used.
|}

@@ Line 41: / Line 41: @@
 ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left;width:80%" | Description
 |-
-| scn || "string" or nil || This should be a "string" value containing the name of the scene you want to affect; if scn equals <span class="inlinecode">nil</span> it will default to the current scene.
+| scn || "string" or nil || This should be a "string" value containing the name of the scene you want to affect; or nil to link to the current scene.
 |-
 | val || integer || This should be a number value which will determine the brightness value of the specifed/current scene.

@@ Line 31: / Line 31: @@
   duration = duration or 0 -- fallback in case duration equals nil
   -- + --
-  scn.Brightness:to(duration, {Brightness = val}) -- update specified scene brightness
+  scn:to(duration, {Brightness = val}) -- update specified scene brightness
 end
 </syntaxhighlight>

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

@@ Line 33: / Line 33: @@
 {| class="wikitable" style="width:100%"
 |-
-! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left;width:70%" | Description
+! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left;width:80%" | Description
 |-
 | scn || "string" ''or'' <span class="blue">nil</span> || This should be a "string" value containing the name of the scene you want to affect else it should contain the word ''<span class="blue">nil</span>''.

@@ Line 3: / Line 3: @@
 ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left" | By
 |-
-| setSceneBrightness("scn" ''or'' nil, n) || Definition || AFRLme
+| setSceneBrightness("scn", val, duration) || Definition || AFRLme
 |}
-This small function allows you to quickly set the brightness value of the current scene or a specific scene.
+This small function  quickly allows you to immediately set the brightness value of the current scene or a specific scene; or over x duration, if desired.
 == 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 the brightness belonging to a specific scene to 80 percent.
-<syntaxhighlight>
+<syntaxhighlight lang="lua">
-setSceneBrightness("scene_name", 80) -- sets the linked scenes brightness value to 80%
+setSceneBrightness("scene_name", 80)
 </syntaxhighlight>
-b. Alternatively to automatically link to current scene use this method...
+b. Usage Example #2: immediately update the brightness belonging to the current scene to 80 percent.
-<syntaxhighlight>
+<syntaxhighlight lang="lua">
-setSceneBrightness(nil, 80) -- sets the current scenes brightness value to 80%
+setSceneBrightness(nil, 80)
 </syntaxhighlight>
 == Main Script ==
-<syntaxhighlight>
+<syntaxhighlight lang="lua">
-function setSceneBrightness(scn, n)
+function setSceneBrightness(scn, val, duration)
-  if scn ~= nil then
+  if scn == nil then scn = game.CurrentScene or scn = Scenes[scn] end -- check current scene or specific scene
-  getObject("Scenes[" .. scn .. "]"):setValue(VSceneBrightness, n)
+ duration = duration or 0 -- fallback in case duration equals nil
-  else
+  -- + --
-  game:getLink(VGameCurrentScene):setValue(VSceneBrightness, n)
+ scn.Brightness:to(duration, {Brightness = val}) -- update specified scene brightness
 end
 </syntaxhighlight>
 == Syntax Breakdown ==
@@ Line 35: / Line 41: @@
 ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left;width:80%" | Description
 |-
-| scn || "string" ''or'' <span class="blue">nil</span> || This should be a "string" value containing the name of the scene you want to affect else it should contain the word ''<span class="blue">nil</span>''.
+| scn || "string" or nil || This should be a "string" value containing the name of the scene you want to affect; if scn equals <span class="inlinecode">nil</span> it will default to the current scene.
 |-
-| n || integer || This should be an integer (number) value which will determine the brightness value of the linked scene (scn) or the current scene if ''<span class="blue">nil</span>'' was used.
+| val || integer || This should be a number value which will determine the brightness value of the specifed/current scene.
-|}
+|-