SetAnimFrames (CMS) - Revision history

AFRLme at 19:33, 21 August 2022

2022-08-21T19:33:47Z

AFRLme at 19:32, 21 August 2022

2022-08-21T19:32:32Z

AFRLme at 19:26, 21 August 2022

2022-08-21T19:26:09Z

AFRLme at 22:16, 20 August 2022

2022-08-20T22:16:09Z

AFRLme at 22:11, 20 August 2022

2022-08-20T22:11:18Z

AFRLme at 19:48, 8 December 2015

2015-12-08T19:48:47Z

AFRLme at 19:47, 8 December 2015

2015-12-08T19:47:59Z

AFRLme at 19:47, 8 December 2015

2015-12-08T19:47:42Z

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

2014-08-19T17:21:54Z

Text replacement - "wikitable" to "ts"

AFRLme at 19:15, 14 August 2014

2014-08-14T19:15:15Z

@@ Line 19: / Line 19: @@
 setAnimFrames("example", 3, 7)
 </syntaxhighlight>
-c. Example #3: update last frame to total amount of animation frames belonging to the animation.
+c. Example #3: force animation to loop between the 3rd frame & the total amount of animation frames belonging to the animation.
 <syntaxhighlight lang="lua">
 setAnimFrames("example", 3, #Animations["example"].Sprites)

@@ Line 18: / Line 18: @@
 <syntaxhighlight lang="lua">
 setAnimFrames("example", 3, 7)
 </syntaxhighlight>

@@ Line 23: / Line 23: @@
 == Main Script ==
 <syntaxhighlight lang="lua">
-function setFrames(anim, f, t)
+function setAnimFrames(anim, f, t)
    t = t or f -- fallback in case t equals nil
    if f > t then f = t end -- fallback in case f is greater than t

@@ Line 7: / Line 7: @@
 This small function allows you to quickly set the frame range of an animation.
 == 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. Example #1: forcing an animation to loop a single animation frame, in this case animation frame #1.
-<syntaxhighlight>
+<syntaxhighlight lang="lua">
-setAnimFrames("example", 1, 1) -- set active animation example's first frame to 1 & last frame to 1
+setAnimFrames("example", 1)
 </syntaxhighlight>
 == Main Script ==
@@ Line 24: / Line 30: @@
 end
 </syntaxhighlight>
 == Syntax Breakdown ==

@@ Line 3: / Line 3: @@
 ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left" | By
 |-
-| setAnimFrames("ani", n1, n2) || Definition || AFRLme
+| setAnimFrames("anim", f, t) || Definition || AFRLme
 |}
-This small function allows you to quickly set the first & last frame of an active animation.
+This small function allows you to quickly set the frame range of an animation.
 == Instructions ==
@@ Line 12: / Line 12: @@
 . To use this function you should create an ''execute a script'' action containing...
 <syntaxhighlight>
-setAnimFrames("animation_name", 1, 1) -- set active animation animation_name's first frame to 1 & last frame to 1
+setAnimFrames("example", 1, 1) -- set active animation example's first frame to 1 & last frame to 1
 </syntaxhighlight>
 == Main Script ==
-<syntaxhighlight>
+<syntaxhighlight lang="lua">
-function setAnimFrames(ani, n1, n2)
+function setFrames(anim, f, t)
- getObject("ActiveAnimations[" .. ani .. "]"):setValue(VAnimationFirstFrame, n1)
+  t = t or f -- fallback in case t equals nil
- getObject("ActiveAnimations[" .. ani .. "]"):setValue(VAnimationLastFrame, n2)
+  if f > t then f = t end -- fallback in case f is greater than t
-end
+  ActiveAnimations[anim].FirstFrame = f -- update from animation frame range
-</syntaxhighlight>
+  ActiveAnimations[anim].LastFrame =  t -- update to animation frame range
 end
 </syntaxhighlight>
 == Syntax Breakdown ==
@@ Line 38: / Line 30: @@
 ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left;width:70%" | Description
 |-
-| ani || "string" || This should be a "string" value containing the name of the animation you want to affect.
+| anim || "string" || This should be a "string" value containing the name of the animation you want to affect.
 |-
-| n1 || integer || This should be an integer (number) value which will determine which frame will be the initial (from) frame of the linked animation (ani).
+| f || integer || This should be an integer (number) value which will determine which frame will be the initial (from) frame of the linked animation (anim).
 |-
-| n2 || integer || This should be an integer (number) value which will determine which frame will be the final (to) frame of the linked animation (ani).
+| t || integer || This should be an integer (number) value which will determine which frame will be the final (to) frame of the linked animation (anim).
 |}{{toc}}

@@ Line 25: / Line 25: @@
 === Shorthand Version ===
 <syntaxhighlight>
-function setFrames(ani, n1, n2)
+function setAnimFrames(ani, n1, n2)
   n2 = n2 or n1 -- fall-back in case n2 = nil (will use same value as n1)
   ActiveAnimations[ani].AnimationFirstFrame = n1

@@ 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 25: / Line 25: @@
 == 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:70%" | Description