ChangeScene (CMS) - Revision history

AFRLme at 13:45, 23 August 2022

2022-08-23T13:45:20Z

AFRLme at 13:44, 23 August 2022

2022-08-23T13:44:32Z

AFRLme at 13:43, 23 August 2022

2022-08-23T13:43:42Z

AFRLme at 13:43, 23 August 2022

2022-08-23T13:43:12Z

AFRLme at 13:42, 23 August 2022

2022-08-23T13:42:02Z

AFRLme at 13:41, 23 August 2022

2022-08-23T13:41:40Z

AFRLme at 13:39, 23 August 2022

2022-08-23T13:39:57Z

AFRLme at 18:05, 25 September 2014

2014-09-25T18:05:36Z

AFRLme: Created page with "{| class="ts" style="width:100%" |- ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left" | By |- | changeScene("s", t, d) || Definitio..."

2014-09-25T18:03:41Z

Created page with "{| class="ts" style="width:100%" |- ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left" | By |- | changeScene("s", t, d) || Definitio..."

New page

{| class="ts" style="width:100%"
|-
! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left" | By
|-
| changeScene("s", t, d) || Definition || AFRLme
|}

This small function allows you to change to another scene, define the scene transition effect & transition time.
{| class="toccolours mw-collapsible mw-collapsed ex"
|-
! Transition Values
|-
| 0: no transition (immediate).
|-
| 1: fade in.
|-
| 2: fade out.
|-
| 3: fade in/out.
|-
| 4: fade in/out (with alpha blending).
|-
| 5: wipe left.
|-
| 6: wipe right.
|-
| 7: fade in/out (circle).
|}

== Instructions ==
1. Add the [[#Main_Script|main script]] to the Visionaire Studio Script Editor & set the script as a definition script.<br/>
2. To change the current scene...
<syntaxhighlight>
changeScene("scene_name", 0, 500)
</syntaxhighlight>

== Main Script ==
<syntaxhighlight>
function changeScene(s, t, d, fe, fd)
fe = game:getInt(VGameFadeEffect); fd = game:getInt(VGameFadeDelay)
-- + --
if t < 0 then t = 0 elseif t > 7 then t = 7 end
game:setValue(VGameFadeEffect, t); game:setValue(VGameFadeDelay, d)
-- + --
game:setValue( VGameCurrentScene, getObject("Scenes[" .. s .. "]") )
-- + --
game:setValue(VGameFadeEffect, fe); game:setValue(VGameFadeDelay, fd)
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
|-
| "s" || "string" || This should be a "string" value containing the name of the scene you want to change to.
|-
| t || integer || This should be an integer value between 0 & 7, which will determine the transition effect.
|-
| d || integer || This should be an integer value containing the transition time between scenes, in milliseconds. (only affects transitions 1-7)
|}

@@ Line 55: / Line 55: @@
   game.CurrentScene = Scenes[scn] -- update scene
   -- + --
-  setDelay(duration, function() -- restore previous scene effects
+  setDelay(duration, function() -- delayed function which will be used to restore previous scene effects
     game.FadeEffect = fe -- restore fade effect back to stored fade effect
     game.FadeDelay = fd -- restore fade duration back to stored fade duration

@@ Line 50: / Line 50: @@
   fd = game.FadeDelay -- store fade delay
   -- + --
   game.FadeEffect = typ -- update fade effect to specified fade effect
   game.GameFadeDelay = duration -- update fade duration to specified fade duration
   -- + --
-  game.CurrentScene = Scenes[scn]
+  game.CurrentScene = Scenes[scn] -- update scene
   -- + --
   setDelay(duration, function() -- restore previous scene effects

@@ Line 71: / Line 71: @@
 | "scn" || "string" || This should be a "string" value containing the name of the scene you want to change to.
 |-
-| typ || integer || This should be an integer value between 0 & 10 or the variable name equivalent, which will be used to determine the transition effect.
+| typ || integer || This should be an integer value between 0 & 10 or the variable name equivalent which will be used to determine the transition effect.
 |-
 | duration || integer || This should be an integer value containing the transition time between scenes in milliseconds.
 |}{{toc}}

@@ Line 71: / Line 71: @@
 | "scn" || "string" || This should be a "string" value containing the name of the scene you want to change to.
 |-
-| typ || integer || This should be an integer value between 0 & 10, which will determine the transition effect.
+| typ || integer || This should be an integer value between 0 & 10 or the variable name equivalent, which will be used to determine the transition effect.
 |-
 | duration || integer || This should be an integer value containing the transition time between scenes in milliseconds.
 |}{{toc}}

@@ Line 25: / Line 25: @@
 | [6] <span class="inlinecode">eShiftRight</span>: wipe right.
 |-
-| [7] eTunnelEffect</span>: tunnel fade in & out (circle).
+| [7] <span class="inlinecode">eTunnelEffect</span>: tunnel fade in & out (circle).
 |-
 | [8] <span class="inlinecode">eFadeShader</span>: requires a shader to be linked via <span class="inlinecode">shaderSetOptions()</span>.

@@ Line 11: / Line 11: @@
 ! Transition Values
 |-
-| [0] eFadeNo: no transition (immediate).
+| [0] <span class="inlinecode">eFadeNo</span>: no transition (immediate).
 |-
-| [1] eFadeIn: fade in.
+| [1] <span class="inlinecode">eFadeIn</span>: fade in.
 |-
-|  [2] eFadeOut: fade out.
+| [2] <span class="inlinecode">eFadeOut</span>: fade out.
 |-
-| [3] eFadeInAndOut: fade in & out.
+| [3] <span class="inlinecode">eFadeInAndOut</span>: fade in & out.
 |-
-| [4] eFadeToNew: fade to new scene (blending).
+| [4] <span class="inlinecode">eFadeToNew</span>: fade to new scene (blending).
 |-
-| [5] eShiftLeft: wipe left.
+| [5] <span class="inlinecode">eShiftLeft</span>: wipe left.
 |-
-| [6] eShiftRight: wipe right.
+| [6] <span class="inlinecode">eShiftRight</span>: wipe right.
 |-
-| [7] eTunnelEffect: tunnel fade in & out (circle).
+| [7] eTunnelEffect</span>: tunnel fade in & out (circle).
 |-
-| [8] eFadeShader: requires a shader to be linked via <span class="inlinecode">shaderSetOptions()</span>.
+| [8] <span class="inlinecode">eFadeShader</span>: requires a shader to be linked via <span class="inlinecode">shaderSetOptions()</span>.
 |-
-| [9] eShiftUp: wipe up.
+| [9] <span class="inlinecode">eShiftUp</span>: wipe up.
 |-
-| [10] eShiftDown: wipe down.
+| [10] <span class="inlinecode">eShiftDown</span>: wipe down.
 |}
 <hr>

@@ Line 3: / Line 3: @@
 ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left" | By
 |-
-| changeScene("s", t, d) || Definition || AFRLme
+| changeScene("scn", typ, duration) || Definition || AFRLme
 |}
