MoveObj (CMS) - Revision history

AFRLme at 16:11, 23 August 2022

2022-08-23T16:11:02Z

AFRLme at 16:08, 23 August 2022

2022-08-23T16:08:32Z

AFRLme at 16:08, 23 August 2022

2022-08-23T16:08:12Z

AFRLme at 16:07, 23 August 2022

2022-08-23T16:07:53Z

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

2014-08-19T17:22:00Z

Text replacement - "wikitable" to "ts"

AFRLme: /* Syntax Breakdown */

2014-08-15T14:27:11Z

‎Syntax Breakdown

AFRLme: Created page with "{| class="wikitable" style="width:100%" |- ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left" | By |- | moveObj("obj", x, y, delay, ..."

2014-08-15T14:20:16Z

Created page with "{| class="wikitable" style="width:100%" |- ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left" | By |- | moveObj("obj", x, y, delay, ..."

New page

{| class="wikitable" style="width:100%"
|-
! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left" | By
|-
| moveObj("obj", x, y, delay, easing) || Definition || AFRLme
|}

This small function allows you to move an object from one position to another over x amount of time with specified easing.

== 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>
moveObj("object_name", 300, 450, 5000, easeQuintOut) -- move object_name to 350x450 over 5000 milliseconds with easeQuintOut
</syntaxhighlight>

== Main Script ==
<syntaxhighlight>
function moveObj(obj, x, y, delay, easing)
obj = getObject("Game.GameCurrentScene.SceneObjects[" .. obj .. "]")
startObjectTween(obj, VObjectOffset, obj:getPoint(VObjectOffset), {x = x, y = y}, delay, easing)
end
</syntaxhighlight>

== Syntax Breakdown ==
{| class="wikitable" style="width:100%"
|-
! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left;width:80%" | Description
|-
| c || "string" || This should be a "string" value containing the name of the character you want to affect; if string is empty it will default to current character.
|-
| t || "string" || This should be a "string" value containing the name of the object you want to align to.
|}

@@ Line 6: / Line 6: @@
 |}
-This small function allows you to move an object immediately from one position to another (absolute positioning); or over x amount of time with optional easing. (positioning is based on top left pixel belonging to the linked image or animation).
+This small function allows you to move an object immediately from one position to another (absolute positioning); or over x amount of time with optional easing.
+<hr>
 == Instructions ==

@@ Line 14: / Line 14: @@
 <syntaxhighlight lang="lua">
 moveObj("object_name", 100, 100)
-</syntaxhighlight lang="lua">
+</syntaxhighlight>
 b. Usage Example #2: move object over 2000ms from current position to 100, 100 with easeBounceOut easing.
-<syntaxhighlight>
+<syntaxhighlight lang="lua">
 moveObj("object_name", 100, 100, 2000, easeBounceOut)
 </syntaxhighlight>

@@ Line 12: / Line 12: @@
 . Add the [[#Main_Script|main script]] to the Visionaire Studio Script Editor & set the script as a definition script.<br/>
 a. Usage Example #1: move object immediately from current position to 100, 100.
-<syntaxhighlight>
+<syntaxhighlight lang="lua">
 moveObj("object_name", 100, 100)
-</syntaxhighlight>
+</syntaxhighlight lang="lua">
 b. Usage Example #2: move object over 2000ms from current position to 100, 100 with easeBounceOut easing.
 <syntaxhighlight>

@@ Line 3: / Line 3: @@
 ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left" | By
 |-
-| moveObj("obj", x, y, delay, easing) || Definition || AFRLme
+| moveObj("obj", x, y, duration, easing) || Definition || AFRLme
 |}
-This small function allows you to move an object from one position to another over x amount of time with specified easing.
+This small function allows you to move an object immediately from one position to another (absolute positioning); or over x amount of time with optional easing. (positioning is based on top left pixel belonging to the linked image or 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. Usage Example #1: move object immediately from current position to 100, 100.
 <syntaxhighlight>
-moveObj("object_name", 300, 450, 5000, easeQuintOut) -- move object_name to 350x450 over 5000 milliseconds with easeQuintOut
+moveObj("object_name", 100, 100, 2000, easeBounceOut)
 </syntaxhighlight>
 == Main Script ==
-<syntaxhighlight>
+<syntaxhighlight lang="lua">
-function moveObj(obj, x, y, delay, easing)
+function moveObj(obj, x, y, duration, easing, pos)
-  obj = getObject("Game.GameCurrentScene.SceneObjects[" .. obj .. "]")
+ duration = duration or 0 -- fallback in case duration equals nil
-  startObjectTween(obj, VObjectOffset, obj:getPoint(VObjectOffset), {x = x, y = y}, delay, easing)
+ easing = easing or easeLinearInOut -- fallback in case easing equals nil
 end
 </syntaxhighlight>
 == Syntax Breakdown ==
@@ Line 28: / Line 44: @@
 ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left;width:80%" | Description
 |-
-| obj || "string" || This should be a "string" value containing the name of the object you want to affect.
+| obj || "string" || This should be a "string" value containing the name of the object you want to move.
 |-
-| x || integer (number) || This should be a an integer value of the x coordinate you want to move the object to.
+| x || integer || This should contain a number value consisting of the x coordinate you want to move the object to.
 |-
-| y || integer (number) || This should be a an integer value of the y coordinate you want to move the object to.
+| y || integer || This should contain a number value consisting of the y coordinate you want to move the object to.
 |-
-| delay || integer (number) || This should be a an integer value of the amount of time (milliseconds) it should take the object to get from a to b.
+| duration || integer || This should be a an integer value of the amount of time in milliseconds it should take the object to get from current position to the target position.
 |-
-| easing || integer (number) || This should contain the integer value or name of the easing you want to set.
+| 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}}

@@ 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 24: / Line 24: @@
 == 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