SetAnimSize (CMS) - Revision history

AFRLme at 16:47, 23 August 2022

2022-08-23T16:47:34Z

AFRLme at 16:47, 23 August 2022

2022-08-23T16:47:05Z

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

2014-08-19T17:21:53Z

Text replacement - "wikitable" to "ts"

AFRLme at 12:12, 15 August 2014

2014-08-15T12:12:08Z

AFRLme at 19:01, 14 August 2014

2014-08-14T19:01:50Z

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

2014-08-14T18:38:13Z

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

New page

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

This small function allows you to quickly set the size(%) of an active animation.

== Instructions ==
1. Add the [[#Main_Script|main script]] to the Visionaire Studio Script Editor & set the script as a definition script.<br/>
2. To use this function you should create an execute a script action containing...
<syntaxhighlight>
setAnimSize("animation_name", 200) -- set active animation animation_name's size to 200%
</syntaxhighlight>

== Main Script ==
<syntaxhighlight>
function setAnimSize(ani, n)
getObject("ActiveAnimations[" .. ani .. "]"):setValue(VAnimationSize, n)
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
|-
| ani || "string" || This should be a "string" value containing the name of the animation you want to affect.
|-
| n || integer || This should be an integer (number) value which will determine size(%) of the linked animation (ani).
|}

@@ Line 22: / Line 22: @@
 == Main Script ==
-<syntaxhighlight>
+<syntaxhighlight lang="lua">
 function setAnimSize(anim, val, duration, easing)
   duration = duration or 0 -- fallback in case duration equals nil

@@ 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 23: / Line 23: @@
 == 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 3: / Line 3: @@
 ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left" | By
 |-
-| setAnimSize("ani", n) || Definition || AFRLme
+| setAnimSize("anim", val, duration, easing) || Definition || AFRLme
 |}
-This small function allows you to quickly set the size(%) of an active animation.
+This small function allows you to quickly set the size (percent) immediately of an active animation; or over x time with optional easing.
 == 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. Usage Example #1: update animation size immediately from current size to 10%
-<syntaxhighlight>
+<syntaxhighlight lang="lua">
-setAnimSize("animation_name", 200) -- set active animation animation_name's size to 200%
+setAnimSize("animation_name", 10)
 </syntaxhighlight>
 == Main Script ==
 <syntaxhighlight>
-function setAnimSize(ani, n)
+function setAnimSize(anim, val, duration, easing)
-  getObject("ActiveAnimations[" .. ani .. "]"):setValue(VAnimationSize, n)
+  duration = duration or 0 -- fallback in case duration equals nil
 end
 </syntaxhighlight>
 == Syntax Breakdown ==
@@ Line 27: / Line 37: @@
 ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left;width:80%" | 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.
 |-
-| n || integer || This should be an integer (number) value which will determine size(%) of the linked animation (ani).
+| 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}}