DgsSizeTo: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(11 intermediate revisions by 2 users not shown)
Line 6: Line 6:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool dgsSizeTo ( element dgsElement, float w, float h, bool relative, bool movetype, string easing = "Linear", float torvx [, float vy = torvx, table settings ])
number/table dgsSizeTo ( element/table dgsElement, float w, float h, bool relative, string easing = "Linear", float duration [, int delay = 0 ])
</syntaxhighlight>
</syntaxhighlight>


===Required Arguments===  
===Required Arguments===  
*'''dgsElement:''' The DGS element to set animation to.
*'''dgsElement:''' The DGS element or a list of DGS elements to set animation to.
*'''w:''' Target Width.
*'''w:''' Target Width.
*'''h:''' Target Height.
*'''h:''' Target Height.
*'''relative:''' Bool that indicates if the w/h are relative to the screen size.
*'''relative:''' Bool that indicates if the w/h are relative to the screen size.
*'''movetype:''' A bool that indicates whether the move type is based on Time or Speed.( For stable and easy, we always pass '''false''' to this argument)
*'''easing:''' The easing function to use for the interpolation (For More Detail :[[Easing]]), or your own easing function created by [[dgsAddEasingFunction]].
*'''easing:''' The easing function to use for the interpolation (For More Detail :[[Easing]]), or your own easing function created by [[addEasingFunction]].
*'''duration:''' An integer of the time(ms) to finish the animation.


===Optional Arguments===
===Optional Arguments===
*'''torvx:''' This is depends on '''movetype'''. If '''movetype''' sets to false, the torvx will be the time(ms) to finish the animation, or it will be a static speed to finish the animation.
*'''delay:''' The delay time before the animation start, can decrease the using of timer.
*'''vy:''' This is depends on '''movetype'''. If '''movetype''' sets to true, this argument will be the Y speed to finish the animation, only need to pass a nil value to it otherwise.
*'''settings:''' A table will be passed to your own easing function.


===Returns===
===Returns===
Returns true if succeed, ''false'' otherwise.
Returns an ''integer''/''table'' indicates the animation ID or a list of animation IDs if succeed, ''false'' otherwise.


==Example==
==Example==
Line 31: Line 29:
parent = DGS:dgsCreateWindow(200,100,400,400,"DGS Parent Window",false) --Create a window
parent = DGS:dgsCreateWindow(200,100,400,400,"DGS Parent Window",false) --Create a window


DGS:dgsSizeTo(parent,400,200,false,false,"OutQuad",2000)  --Set Animation
DGS:dgsSizeTo(parent,400,200,false,"OutQuad",2000)  --Set Animation
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{DGSFUNCTIONS}}
{{DGSFUNCTIONS}}

Latest revision as of 17:05, 2 March 2023

This function allow us to add animation to dgs elements.

Change size of dgs elements with animation effect.

Syntax

number/table dgsSizeTo ( element/table dgsElement, float w, float h, bool relative, string easing = "Linear", float duration [, int delay = 0 ])

Required Arguments

  • dgsElement: The DGS element or a list of DGS elements to set animation to.
  • w: Target Width.
  • h: Target Height.
  • relative: Bool that indicates if the w/h are relative to the screen size.
  • easing: The easing function to use for the interpolation (For More Detail :Easing), or your own easing function created by dgsAddEasingFunction.
  • duration: An integer of the time(ms) to finish the animation.

Optional Arguments

  • delay: The delay time before the animation start, can decrease the using of timer.

Returns

Returns an integer/table indicates the animation ID or a list of animation IDs if succeed, false otherwise.

Example

DGS = exports.dgs

parent = DGS:dgsCreateWindow(200,100,400,400,"DGS Parent Window",false)	--Create a window

DGS:dgsSizeTo(parent,400,200,false,"OutQuad",2000)  --Set Animation

See Also

Custom Cursor Functions

Multi Language Supports

Animation

3D Element

3D Interface

3D Line

3D Image

3D Text

Browser

Button

Check Box

Combo Box

Custom Renderer

Edit

Detect Area

Drag'N Drop

Grid List

Image

Memo

Menu

Label

Layout

Line

Progress Bar

Radio Button

Scale Pane

Scroll Bar

Scroll Pane

Selector

Style

Switch Button

Tab Panel

Window

Basic Shape Plugins

Circle

Quadrilateral

Rounded Rectangle

Other Plugins

Blur Box

Canvas

Chart

Color Picker

Effect 3D

Gradient

Mask

Media Browser

Nine Slice

Object Preview Supports

Paste Handler

QRCode

Remote Image

Screen Source

SVG

Tooltips

Retrieved from "https://wiki.multitheftauto.com/wiki/DgsSizeTo?oldid=76245"