SetAnimSize (CMS) - Revision history

AFRLme at 16:47, 23 August 2022

2022-08-23T16:47:34Z

← Older revision		Revision as of 17:47, 23 August 2022
Line 22:		Line 22:

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

AFRLme at 16:47, 23 August 2022

2022-08-23T16:47:05Z

New page

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

This small function allows you to quickly set the size (percent) immediately of an active animation; or over x time with optional easing.

== 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: update animation size immediately from current size to 10%
<syntaxhighlight lang="lua">
setAnimSize("animation_name", 10)
</syntaxhighlight>
2b. Usage Example #2: update animation size over 2000ms from current size to 10% with easeQuintIn easing.
<syntaxhighlight lang="lua">
setAnimSize("animation_name", 10, 2000, easeQuintIn)
</syntaxhighlight>

== Main Script ==
<syntaxhighlight>
function setAnimSize(anim, val, duration, easing)
duration = duration or 0 -- fallback in case duration equals nil
easing = easing or easeLinearInOut -- fallback in case easing equals nil
-- + --
ActiveAnimations[anim]:to(duration, {Size = val}, easing) -- update animation size
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
|-
| anim || "string" || This should be a "string" value containing the name of the animation you want to affect.
|-
| val || integer || This should be a number value which will used to determine size (percentage) of the linked animation (anim).
|-
| duration || integer || This should contain a number value in milliseconds of how long you want the animation size 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}}

AFRLme at 12:12, 15 August 2014

2014-08-15T12:12:08Z

← Older revision		Revision as of 13:12, 15 August 2014
Line 10:		Line 10:
	== Instructions ==		== Instructions ==
	1. Add the [[#Main_Script\|main script]] to the Visionaire Studio Script Editor & set the script as a definition script.<br/>		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...		2. To use this function you should create an ''execute a script'' action containing...
	<syntaxhighlight>		<syntaxhighlight>
	setAnimSize("animation_name", 200) -- set active animation animation_name's size to 200%		setAnimSize("animation_name", 200) -- set active animation animation_name's size to 200%

AFRLme at 19:01, 14 August 2014

2014-08-14T19:01:50Z

← Older revision		Revision as of 20:01, 14 August 2014
Line 21:		Line 21:
	end		end
	</syntaxhighlight>		</syntaxhighlight>


	== Syntax Breakdown ==		== Syntax Breakdown ==
	{\| class="wikitable" style="width:100%"		{\| 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
	\|-		\|-
	\| ani \|\| "string" \|\| This should be a "string" value containing the name of the animation you want to affect.		\| ani \|\| "string" \|\| This should be a "string" value containing the name of the animation you want to affect.

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).
|}