From 156474c43273d70ce4bb27aae818fe90cb0ee9bb Mon Sep 17 00:00:00 2001 From: Peter Date: Mon, 16 Aug 2021 15:58:23 +0100 Subject: [PATCH] Update --- functions/index.html | 2 +- search/search_index.json | 2 +- sitemap.xml | 16 ++++++++-------- sitemap.xml.gz | Bin 203 -> 203 bytes 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/functions/index.html b/functions/index.html index 7ebf725..1535ed7 100644 --- a/functions/index.html +++ b/functions/index.html @@ -877,7 +877,7 @@

Progress

UI_Tween.progress(obj, amount, duration, easing, events)

local obj = script:GetCustomProperty("obj")
 
-UI_Tween.move_y(obj, .75, 4, UI_Tween.Out_Bounce)
+UI_Tween.progress(obj, .75, 4, UI_Tween.Out_Bounce)

Pulse

UI_Tween.pulse(obj, size, duration, count, easing, events)

diff --git a/search/search_index.json b/search/search_index.json index be8e970..1b27e91 100644 --- a/search/search_index.json +++ b/search/search_index.json @@ -1 +1 @@ -{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"UI Tween Documentation Welcome to the documentation for UI Tween found in Core Community Content. UI Tween is an API that is suitable for all creators, including those that aren't experienced with Lua. The API comes with easy to use functions that can be used to quickly add some juice to your UI. There are many functions that can be used for various UI components, such as text writing, pulsing images, to simple slide in and out animations. The API supports all the standard easing equations from Robert Penner, as well as support for Curves .","title":"Home"},{"location":"#ui-tween-documentation","text":"Welcome to the documentation for UI Tween found in Core Community Content. UI Tween is an API that is suitable for all creators, including those that aren't experienced with Lua. The API comes with easy to use functions that can be used to quickly add some juice to your UI. There are many functions that can be used for various UI components, such as text writing, pulsing images, to simple slide in and out animations. The API supports all the standard easing equations from Robert Penner, as well as support for Curves .","title":"UI Tween Documentation"},{"location":"credits/","text":"Credits UI Tween comes with 2 example templates. One of those example templates uses the UI Kit by Lakwaai . It shows you how easy it is to add nice animations to existing UI components. A few tweens here and there can make a world of difference to your UI. Artists : Lakwaai Name : UI Kit 1 Lakwaai Links : Lakwaai","title":"Credits"},{"location":"credits/#credits","text":"UI Tween comes with 2 example templates. One of those example templates uses the UI Kit by Lakwaai . It shows you how easy it is to add nice animations to existing UI components. A few tweens here and there can make a world of difference to your UI. Artists : Lakwaai Name : UI Kit 1 Lakwaai Links : Lakwaai","title":"Credits"},{"location":"curves/","text":"Curves UI Tween supports custom curves by passing in a Simple Curve . Below is an example of how to use a curve by creating a custom property and then passing it to one of the functions in the UI Tween API. In the video below, you will see when the animation is played for the first time, it's rather boring. This is because it's using a Linear equation. A curve is created and passed to the function, which can create some interesting effects. local UI_Tween = require ( script : GetCustomProperty ( \"UI_Tween\" )) local image = script : GetCustomProperty ( \"image\" ): WaitForObject () local curve = script : GetCustomProperty ( \"curve\" ) UI_Tween . rotate ( image , 360 , 4 , curve ) Learn more about Curves .","title":"Curves"},{"location":"curves/#curves","text":"UI Tween supports custom curves by passing in a Simple Curve . Below is an example of how to use a curve by creating a custom property and then passing it to one of the functions in the UI Tween API. In the video below, you will see when the animation is played for the first time, it's rather boring. This is because it's using a Linear equation. A curve is created and passed to the function, which can create some interesting effects. local UI_Tween = require ( script : GetCustomProperty ( \"UI_Tween\" )) local image = script : GetCustomProperty ( \"image\" ): WaitForObject () local curve = script : GetCustomProperty ( \"curve\" ) UI_Tween . rotate ( image , 360 , 4 , curve ) Learn more about Curves .","title":"Curves"},{"location":"easings/","text":"Easings All functions in the UI Tween API support all the easings that can be previewed at Easings.net . Below is a full list of the enums that can be passed into the functions used from the UI Tween API. UI_Tween . progress ( level_bar , .65 , 2 , UI_Tween . Out_Bounce ) In the above example, the progress bar will move to .65 and bounce as it approaches the end because of the UI_Tween.Out_Bounce easing equation. As well as the easings below, a Curve can also be passed to the function in replace of the easing. UI_Tween.Linear UI_Tween.In_Quad UI_Tween.Out_Quad UI_Tween.In_Out_Quad UI_Tween.Out_In_Quad UI_Tween.In_Cubic UI_Tween.Out_Cubic UI_Tween.In_Out_Cubic UI_Tween.Out_In_Cubic UI_Tween.In_Quart UI_Tween.Out_Quart UI_Tween.In_Out_Quart UI_Tween.Out_In_Quart UI_Tween.In_Quint UI_Tween.Out_Quint UI_Tween.In_Out_Quint UI_Tween.Out_In_Quint UI_Tween.In_Sine UI_Tween.Out_Sine UI_Tween.In_Out_Sine UI_Tween.Out_In_Sine UI_Tween.In_Expo UI_Tween.Out_Expo UI_Tween.In_Out_Expo UI_Tween.Out_In_Expo UI_Tween.In_Circ UI_Tween.Out_Circ UI_Tween.In_Out_Circ UI_Tween.Out_In_Circ UI_Tween.In_Elastic UI_Tween.Out_Elastic UI_Tween.In_Out_Elastic UI_Tween.Out_In_Elastic UI_Tween.In_Back UI_Tween.Out_Back UI_Tween.In_Out_Back UI_Tween.Out_In_Back UI_Tween.In_Bounce UI_Tween.Out_Bounce UI_Tween.In_Out_Bounce UI_Tween.Out_In_Bounce","title":"Easings"},{"location":"easings/#easings","text":"All functions in the UI Tween API support all the easings that can be previewed at Easings.net . Below is a full list of the enums that can be passed into the functions used from the UI Tween API. UI_Tween . progress ( level_bar , .65 , 2 , UI_Tween . Out_Bounce ) In the above example, the progress bar will move to .65 and bounce as it approaches the end because of the UI_Tween.Out_Bounce easing equation. As well as the easings below, a Curve can also be passed to the function in replace of the easing. UI_Tween.Linear UI_Tween.In_Quad UI_Tween.Out_Quad UI_Tween.In_Out_Quad UI_Tween.Out_In_Quad UI_Tween.In_Cubic UI_Tween.Out_Cubic UI_Tween.In_Out_Cubic UI_Tween.Out_In_Cubic UI_Tween.In_Quart UI_Tween.Out_Quart UI_Tween.In_Out_Quart UI_Tween.Out_In_Quart UI_Tween.In_Quint UI_Tween.Out_Quint UI_Tween.In_Out_Quint UI_Tween.Out_In_Quint UI_Tween.In_Sine UI_Tween.Out_Sine UI_Tween.In_Out_Sine UI_Tween.Out_In_Sine UI_Tween.In_Expo UI_Tween.Out_Expo UI_Tween.In_Out_Expo UI_Tween.Out_In_Expo UI_Tween.In_Circ UI_Tween.Out_Circ UI_Tween.In_Out_Circ UI_Tween.Out_In_Circ UI_Tween.In_Elastic UI_Tween.Out_Elastic UI_Tween.In_Out_Elastic UI_Tween.Out_In_Elastic UI_Tween.In_Back UI_Tween.Out_Back UI_Tween.In_Out_Back UI_Tween.Out_In_Back UI_Tween.In_Bounce UI_Tween.Out_Bounce UI_Tween.In_Out_Bounce UI_Tween.Out_In_Bounce","title":"Easings"},{"location":"events/","text":"Events All functions in the UI Tween API support 3 events. Most useful being complete , which allows you to easily perform additional animations one after the other when they complete. start Parameters: obj This event is called when the animation starts. Change Parameters: obj, value, delta_time This event will constantly get called while the animation is in progress. complete Parameters: obj This event will be called when the animation has completed. Below is an example of using all 3 events. UI_Tween . progress ( level_bar , .65 , 2 , UI_Tween . Out_Bounce , { start = function ( obj ) print ( \"Animation Started\" ) end , change = function ( obj , value , dt ) print ( \"Animating\" , value ) end , complete = function () print ( \"Complete\" ) -- Fade out bar UI_Tween . fade_out ( level_bar ) end })","title":"Events"},{"location":"events/#events","text":"All functions in the UI Tween API support 3 events. Most useful being complete , which allows you to easily perform additional animations one after the other when they complete. start Parameters: obj This event is called when the animation starts. Change Parameters: obj, value, delta_time This event will constantly get called while the animation is in progress. complete Parameters: obj This event will be called when the animation has completed. Below is an example of using all 3 events. UI_Tween . progress ( level_bar , .65 , 2 , UI_Tween . Out_Bounce , { start = function ( obj ) print ( \"Animation Started\" ) end , change = function ( obj , value , dt ) print ( \"Animating\" , value ) end , complete = function () print ( \"Complete\" ) -- Fade out bar UI_Tween . fade_out ( level_bar ) end })","title":"Events"},{"location":"examples/","text":"Template Examples UI Tween comes with 3 examples that you can try by dragging and dropping in the example you want to preview, into the Hierarchy . UI Tween - Basic Example This template has 12 examples you can test in play mode by pressing the red buttons. UI Tween - Advanced Example [Lakwaai UI Kit] This template uses the UI Kit by Lakwaai, and shows you how easy it is to get nice UI animations. UI Tween - Curve Example This template shows you how a curve can be used to get some interesting animations.","title":"Template Examples"},{"location":"examples/#template-examples","text":"UI Tween comes with 3 examples that you can try by dragging and dropping in the example you want to preview, into the Hierarchy . UI Tween - Basic Example This template has 12 examples you can test in play mode by pressing the red buttons. UI Tween - Advanced Example [Lakwaai UI Kit] This template uses the UI Kit by Lakwaai, and shows you how easy it is to get nice UI animations. UI Tween - Curve Example This template shows you how a curve can be used to get some interesting animations.","title":"Template Examples"},{"location":"functions/","text":"Animation Functions UI Tween comes with easy to use functions that do all the heavy lifting for you. A custom tweening library under the hood handles all the complex stuff so you can focus on making nice animations. All functions support an easing argument which can either an enum from a list of easing equations supplied by UI Tween , or a Curve . See the Easings page for a full list of all supported types, and Curves for information on how to use a Curve with animations. The UI Tween API supports animation chaining if you prefer to have animations grouped together per obj. UI_Tween . progress ( level_bar , .65 , 2 , UI_Tween . Out_Bounce ). fade_out ( level_bar ) In the above example, instead of putting the fade_out call on a new line, it can be chained on. Chaining doesn't mean it will create a sequence, both animations in the example code above will run at the same time. If you need to delay animations between each other, then spawn a task to prevent blocking. Task . Spawn ( function () UI_Tween . progress ( level_bar , .65 , 2 , UI_Tween . Out_Bounce ) Task . Wait ( 5 ) UI_Tween . fade_out ( level_bar ) end ) In the above example, the progress bar will be tweened, then 5 seconds later, it will fade out. Button Color UI_Tween.button_color(obj, from, to, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . button_color ( obj , obj : GetButtonColor (), Color . RED , 2 ) Button Hover Color UI_Tween.button_hover_color(obj, from, to, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . button_hover_color ( obj , obj : GetHoveredColor (), Color . RED , 2 ) Button Pressed Color UI_Tween.button_pressed_color(obj, from, to, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . button_pressed_color ( obj , obj : GetPressedColor (), Color . RED , 2 ) Button Disabled Color UI_Tween.button_disabled_color(obj, from, to, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . button_disabled_color ( obj , obj : GetDisabledColor (), Color . RED , 2 ) Color UI_Tween.color(obj, from, to, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . color ( obj , obj : GetColor (), Color . RED , 2 ) Fade UI_Tween.fade(obj, from, to, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . fade ( obj , 0 , .5 , 1 ) Fade In UI_Tween.fade_in(obj, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . fade_in ( obj , 1 ) Fade Out UI_Tween.fade_out(obj, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . fade_out ( obj , 1 ) Font Size UI_Tween.font_size(obj, size, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . font_size ( obj , 80 , 3 ) Move UI_Tween.move(obj, x_distance, y_distance, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . move ( obj , 300 , - 50 , 2 ) Move X UI_Tween.move_x(obj, x_distance, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . move_x ( obj , 300 , 2 ) Move Y UI_Tween.move_y(obj, y_distance, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . move_y ( obj , - 100 , 2 ) Progress UI_Tween.progress(obj, amount, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . move_y ( obj , .75 , 4 , UI_Tween . Out_Bounce ) Pulse UI_Tween.pulse(obj, size, duration, count, easing, events) -- Pulse constantly local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . pulse ( obj ) -- Pulse 5 times with custom size local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . pulse ( obj , 50 , 1 , 5 , UI_Tween . Out_Sine ) Punch UI_Tween.punch(obj, size, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . punch ( obj ) Rotate UI_Tween.rotate(obj, amount, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . rotate ( obj , 360 , .6 ) Rotate Right UI_Tween.rotate_right(obj, amount, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . rotate_right ( obj , 360 , .6 ) Rotate Left UI_Tween.rotate_left(obj, amount, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . rotate_left ( obj , 360 , .6 ) Scale UI_Tween.scale(obj, width, height, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . scale ( obj , 400 , 400 , 1 , UI_Tween . Out_Bounce ) Scale Width UI_Tween.scale_width(obj, width, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . scale_width ( obj , 400 , 1 , UI_Tween . Out_Bounce ) Scale Height UI_Tween.scale_height(obj, width, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . scale_height ( obj , 400 , 1 , UI_Tween . Out_Bounce ) Shadow UI_Tween.shadow(obj, x_offset, y_offset, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . shadow ( obj , 10 , 10 , 1 , UI_Tween . In_Out_Circ ) Shadow X UI_Tween.shadow_x(obj, x_offset, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . shadow_x ( obj , 10 , 1 ) Shadow Y UI_Tween.shadow_y(obj, y_offset, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . shadow_y ( obj , 10 , 1 ) Slide Right UI_Tween.slide_right(obj, distance, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . slide_right ( obj , 500 , 1.2 , UI_Tween . Out_Bounce ) Slide Left UI_Tween.slide_left(obj, distance, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . slide_left ( obj , 500 , 1.2 , UI_Tween . Out_Bounce ) Slide Up UI_Tween.slide_up(obj, distance, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . slide_up ( obj , 200 , 1.2 ) Slide Down UI_Tween.slide_down(obj, distance, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . slide_down ( obj , 200 , 1.2 ) Scroll UI_Tween.scroll(obj, offset, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . scroll ( obj , 600 , 5 ) Write UI_Tween.write(obj, text, speed, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . write ( obj , \"Hello World!\" )","title":"Animation Functions"},{"location":"functions/#animation-functions","text":"UI Tween comes with easy to use functions that do all the heavy lifting for you. A custom tweening library under the hood handles all the complex stuff so you can focus on making nice animations. All functions support an easing argument which can either an enum from a list of easing equations supplied by UI Tween , or a Curve . See the Easings page for a full list of all supported types, and Curves for information on how to use a Curve with animations. The UI Tween API supports animation chaining if you prefer to have animations grouped together per obj. UI_Tween . progress ( level_bar , .65 , 2 , UI_Tween . Out_Bounce ). fade_out ( level_bar ) In the above example, instead of putting the fade_out call on a new line, it can be chained on. Chaining doesn't mean it will create a sequence, both animations in the example code above will run at the same time. If you need to delay animations between each other, then spawn a task to prevent blocking. Task . Spawn ( function () UI_Tween . progress ( level_bar , .65 , 2 , UI_Tween . Out_Bounce ) Task . Wait ( 5 ) UI_Tween . fade_out ( level_bar ) end ) In the above example, the progress bar will be tweened, then 5 seconds later, it will fade out.","title":"Animation Functions"},{"location":"functions/#button-color","text":"UI_Tween.button_color(obj, from, to, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . button_color ( obj , obj : GetButtonColor (), Color . RED , 2 )","title":"Button Color"},{"location":"functions/#button-hover-color","text":"UI_Tween.button_hover_color(obj, from, to, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . button_hover_color ( obj , obj : GetHoveredColor (), Color . RED , 2 )","title":"Button Hover Color"},{"location":"functions/#button-pressed-color","text":"UI_Tween.button_pressed_color(obj, from, to, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . button_pressed_color ( obj , obj : GetPressedColor (), Color . RED , 2 )","title":"Button Pressed Color"},{"location":"functions/#button-disabled-color","text":"UI_Tween.button_disabled_color(obj, from, to, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . button_disabled_color ( obj , obj : GetDisabledColor (), Color . RED , 2 )","title":"Button Disabled Color"},{"location":"functions/#color","text":"UI_Tween.color(obj, from, to, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . color ( obj , obj : GetColor (), Color . RED , 2 )","title":"Color"},{"location":"functions/#fade","text":"UI_Tween.fade(obj, from, to, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . fade ( obj , 0 , .5 , 1 )","title":"Fade"},{"location":"functions/#fade-in","text":"UI_Tween.fade_in(obj, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . fade_in ( obj , 1 )","title":"Fade In"},{"location":"functions/#fade-out","text":"UI_Tween.fade_out(obj, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . fade_out ( obj , 1 )","title":"Fade Out"},{"location":"functions/#font-size","text":"UI_Tween.font_size(obj, size, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . font_size ( obj , 80 , 3 )","title":"Font Size"},{"location":"functions/#move","text":"UI_Tween.move(obj, x_distance, y_distance, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . move ( obj , 300 , - 50 , 2 )","title":"Move"},{"location":"functions/#move-x","text":"UI_Tween.move_x(obj, x_distance, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . move_x ( obj , 300 , 2 )","title":"Move X"},{"location":"functions/#move-y","text":"UI_Tween.move_y(obj, y_distance, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . move_y ( obj , - 100 , 2 )","title":"Move Y"},{"location":"functions/#progress","text":"UI_Tween.progress(obj, amount, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . move_y ( obj , .75 , 4 , UI_Tween . Out_Bounce )","title":"Progress"},{"location":"functions/#pulse","text":"UI_Tween.pulse(obj, size, duration, count, easing, events) -- Pulse constantly local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . pulse ( obj ) -- Pulse 5 times with custom size local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . pulse ( obj , 50 , 1 , 5 , UI_Tween . Out_Sine )","title":"Pulse"},{"location":"functions/#punch","text":"UI_Tween.punch(obj, size, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . punch ( obj )","title":"Punch"},{"location":"functions/#rotate","text":"UI_Tween.rotate(obj, amount, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . rotate ( obj , 360 , .6 )","title":"Rotate"},{"location":"functions/#rotate-right","text":"UI_Tween.rotate_right(obj, amount, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . rotate_right ( obj , 360 , .6 )","title":"Rotate Right"},{"location":"functions/#rotate-left","text":"UI_Tween.rotate_left(obj, amount, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . rotate_left ( obj , 360 , .6 )","title":"Rotate Left"},{"location":"functions/#scale","text":"UI_Tween.scale(obj, width, height, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . scale ( obj , 400 , 400 , 1 , UI_Tween . Out_Bounce )","title":"Scale"},{"location":"functions/#scale-width","text":"UI_Tween.scale_width(obj, width, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . scale_width ( obj , 400 , 1 , UI_Tween . Out_Bounce )","title":"Scale Width"},{"location":"functions/#scale-height","text":"UI_Tween.scale_height(obj, width, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . scale_height ( obj , 400 , 1 , UI_Tween . Out_Bounce )","title":"Scale Height"},{"location":"functions/#shadow","text":"UI_Tween.shadow(obj, x_offset, y_offset, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . shadow ( obj , 10 , 10 , 1 , UI_Tween . In_Out_Circ )","title":"Shadow"},{"location":"functions/#shadow-x","text":"UI_Tween.shadow_x(obj, x_offset, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . shadow_x ( obj , 10 , 1 )","title":"Shadow X"},{"location":"functions/#shadow-y","text":"UI_Tween.shadow_y(obj, y_offset, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . shadow_y ( obj , 10 , 1 )","title":"Shadow Y"},{"location":"functions/#slide-right","text":"UI_Tween.slide_right(obj, distance, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . slide_right ( obj , 500 , 1.2 , UI_Tween . Out_Bounce )","title":"Slide Right"},{"location":"functions/#slide-left","text":"UI_Tween.slide_left(obj, distance, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . slide_left ( obj , 500 , 1.2 , UI_Tween . Out_Bounce )","title":"Slide Left"},{"location":"functions/#slide-up","text":"UI_Tween.slide_up(obj, distance, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . slide_up ( obj , 200 , 1.2 )","title":"Slide Up"},{"location":"functions/#slide-down","text":"UI_Tween.slide_down(obj, distance, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . slide_down ( obj , 200 , 1.2 )","title":"Slide Down"},{"location":"functions/#scroll","text":"UI_Tween.scroll(obj, offset, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . scroll ( obj , 600 , 5 )","title":"Scroll"},{"location":"functions/#write","text":"UI_Tween.write(obj, text, speed, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . write ( obj , \"Hello World!\" )","title":"Write"},{"location":"quick-start/","text":"Quick Start If you are only interested in getting straight into using the UI Tween API, then follow the below steps. Drag and Drop the UI_Tween script onto the script you wish to use it in. Require the UI_Tween API. local UI_Tween = require ( script : GetCustomProperty ( \"UI_Tween\" )) Now that you have required the UI_Tween API, you are ready to use it to start animating any UI.","title":"Quick Start"},{"location":"quick-start/#quick-start","text":"If you are only interested in getting straight into using the UI Tween API, then follow the below steps. Drag and Drop the UI_Tween script onto the script you wish to use it in. Require the UI_Tween API. local UI_Tween = require ( script : GetCustomProperty ( \"UI_Tween\" )) Now that you have required the UI_Tween API, you are ready to use it to start animating any UI.","title":"Quick Start"}]} \ No newline at end of file +{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"UI Tween Documentation Welcome to the documentation for UI Tween found in Core Community Content. UI Tween is an API that is suitable for all creators, including those that aren't experienced with Lua. The API comes with easy to use functions that can be used to quickly add some juice to your UI. There are many functions that can be used for various UI components, such as text writing, pulsing images, to simple slide in and out animations. The API supports all the standard easing equations from Robert Penner, as well as support for Curves .","title":"Home"},{"location":"#ui-tween-documentation","text":"Welcome to the documentation for UI Tween found in Core Community Content. UI Tween is an API that is suitable for all creators, including those that aren't experienced with Lua. The API comes with easy to use functions that can be used to quickly add some juice to your UI. There are many functions that can be used for various UI components, such as text writing, pulsing images, to simple slide in and out animations. The API supports all the standard easing equations from Robert Penner, as well as support for Curves .","title":"UI Tween Documentation"},{"location":"credits/","text":"Credits UI Tween comes with 2 example templates. One of those example templates uses the UI Kit by Lakwaai . It shows you how easy it is to add nice animations to existing UI components. A few tweens here and there can make a world of difference to your UI. Artists : Lakwaai Name : UI Kit 1 Lakwaai Links : Lakwaai","title":"Credits"},{"location":"credits/#credits","text":"UI Tween comes with 2 example templates. One of those example templates uses the UI Kit by Lakwaai . It shows you how easy it is to add nice animations to existing UI components. A few tweens here and there can make a world of difference to your UI. Artists : Lakwaai Name : UI Kit 1 Lakwaai Links : Lakwaai","title":"Credits"},{"location":"curves/","text":"Curves UI Tween supports custom curves by passing in a Simple Curve . Below is an example of how to use a curve by creating a custom property and then passing it to one of the functions in the UI Tween API. In the video below, you will see when the animation is played for the first time, it's rather boring. This is because it's using a Linear equation. A curve is created and passed to the function, which can create some interesting effects. local UI_Tween = require ( script : GetCustomProperty ( \"UI_Tween\" )) local image = script : GetCustomProperty ( \"image\" ): WaitForObject () local curve = script : GetCustomProperty ( \"curve\" ) UI_Tween . rotate ( image , 360 , 4 , curve ) Learn more about Curves .","title":"Curves"},{"location":"curves/#curves","text":"UI Tween supports custom curves by passing in a Simple Curve . Below is an example of how to use a curve by creating a custom property and then passing it to one of the functions in the UI Tween API. In the video below, you will see when the animation is played for the first time, it's rather boring. This is because it's using a Linear equation. A curve is created and passed to the function, which can create some interesting effects. local UI_Tween = require ( script : GetCustomProperty ( \"UI_Tween\" )) local image = script : GetCustomProperty ( \"image\" ): WaitForObject () local curve = script : GetCustomProperty ( \"curve\" ) UI_Tween . rotate ( image , 360 , 4 , curve ) Learn more about Curves .","title":"Curves"},{"location":"easings/","text":"Easings All functions in the UI Tween API support all the easings that can be previewed at Easings.net . Below is a full list of the enums that can be passed into the functions used from the UI Tween API. UI_Tween . progress ( level_bar , .65 , 2 , UI_Tween . Out_Bounce ) In the above example, the progress bar will move to .65 and bounce as it approaches the end because of the UI_Tween.Out_Bounce easing equation. As well as the easings below, a Curve can also be passed to the function in replace of the easing. UI_Tween.Linear UI_Tween.In_Quad UI_Tween.Out_Quad UI_Tween.In_Out_Quad UI_Tween.Out_In_Quad UI_Tween.In_Cubic UI_Tween.Out_Cubic UI_Tween.In_Out_Cubic UI_Tween.Out_In_Cubic UI_Tween.In_Quart UI_Tween.Out_Quart UI_Tween.In_Out_Quart UI_Tween.Out_In_Quart UI_Tween.In_Quint UI_Tween.Out_Quint UI_Tween.In_Out_Quint UI_Tween.Out_In_Quint UI_Tween.In_Sine UI_Tween.Out_Sine UI_Tween.In_Out_Sine UI_Tween.Out_In_Sine UI_Tween.In_Expo UI_Tween.Out_Expo UI_Tween.In_Out_Expo UI_Tween.Out_In_Expo UI_Tween.In_Circ UI_Tween.Out_Circ UI_Tween.In_Out_Circ UI_Tween.Out_In_Circ UI_Tween.In_Elastic UI_Tween.Out_Elastic UI_Tween.In_Out_Elastic UI_Tween.Out_In_Elastic UI_Tween.In_Back UI_Tween.Out_Back UI_Tween.In_Out_Back UI_Tween.Out_In_Back UI_Tween.In_Bounce UI_Tween.Out_Bounce UI_Tween.In_Out_Bounce UI_Tween.Out_In_Bounce","title":"Easings"},{"location":"easings/#easings","text":"All functions in the UI Tween API support all the easings that can be previewed at Easings.net . Below is a full list of the enums that can be passed into the functions used from the UI Tween API. UI_Tween . progress ( level_bar , .65 , 2 , UI_Tween . Out_Bounce ) In the above example, the progress bar will move to .65 and bounce as it approaches the end because of the UI_Tween.Out_Bounce easing equation. As well as the easings below, a Curve can also be passed to the function in replace of the easing. UI_Tween.Linear UI_Tween.In_Quad UI_Tween.Out_Quad UI_Tween.In_Out_Quad UI_Tween.Out_In_Quad UI_Tween.In_Cubic UI_Tween.Out_Cubic UI_Tween.In_Out_Cubic UI_Tween.Out_In_Cubic UI_Tween.In_Quart UI_Tween.Out_Quart UI_Tween.In_Out_Quart UI_Tween.Out_In_Quart UI_Tween.In_Quint UI_Tween.Out_Quint UI_Tween.In_Out_Quint UI_Tween.Out_In_Quint UI_Tween.In_Sine UI_Tween.Out_Sine UI_Tween.In_Out_Sine UI_Tween.Out_In_Sine UI_Tween.In_Expo UI_Tween.Out_Expo UI_Tween.In_Out_Expo UI_Tween.Out_In_Expo UI_Tween.In_Circ UI_Tween.Out_Circ UI_Tween.In_Out_Circ UI_Tween.Out_In_Circ UI_Tween.In_Elastic UI_Tween.Out_Elastic UI_Tween.In_Out_Elastic UI_Tween.Out_In_Elastic UI_Tween.In_Back UI_Tween.Out_Back UI_Tween.In_Out_Back UI_Tween.Out_In_Back UI_Tween.In_Bounce UI_Tween.Out_Bounce UI_Tween.In_Out_Bounce UI_Tween.Out_In_Bounce","title":"Easings"},{"location":"events/","text":"Events All functions in the UI Tween API support 3 events. Most useful being complete , which allows you to easily perform additional animations one after the other when they complete. start Parameters: obj This event is called when the animation starts. Change Parameters: obj, value, delta_time This event will constantly get called while the animation is in progress. complete Parameters: obj This event will be called when the animation has completed. Below is an example of using all 3 events. UI_Tween . progress ( level_bar , .65 , 2 , UI_Tween . Out_Bounce , { start = function ( obj ) print ( \"Animation Started\" ) end , change = function ( obj , value , dt ) print ( \"Animating\" , value ) end , complete = function () print ( \"Complete\" ) -- Fade out bar UI_Tween . fade_out ( level_bar ) end })","title":"Events"},{"location":"events/#events","text":"All functions in the UI Tween API support 3 events. Most useful being complete , which allows you to easily perform additional animations one after the other when they complete. start Parameters: obj This event is called when the animation starts. Change Parameters: obj, value, delta_time This event will constantly get called while the animation is in progress. complete Parameters: obj This event will be called when the animation has completed. Below is an example of using all 3 events. UI_Tween . progress ( level_bar , .65 , 2 , UI_Tween . Out_Bounce , { start = function ( obj ) print ( \"Animation Started\" ) end , change = function ( obj , value , dt ) print ( \"Animating\" , value ) end , complete = function () print ( \"Complete\" ) -- Fade out bar UI_Tween . fade_out ( level_bar ) end })","title":"Events"},{"location":"examples/","text":"Template Examples UI Tween comes with 3 examples that you can try by dragging and dropping in the example you want to preview, into the Hierarchy . UI Tween - Basic Example This template has 12 examples you can test in play mode by pressing the red buttons. UI Tween - Advanced Example [Lakwaai UI Kit] This template uses the UI Kit by Lakwaai, and shows you how easy it is to get nice UI animations. UI Tween - Curve Example This template shows you how a curve can be used to get some interesting animations.","title":"Template Examples"},{"location":"examples/#template-examples","text":"UI Tween comes with 3 examples that you can try by dragging and dropping in the example you want to preview, into the Hierarchy . UI Tween - Basic Example This template has 12 examples you can test in play mode by pressing the red buttons. UI Tween - Advanced Example [Lakwaai UI Kit] This template uses the UI Kit by Lakwaai, and shows you how easy it is to get nice UI animations. UI Tween - Curve Example This template shows you how a curve can be used to get some interesting animations.","title":"Template Examples"},{"location":"functions/","text":"Animation Functions UI Tween comes with easy to use functions that do all the heavy lifting for you. A custom tweening library under the hood handles all the complex stuff so you can focus on making nice animations. All functions support an easing argument which can either an enum from a list of easing equations supplied by UI Tween , or a Curve . See the Easings page for a full list of all supported types, and Curves for information on how to use a Curve with animations. The UI Tween API supports animation chaining if you prefer to have animations grouped together per obj. UI_Tween . progress ( level_bar , .65 , 2 , UI_Tween . Out_Bounce ). fade_out ( level_bar ) In the above example, instead of putting the fade_out call on a new line, it can be chained on. Chaining doesn't mean it will create a sequence, both animations in the example code above will run at the same time. If you need to delay animations between each other, then spawn a task to prevent blocking. Task . Spawn ( function () UI_Tween . progress ( level_bar , .65 , 2 , UI_Tween . Out_Bounce ) Task . Wait ( 5 ) UI_Tween . fade_out ( level_bar ) end ) In the above example, the progress bar will be tweened, then 5 seconds later, it will fade out. Button Color UI_Tween.button_color(obj, from, to, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . button_color ( obj , obj : GetButtonColor (), Color . RED , 2 ) Button Hover Color UI_Tween.button_hover_color(obj, from, to, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . button_hover_color ( obj , obj : GetHoveredColor (), Color . RED , 2 ) Button Pressed Color UI_Tween.button_pressed_color(obj, from, to, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . button_pressed_color ( obj , obj : GetPressedColor (), Color . RED , 2 ) Button Disabled Color UI_Tween.button_disabled_color(obj, from, to, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . button_disabled_color ( obj , obj : GetDisabledColor (), Color . RED , 2 ) Color UI_Tween.color(obj, from, to, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . color ( obj , obj : GetColor (), Color . RED , 2 ) Fade UI_Tween.fade(obj, from, to, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . fade ( obj , 0 , .5 , 1 ) Fade In UI_Tween.fade_in(obj, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . fade_in ( obj , 1 ) Fade Out UI_Tween.fade_out(obj, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . fade_out ( obj , 1 ) Font Size UI_Tween.font_size(obj, size, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . font_size ( obj , 80 , 3 ) Move UI_Tween.move(obj, x_distance, y_distance, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . move ( obj , 300 , - 50 , 2 ) Move X UI_Tween.move_x(obj, x_distance, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . move_x ( obj , 300 , 2 ) Move Y UI_Tween.move_y(obj, y_distance, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . move_y ( obj , - 100 , 2 ) Progress UI_Tween.progress(obj, amount, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . progress ( obj , .75 , 4 , UI_Tween . Out_Bounce ) Pulse UI_Tween.pulse(obj, size, duration, count, easing, events) -- Pulse constantly local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . pulse ( obj ) -- Pulse 5 times with custom size local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . pulse ( obj , 50 , 1 , 5 , UI_Tween . Out_Sine ) Punch UI_Tween.punch(obj, size, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . punch ( obj ) Rotate UI_Tween.rotate(obj, amount, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . rotate ( obj , 360 , .6 ) Rotate Right UI_Tween.rotate_right(obj, amount, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . rotate_right ( obj , 360 , .6 ) Rotate Left UI_Tween.rotate_left(obj, amount, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . rotate_left ( obj , 360 , .6 ) Scale UI_Tween.scale(obj, width, height, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . scale ( obj , 400 , 400 , 1 , UI_Tween . Out_Bounce ) Scale Width UI_Tween.scale_width(obj, width, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . scale_width ( obj , 400 , 1 , UI_Tween . Out_Bounce ) Scale Height UI_Tween.scale_height(obj, width, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . scale_height ( obj , 400 , 1 , UI_Tween . Out_Bounce ) Shadow UI_Tween.shadow(obj, x_offset, y_offset, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . shadow ( obj , 10 , 10 , 1 , UI_Tween . In_Out_Circ ) Shadow X UI_Tween.shadow_x(obj, x_offset, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . shadow_x ( obj , 10 , 1 ) Shadow Y UI_Tween.shadow_y(obj, y_offset, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . shadow_y ( obj , 10 , 1 ) Slide Right UI_Tween.slide_right(obj, distance, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . slide_right ( obj , 500 , 1.2 , UI_Tween . Out_Bounce ) Slide Left UI_Tween.slide_left(obj, distance, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . slide_left ( obj , 500 , 1.2 , UI_Tween . Out_Bounce ) Slide Up UI_Tween.slide_up(obj, distance, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . slide_up ( obj , 200 , 1.2 ) Slide Down UI_Tween.slide_down(obj, distance, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . slide_down ( obj , 200 , 1.2 ) Scroll UI_Tween.scroll(obj, offset, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . scroll ( obj , 600 , 5 ) Write UI_Tween.write(obj, text, speed, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . write ( obj , \"Hello World!\" )","title":"Animation Functions"},{"location":"functions/#animation-functions","text":"UI Tween comes with easy to use functions that do all the heavy lifting for you. A custom tweening library under the hood handles all the complex stuff so you can focus on making nice animations. All functions support an easing argument which can either an enum from a list of easing equations supplied by UI Tween , or a Curve . See the Easings page for a full list of all supported types, and Curves for information on how to use a Curve with animations. The UI Tween API supports animation chaining if you prefer to have animations grouped together per obj. UI_Tween . progress ( level_bar , .65 , 2 , UI_Tween . Out_Bounce ). fade_out ( level_bar ) In the above example, instead of putting the fade_out call on a new line, it can be chained on. Chaining doesn't mean it will create a sequence, both animations in the example code above will run at the same time. If you need to delay animations between each other, then spawn a task to prevent blocking. Task . Spawn ( function () UI_Tween . progress ( level_bar , .65 , 2 , UI_Tween . Out_Bounce ) Task . Wait ( 5 ) UI_Tween . fade_out ( level_bar ) end ) In the above example, the progress bar will be tweened, then 5 seconds later, it will fade out.","title":"Animation Functions"},{"location":"functions/#button-color","text":"UI_Tween.button_color(obj, from, to, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . button_color ( obj , obj : GetButtonColor (), Color . RED , 2 )","title":"Button Color"},{"location":"functions/#button-hover-color","text":"UI_Tween.button_hover_color(obj, from, to, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . button_hover_color ( obj , obj : GetHoveredColor (), Color . RED , 2 )","title":"Button Hover Color"},{"location":"functions/#button-pressed-color","text":"UI_Tween.button_pressed_color(obj, from, to, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . button_pressed_color ( obj , obj : GetPressedColor (), Color . RED , 2 )","title":"Button Pressed Color"},{"location":"functions/#button-disabled-color","text":"UI_Tween.button_disabled_color(obj, from, to, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . button_disabled_color ( obj , obj : GetDisabledColor (), Color . RED , 2 )","title":"Button Disabled Color"},{"location":"functions/#color","text":"UI_Tween.color(obj, from, to, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . color ( obj , obj : GetColor (), Color . RED , 2 )","title":"Color"},{"location":"functions/#fade","text":"UI_Tween.fade(obj, from, to, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . fade ( obj , 0 , .5 , 1 )","title":"Fade"},{"location":"functions/#fade-in","text":"UI_Tween.fade_in(obj, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . fade_in ( obj , 1 )","title":"Fade In"},{"location":"functions/#fade-out","text":"UI_Tween.fade_out(obj, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . fade_out ( obj , 1 )","title":"Fade Out"},{"location":"functions/#font-size","text":"UI_Tween.font_size(obj, size, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . font_size ( obj , 80 , 3 )","title":"Font Size"},{"location":"functions/#move","text":"UI_Tween.move(obj, x_distance, y_distance, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . move ( obj , 300 , - 50 , 2 )","title":"Move"},{"location":"functions/#move-x","text":"UI_Tween.move_x(obj, x_distance, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . move_x ( obj , 300 , 2 )","title":"Move X"},{"location":"functions/#move-y","text":"UI_Tween.move_y(obj, y_distance, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . move_y ( obj , - 100 , 2 )","title":"Move Y"},{"location":"functions/#progress","text":"UI_Tween.progress(obj, amount, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . progress ( obj , .75 , 4 , UI_Tween . Out_Bounce )","title":"Progress"},{"location":"functions/#pulse","text":"UI_Tween.pulse(obj, size, duration, count, easing, events) -- Pulse constantly local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . pulse ( obj ) -- Pulse 5 times with custom size local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . pulse ( obj , 50 , 1 , 5 , UI_Tween . Out_Sine )","title":"Pulse"},{"location":"functions/#punch","text":"UI_Tween.punch(obj, size, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . punch ( obj )","title":"Punch"},{"location":"functions/#rotate","text":"UI_Tween.rotate(obj, amount, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . rotate ( obj , 360 , .6 )","title":"Rotate"},{"location":"functions/#rotate-right","text":"UI_Tween.rotate_right(obj, amount, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . rotate_right ( obj , 360 , .6 )","title":"Rotate Right"},{"location":"functions/#rotate-left","text":"UI_Tween.rotate_left(obj, amount, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . rotate_left ( obj , 360 , .6 )","title":"Rotate Left"},{"location":"functions/#scale","text":"UI_Tween.scale(obj, width, height, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . scale ( obj , 400 , 400 , 1 , UI_Tween . Out_Bounce )","title":"Scale"},{"location":"functions/#scale-width","text":"UI_Tween.scale_width(obj, width, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . scale_width ( obj , 400 , 1 , UI_Tween . Out_Bounce )","title":"Scale Width"},{"location":"functions/#scale-height","text":"UI_Tween.scale_height(obj, width, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . scale_height ( obj , 400 , 1 , UI_Tween . Out_Bounce )","title":"Scale Height"},{"location":"functions/#shadow","text":"UI_Tween.shadow(obj, x_offset, y_offset, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . shadow ( obj , 10 , 10 , 1 , UI_Tween . In_Out_Circ )","title":"Shadow"},{"location":"functions/#shadow-x","text":"UI_Tween.shadow_x(obj, x_offset, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . shadow_x ( obj , 10 , 1 )","title":"Shadow X"},{"location":"functions/#shadow-y","text":"UI_Tween.shadow_y(obj, y_offset, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . shadow_y ( obj , 10 , 1 )","title":"Shadow Y"},{"location":"functions/#slide-right","text":"UI_Tween.slide_right(obj, distance, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . slide_right ( obj , 500 , 1.2 , UI_Tween . Out_Bounce )","title":"Slide Right"},{"location":"functions/#slide-left","text":"UI_Tween.slide_left(obj, distance, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . slide_left ( obj , 500 , 1.2 , UI_Tween . Out_Bounce )","title":"Slide Left"},{"location":"functions/#slide-up","text":"UI_Tween.slide_up(obj, distance, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . slide_up ( obj , 200 , 1.2 )","title":"Slide Up"},{"location":"functions/#slide-down","text":"UI_Tween.slide_down(obj, distance, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . slide_down ( obj , 200 , 1.2 )","title":"Slide Down"},{"location":"functions/#scroll","text":"UI_Tween.scroll(obj, offset, duration, easing, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . scroll ( obj , 600 , 5 )","title":"Scroll"},{"location":"functions/#write","text":"UI_Tween.write(obj, text, speed, events) local obj = script : GetCustomProperty ( \"obj\" ) UI_Tween . write ( obj , \"Hello World!\" )","title":"Write"},{"location":"quick-start/","text":"Quick Start If you are only interested in getting straight into using the UI Tween API, then follow the below steps. Drag and Drop the UI_Tween script onto the script you wish to use it in. Require the UI_Tween API. local UI_Tween = require ( script : GetCustomProperty ( \"UI_Tween\" )) Now that you have required the UI_Tween API, you are ready to use it to start animating any UI.","title":"Quick Start"},{"location":"quick-start/#quick-start","text":"If you are only interested in getting straight into using the UI Tween API, then follow the below steps. Drag and Drop the UI_Tween script onto the script you wish to use it in. Require the UI_Tween API. local UI_Tween = require ( script : GetCustomProperty ( \"UI_Tween\" )) Now that you have required the UI_Tween API, you are ready to use it to start animating any UI.","title":"Quick Start"}]} \ No newline at end of file diff --git a/sitemap.xml b/sitemap.xml index 3e002e0..089f01d 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -2,42 +2,42 @@ None - 2021-08-15 + 2021-08-16 daily None - 2021-08-15 + 2021-08-16 daily None - 2021-08-15 + 2021-08-16 daily None - 2021-08-15 + 2021-08-16 daily None - 2021-08-15 + 2021-08-16 daily None - 2021-08-15 + 2021-08-16 daily None - 2021-08-15 + 2021-08-16 daily None - 2021-08-15 + 2021-08-16 daily \ No newline at end of file diff --git a/sitemap.xml.gz b/sitemap.xml.gz index 0d486582666fa252c03c2cd79e99ecdcba8856c7..81474438213e2e52fe58c1723973e6d4a6d62703 100644 GIT binary patch literal 203 zcmV;+05ty}iwFqVd>UZ_|8r?{Wo=<_E_iKh0PU1L4udcZg?CO7WhViKidG?P9XquL zh(ZdHLPF!Tw6|~gQN;zi;lA<4qV#Y~+aaJ)psqI2Q z=v~8$tjN=>O!GsGtllOjJ7HUO_v*nLq0NWUjk6Hx54pp4_zwR&d~Wee@GrH3#zIvD F005>wV9)>n literal 203 zcmV;+05ty}iwFp2KN(>H|8r?{Wo=<_E_iKh0PU1b4uc>Nh4-FUVF@OL@@FRyZdaM#@UpXxmo!c0H#hu6e?q z-hc`yhAmXM3t>1>I*ua&9aJv{AkMcGWETgZt4T9*#5_T_b