+<hr>
 This small function allows you to change to another scene, define the scene transition effect & transition time.
-{| class="toccolours mw-collapsible mw-collapsed ex"
+{| class="toccolours mw-collapsible mw-collapsed ts"
 |-
 ! Transition Values
 |-
-| 0: no transition (immediate).
+| [0] eFadeNo: no transition (immediate).
 |-
-| 1: fade in.
+| [4] eFadeToNew: fade to new scene (blending).
 |-
-| 2: fade out.
+| [5] eShiftLeft: wipe left.
 |-
-| 3: fade in/out.
+| [6] eShiftRight: wipe right.
 |-
-| 4: fade in/out (with alpha blending).
+| [7] eTunnelEffect: tunnel fade in & out (circle).
 |-
-| 5: wipe left.
+| [8] eFadeShader: requires a shader to be linked via <span class="inlinecode">shaderSetOptions()</span>.
 |-
-| 6: wipe right.
+| [9] eShiftUp: wipe up.
 |-
-| 7: fade in/out (circle).
+| [10] eShiftDown: wipe down.
 |}
 == Instructions ==
 . Add the [[#Main_Script|main script]] to the Visionaire Studio Script Editor & set the script as a definition script.<br/>
 . To change the current scene...
-<syntaxhighlight>
+<syntaxhighlight lang="lua">
 changeScene("scene_name", 3, 500) -- fade in/out over 500ms
 </syntaxhighlight>
 == Main Script ==
-<syntaxhighlight>
+<syntaxhighlight lang="lua">
-function changeScene(s, t, d, fe, fd)
+function changeScene(scn, typ, duration, fe, fd)
-  fe = game:getInt(VGameFadeEffect); fd = game:getInt(VGameFadeDelay)
+  fe = game.FadeEffect -- store fade effect
   -- + --
-  if t < 0 then t = 0 elseif t > 7 then t = 7 end
+  if typ < 0 then typ = 0 elseif typ > 10 then typ = 10 end -- fallback in case fade effect is less than 0 or more than 10
-  game:setValue(VGameFadeEffect, t); game:setValue(VGameFadeDelay, d)
+  game.FadeEffect = typ -- update fade effect to specified fade effect
   -- + --
-  game:setValue( VGameCurrentScene, getObject("Scenes[" .. s .. "]") )
+  game.CurrentScene = Scenes[scn]
   -- + --
-  game:setValue(VGameFadeEffect, fe); game:setValue(VGameFadeDelay, fd)
+  setDelay(duration, function() -- restore previous scene effects
 end
 </syntaxhighlight>
 == Syntax Breakdown ==
@@ Line 54: / Line 69: @@
 ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left;width:80%" | Description
 |-
-| "s" || "string" || This should be a "string" value containing the name of the scene you want to change to.
+| "scn" || "string" || This should be a "string" value containing the name of the scene you want to change to.
 |-
-| t || integer || This should be an integer value between 0 & 7, which will determine the transition effect.
+| typ || integer || This should be an integer value between 0 & 10, which will determine the transition effect.
 |-
-| d || integer || This should be an integer value containing the transition time between scenes, in milliseconds. (only affects transitions 1-7)
+| duration || integer || This should be an integer value containing the transition time between scenes in milliseconds.
-|}
+|}{{toc}}