Functions
3TweenPosition
(endPosition: UDim2, easingDirection: EasingDirection = …, easingStyle: EasingStyle = …, time: float = …, override: bool = …, callback: Function = …) → bool
| Field | XML type | Value |
|---|
Name | string | TweenPosition |
summary | string | Smoothly moves a GuiObject from its current position to 'endPosition'. The only required argument is 'endPosition'. <a href="http://wiki.roblox.com/index.php/TweenPosition" target="_blank">More info</a> |
TweenSize
(endSize: UDim2, easingDirection: EasingDirection = …, easingStyle: EasingStyle = …, time: float = …, override: bool = …, callback: Function = …) → bool
| Field | XML type | Value |
|---|
Name | string | TweenSize |
summary | string | Smoothly translates a GuiObject's current size to 'endSize'. The only required argument is 'endSize'. <a href="http://wiki.roblox.com/index.php/TweenSize" target="_blank">More info</a> |
TweenSizeAndPosition
(endSize: UDim2, endPosition: UDim2, easingDirection: EasingDirection = …, easingStyle: EasingStyle = …, time: float = …, override: bool = …, callback: Function = …) → bool
| Field | XML type | Value |
|---|
Name | string | TweenSizeAndPosition |
summary | string | Smoothly translates a GuiObject's current size to 'endSize', and also smoothly translates the GuiObject's current position to 'endPosition'. The only required arguments are 'endSize' and 'endPosition'. <a href="http://wiki.roblox.com/index.php/TweenSizeAndPosition" target="_blank">More info</a> |
Events
18DragBegin
(initialPosition: UDim2) → void
| Field | XML type | Value |
|---|
Name | string | DragBegin |
summary | string | Fired when a GuiObject with Draggable set to true starts to be dragged. 'InitialPosition' is a UDim2 value of the position of the GuiObject before any drag operation began. |
DragStopped
(x: int, y: int) → void
| Field | XML type | Value |
|---|
Name | string | DragStopped |
summary | string | Always fired after a DragBegin event, DragStopped is fired when the user releases the mouse button causing a drag operation on the GuiObject. Arguments 'x', and 'y' specify the top-left absolute position of the GuiObject when the event is fired. |
InputBegan
(input: Instance) → void
| Field | XML type | Value |
|---|
Name | string | InputBegan |
summary | string | Fired when a user begins interacting via a Human-Computer Interface device (Mouse button down, touch begin, keyboard button down, etc.). 'inputObject' is an InputObject, which contains useful data for querying user input. This event only fires locally. |
InputChanged
(input: Instance) → void
| Field | XML type | Value |
|---|
Name | string | InputChanged |
summary | string | Fired when a user changes interacting via a Human-Computer Interface device (Mouse move, touch move, mouse wheel, etc.). 'inputObject' is an InputObject, which contains useful data for querying user input. This event only fires locally. |
InputEnded
(input: Instance) → void
| Field | XML type | Value |
|---|
Name | string | InputEnded |
summary | string | Fired when a user stops interacting via a Human-Computer Interface device (Mouse button up, touch end, keyboard button up, etc.). 'inputObject' is an InputObject, which contains useful data for querying user input. This event only fires locally. |
MouseEnter
(x: int, y: int) → void
| Field | XML type | Value |
|---|
Name | string | MouseEnter |
summary | string | Fired when the mouse enters a GuiObject, as long as the GuiObject is active (see active property for more detail). Arguments 'x', and 'y' specify the absolute pixel position of the mouse. |
MouseLeave
(x: int, y: int) → void
| Field | XML type | Value |
|---|
Name | string | MouseLeave |
summary | string | Fired when the mouse leaves a GuiObject, as long as the GuiObject is active (see active property for more detail). Arguments 'x', and 'y' specify the absolute pixel position of the mouse. |
MouseMoved
(x: int, y: int) → void
| Field | XML type | Value |
|---|
Name | string | MouseMoved |
summary | string | Fired when the mouse is inside a GuiObject and moves, as long as the GuiObject is active (see active property for more detail). Arguments 'x', and 'y' specify the absolute pixel position of the mouse. |
MouseWheelBackward
(x: int, y: int) → void
| Field | XML type | Value |
|---|
Name | string | MouseWheelBackward |
MouseWheelForward
(x: int, y: int) → void
| Field | XML type | Value |
|---|
Name | string | MouseWheelForward |
SelectionGained
() → void
| Field | XML type | Value |
|---|
Name | string | SelectionGained |
SelectionLost
() → void
| Field | XML type | Value |
|---|
Name | string | SelectionLost |
TouchLongPress
(touchPositions: Array, state: UserInputState) → void
| Field | XML type | Value |
|---|
Name | string | TouchLongPress |
summary | string | Fired when a user holds at least one finger for a short amount of time on the same screen position on a TouchEnabled device. 'touchPositions' is a Lua array of Vector2, each indicating the position of all the fingers involved in the gesture. 'state' indicates the Enum.UserInputState of the gesture. This event only fires locally. |
TouchPan
(touchPositions: Array, totalTranslation: Vector2, velocity: Vector2, state: UserInputState) → void
| Field | XML type | Value |
|---|
Name | string | TouchPan |
summary | string | Fired when a user drags at least one finger on a TouchEnabled device. 'touchPositions' is a Lua array of Vector2, each indicating the position of all the fingers involved in the gesture. 'totalTranslation' is a Vector2, indicating how far the pan gesture has gone from its starting point. 'velocity' is a Vector2 that indicates how quickly the gesture is being performed in each dimension. 'state' indicates the Enum.UserInputState of the gesture. |
TouchPinch
(touchPositions: Array, scale: float, velocity: float, state: UserInputState) → void
| Field | XML type | Value |
|---|
Name | string | TouchPinch |
summary | string | Fired when a user pinches their fingers on a TouchEnabled device. 'touchPositions' is a Lua array of Vector2, each indicating the position of all the fingers involved in the pinch gesture. 'scale' is a float that indicates the difference from the beginning of the pinch gesture. 'velocity' is a float indicating how quickly the pinch gesture is happening. 'state' indicates the Enum.UserInputState of the gesture. This event only fires locally. |
TouchRotate
(touchPositions: Array, rotation: float, velocity: float, state: UserInputState) → void
| Field | XML type | Value |
|---|
Name | string | TouchRotate |
summary | string | Fired when a user rotates two fingers on a TouchEnabled device. 'touchPositions' is a Lua array of Vector2, each indicating the position of all the fingers involved in the gesture. 'rotation' is a float indicating how much the rotation has gone from the start of the gesture. 'velocity' is a float that indicates how quickly the gesture is being performed. 'state' indicates the Enum.UserInputState of the gesture. This event only fires locally. |
TouchSwipe
(swipeDirection: SwipeDirection, numberOfTouches: int) → void
| Field | XML type | Value |
|---|
Name | string | TouchSwipe |
summary | string | Fired when a user swipes their fingers on a TouchEnabled device. 'swipeDirection' is an Enum.SwipeDirection, indicating the direction the user swiped. 'numberOfTouches' is an int that indicates how many touches were involved with the gesture. This event only fires locally. |
TouchTap
(touchPositions: Array) → void
| Field | XML type | Value |
|---|
Name | string | TouchTap |
summary | string | Fired when a user taps their finger on a TouchEnabled device. 'touchPositions' is a Lua array of Vector2, each indicating the position of all the fingers involved in the tap gesture. This event only fires locally. This event will always fire regardless of game state. |