Inherits: <<<ROOT>>>
You can say something about Instance here. You can use any Markdown you want!
Determines whether or not an Instance can be saved when the game closes/attempts to save the game. Note: this only applies to games that use Data Persistence, or SavePlaceAsync.
No description available.
archivable is deprecated. Use Archivable instead.
Removes all children (but not this object) from the workspace.
Removes object and all of its children from the workspace. Disconnects object and all children from open connections. Object and children may not be usable after calling Destroy.
Returns the first ancestor of this Instance that matches the first argument 'name'. The function will return nil if no Instance is found.
Returns the first ancestor of this Instance with a ClassName equal to 'className'. The function will return nil if no Instance is found.
Returns the first ancestor of this Instance that :IsA(className). The function will return nil if no Instance is found.
Returns the first child of this Instance that matches the first argument 'name'. The second argument 'recursive' is an optional boolean (defaults to false) that will force the call to traverse down thru all of this Instance's descendants until it finds an object with a name that matches the 'name' argument. The function will return nil if no Instance is found.
Returns the first child of this Instance that with a ClassName equal to 'className'. The function will return nil if no Instance is found.
Returns the first child of this Instance that :IsA(className). The second argument 'recursive' is an optional boolean (defaults to false) that will force the call to traverse down thru all of this Instance's descendants until it finds an object with a name that matches the 'className' argument. The function will return nil if no Instance is found.
Returns a read-only table of this Object's children
This function is for internal testing. Don't use in production code
Returns an array containing all of the descendants of the instance. Returns in preorder traversal, or in other words, where the parents come before their children, depth first.
Returns a string that shows the path from the root node (DataModel) to this Instance. This string does not include the root node (DataModel).
No description available.
Returns a boolean if this Instance is of type 'className' or a is a subclass of type 'className'. If 'className' is not a valid class type in ROBLOX, this function will always return false. More info
No description available.
No description available.
Deprecated. Use ClearAllChildren() to get rid of all child objects, or Destroy() to invalidate this object and its descendants
No description available.
findFirstChild is deprecated. Use FindFirstChild instead.
getChildren is deprecated. Use GetChildren instead.
isDescendantOf is deprecated. Use IsDescendantOf instead.
Fired when any of this object's ancestors change. First argument 'child' is the object whose parent changed. Second argument 'parent' is the first argument's new parent.
Fired after a property changes value. The property argument is the name of the property
No description available.
No description available.
Fired after an Instance is parented to this object, or any of this object's descendants. The 'descendant' argument is the Instance that is being added.
Fired after an Instance is unparented from this object, or any of this object's descendants. The 'descendant' argument is the Instance that is being added.
childAdded is deprecated. Use ChildAdded instead.
Inherits: Instance
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
Inherits: Instance
Represents a linked animation object, containing keyframes and poses.
No description available.
Inherits: Instance
Allows animations to be played on joints of the parent object.
No description available.
No description available.
No description available.
Inherits: Instance
Returned by a call to LoadAnimation. Controls the playback of an animation on a Humanoid.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
Inherits: Instance
A service used to set and get information about assets stored on the Roblox website.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Given a creationID, this function will return the asset that created the creationID. If no other asset created the given creationID, 0 is returned.
No description available.
No description available.
Inherits: Instance
No description available.
Primary axis. Corresponds to the LookVector, or the first column in the part-local Attachment CFrame rotation matrix
Euler angles applied in YXZ order
Secondary axis. Corresponds to the UpVector, or the second column in the part-local Attachment CFrame rotation matrix
Primary axis in world space. Corresponds to the LookVector, or the first column in the world space Attachment CFrame rotation matrix.
No description available.
Euler angles applied in YXZ order
No description available.
Deprecated. Use WorldOrientation instead
No description available.
No description available.
No description available.
Inherits: BackpackItem
No description available.
No description available.
No description available.
No description available.
Inherits: BackpackItem
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Tool
No description available.
The Team this flag is for. Corresponds with the TeamColors in the Teams service.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: BasePlayerGui
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: BasePlayerGui
A container instance that syncs data between a single player and the server. ScreenGui objects that are placed in this container will be shown to the Player parent only
No description available.
No description available.
Overrides the default selection adornment (used for gamepads). For best results, this should point to a GuiObject.
No description available.
No description available.
No description available.
Inherits: BasePlayerGui
No description available.
No description available.
No description available.
No description available.
No description available.
Returns a boolean describing whether a CoreGuiType is currently being rendered.
No description available.
No description available.
Will stop/begin certain core gui elements being rendered. See CoreGuiType for core guis that can be modified.
No description available.
Inherits: Instance
Makes beam between two attachments
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
Allow events defined in one script to be subscribed to by another script
This event fires when the Fire() method is used. Receives the variable length arguments from Fire().
Inherits: Instance
Allow functions defined in one script to be called by another script
Inherits: BodyMover
No description available.
No description available.
No description available.
Inherits: BodyMover
When parented to a physical part, BodyForce will continually exert a force upon its parent object.
Inherits: BodyMover
Attempts to maintain a fixed orientation of its parent Part
The cframe that this force is trying to orient its parent Part to. Note: this force only uses the rotation of the cframe, not the position.
Inherits: BodyMover
No description available.
No description available.
No description available.
Inherits: BodyMover
No description available.
The amount of power we add to the system. The higher the power, the quicker the force will achieve its goal.
The velocity this system tries to achieve. How quickly the system reaches this velocity (if ever) is defined by P.
No description available.
Inherits: BodyMover
A propulsion system that mimics a rocket
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: CacheableContentProvider
No description available.
No description available.
Inherits: Instance
No description available.
The current position and rotation of the Camera. For most CameraTypes, the rotation is set such that the CoordinateFrame lookVector is pointing at the Focus.
Where the Camera's focus is. Any rotation of the camera will be about this subject.
Defines how the camera will behave. More info
The current position and rotation of the Camera. For most CameraTypes, the rotation is set such that the CoordinateFrame lookVector is pointing at the Focus.
The current angle, or width, of what the camera can see. Current acceptable values are from 20 degrees to 80.
The current CoordinateFrame that the camera is looking at. Note: it is not always guaranteed that the camera is always looking here.
No description available.
The negative z-offset of the view frustum's near clipping plane.
Holds the x,y screen resolution of the viewport the camera is presenting (note: this can differ from the AbsoluteSize property of a full screen gui).
No description available.
No description available.
No description available.
No description available.
Returns the camera's current roll. Roll is defined in radians, and is stored as the delta from the camera's y axis default normal vector.
No description available.
No description available.
Takes a 2D screen position and produces a Ray object to be used for 3D raycasting. Input is x,y screen coordinates, and a (optional, defaults to 0) z position which sets how far in the camera look vector to start the ray origin.
No description available.
Sets the camera's current roll. Roll is defined in radians, and is stored as the delta from the camera's y axis default normal vector.
Same as ScreenPointToRay, except no GUI offsets are taken into account. Useful for things like casting a ray from the middle of the Camera.ViewportSize
Takes a 3D position in the world and projects it onto x,y coordinates of screen space. Returns two values, first is a Vector3 that has x,y position and z position which is distance from camera (negative if behind camera, positive if in front). Second return value is a boolean indicating if the first argument is an on-screen coordinate.
Same as WorldToScreenPoint, except no GUI offsets are taken into account.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: CharacterAppearance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: CharacterAppearance
Modifies the appearance of a body part.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
Raises mouse events for parent object
No description available.
The maximum distance a Player's character can be from the ClickDetector's parent Part that will allow the Player's mouse to fire events on this object.
Fired when a player clicks on the parent Part of ClickDetector. The argument provided is always of type Player.
Fired when a player's mouse enters on the parent Part of ClickDetector. The argument provided is always of type Player.
Fired when a player's mouse leaves the parent Part of ClickDetector. The argument provided is always of type Player.
No description available.
mouseClick is deprecated. Use MouseClick instead.
Inherits: Instance
A service which provides collections of instances based on tags assigned to them.
Deprecated. Use GetTagged instead.
Returns a signal that fires when the given tag either has a new instance with that tag added to the data model or that tag is assigned to an instance within the data model.
Returns a signal that fires when the given tag either has an instance with that tag removed from the data model or that tag is removed from an instance within the data model.
Returns an array of all of the instances in the data model which have the given tag.
Returns a list of all the collections that an instance belongs to.
Deprecated. Use GetInstanceAddedSignal instead.
Deprecated. Use GetInstancedRemovedSignal instead.
Inherits: Instance
An object that can be placed under parts to hold Value objects that represent that part's configuration
Inherits: Instance
No description available.
No description available.
No description available.
The color of the in-game visual.
Toggles whether or not this constraint is enabled. Disabled constraints will not render in game.
Inherits: Constraint
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Constraint
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Constraint
No description available.
No description available.
No description available.
Inherits: Constraint
No description available.
Enables the angular limit between the axis of Attachment0 and the axis of Attachment1.
Restitution of the limit, or how elastic it is. Value in [0, 1].
Enables the angular limits around the main axis of Attachment1.
Lower angular limit around the axis of Attachment1. Value in [-180, 180].
Upper angular limit around the axis of Attachment1. Value in [-180, 180].
Maximum angle between the two main axes. Value in [0, 180].
Inherits: Constraint
No description available.
Type of the rotational actuator: None, Motor, or Servo.
Target angular speed. This value is unsigned as the servo will always move toward its target. Value in [0, inf).
The target angular velocity of the motor in radians per second around the rotation axis. Value in [0, inf).
Signed angle between the SecondaryAxis of Attchement0 and the SecondaryAxis of Attachment1 around the rotation axis. Value in [-180, 180].
Enables the angular limits on rotations around the main axis of Attachment0.
Lower limit for the angle from the SecondaryAxis of Attachment0 to the SecondaryAxis of Attachment1 around the rotation axis. Value in [-180, 180].
The maximum angular acceleration of the motor in radians per second square. Value in [0, inf).
The maximum torque the motor can apply to achieve the target angular velocity. Value in [0, inf).
No description available.
Maximum torque the servo motor can apply. Value in [0, inf).
Target angle for the SecondaryAxis of Attachment1 from the SecondaryAxis of Attachment0 around the rotation axis. Value in [-180, 180].
Upper limit for the angle from the SecondaryAxis of Attachment0 to the SecondaryAxis of Attachment1 around the rotation axis. Value in [-180, 180].
Inherits: Constraint
No description available.
No description available.
No description available.
No description available.
Inherits: Constraint
No description available.
Current distance between the two attachments. Value in [0, inf).
The length of the rope or the maximum distance between the two attachments. Value in [0, inf).
Restitution of the rope, or how elastic it is. Value in [0, 1].
Inherits: Constraint
No description available.
Type of linear actuator (along the axis of the slider): None, Motor, or Servo.
Current position of Attachment1 with respect to Attachment0 along the slider axis. Value in (-inf, inf).
Enables the limits on the linear motion along the axis of the slider.
Lower limit for the position of Attachment1 with respect to Attachment0 along the slider axis. Value in (-inf, inf).
The maximum acceleration of the motor in studs per second squared. Value in [0, inf).
The maximum force the motor can apply to achieve the target velocity. Units are mass * studs / seconds^2. Value in [0, inf).
Restitution of the two limits, or how elastic they are. Value in [0, 1].
Maximum force the servo motor can apply. Units are mass * studs / seconds^2. Value in [0, inf).
Target speed in studs per second. This value is unsigned as the servo will always move toward its target. Value in [0, inf).
Target position of Attachment1 with respect to Attachment0 along the slider axis. Value in (-inf, inf).
Upper limit for the position of Attachment1 with respect to Attachment0 along the slider axis. Value in (-inf, inf).
Inherits: SlidingBallConstraint
No description available.
Type of angular actuator: None, Motor, or Servo.
Enables the angular limits around the rotation axis.
Restitution of the two limits, or how elastic they are. Value in [0, 1].
Target angular speed. This value is unsigned as the servo will always move toward its target. In radians per second. Value in [0, inf).
The target angular velocity of the motor in radians per second around the rotation axis. Value in [0, inf).
Signed angle (in degrees) between the reference axis and the secondary axis of Attachment1 around the rotation axis. Value in [-180, 180].
Direction of the rotation axis as an angle from the x-axis in the xy-plane of Attachment0. Value in [-180, 180].
Lower limit for the angle (in degrees) between the reference axis and the SecondaryAxis of Attachment1 around the rotation axis. Value in [-180, 180].
The maximum angular acceleration of the motor in radians per second squared. Value in [0, inf).
The maximum torque the motor can apply to achieve the target angular velocity. The units are mass * studs^2 / second^2. Value in [0, inf).
Enable the visibility of the rotation axis.
Maximum torque the servo motor can apply. The units are mass * studs^2 / second^2. Value in [0, inf).
Target angle (in degrees) between the reference axis and the secondary axis of Attachment1 around the rotation axis. Value in [-180, 180].
Upper limit for the angle (in degrees) between the reference axis and the SecondaryAxis of Attachment1 around the rotation axis. Value in [-180, 180].
The unit vector direction of the rotation axis in world coordinates.
Inherits: Constraint
No description available.
Current distance between the two attachments. Value in [0, inf).
The damping parameter of the spring. The force is scaled with respect to relative velocity. The units of this property are force / velocity. Value in [0, inf).
The distance (in studs) between the two attachments at which the spring exerts no stiffness force. Value in [0, inf).
Enables limits on the length of the spring.
The maximum force that the spring can apply. Useful to prevent instabilities. The units are mass * studs / seconds^2. Value in [0, inf).
Maximum spring length, or the maxium distance between the two attachments. Value in [0, inf).
Minimum spring length, or the minimum distance between the two attachments. Value in [0, inf).
The stiffness parameter of the spring. Force is scaled based on distance from the free length. The units of this property are force / distance. Value in [0, inf).
Inherits: Constraint
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
A service used to bind input to various lua functions.
Binds 'functionToBind' to fire when any 'inputTypes' happen. InputTypes can be variable in number and type. Types can be Enum.KeyCode, single character strings corresponding to keys, or Enum.UserInputType. 'actionName' is a key used by many other ContextActionService functions to query state. 'createTouchButton' if true will create a button on screen on touch devices. This button will fire 'functionToBind' with three arguments: first argument is the actionName, second argument is the UserInputState of the input, and the third is the InputObject that fired this function. If 'functionToBind' yields or returns nil or Enum.ContextActionResult.Sink, the input will be sunk. If it returns Enum.ContextActionResult.Pass, the next bound action in the stack will be invoked.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Returns a table with all bound action info. Each entry is a key with 'actionName' and value being the same table you would get from ContextActionService:GetBoundActionInfo('actionName').
No description available.
Returns a table with info regarding the function bound with 'actionName'. Table has the keys 'title' (current title that was set with SetTitle) 'image' (image set with SetImage) 'description' (description set with SetDescription) 'inputTypes' (tuple containing all input bound for this 'actionName') 'createTouchButton' (whether or not we created a touch button for this 'actionName').
No description available.
No description available.
If 'actionName' key contains a bound action, then 'description' is set as the description of the bound action. This description will appear for users in a listing of current actions availables.
If 'actionName' key contains a bound action, then 'image' is set as the image of the touch button. Does nothing if a touch button was not created. No guarantees are made whether image will be set when button is manipulated.
If 'actionName' key contains a bound action, then 'position' is set as the position of the touch button. Does nothing if a touch button was not created. No guarantees are made whether position will be set when button is manipulated.
If 'actionName' key contains a bound action, then 'title' is set as the title of the touch button. Does nothing if a touch button was not created. No guarantees are made whether title will be set when button is manipulated.
If 'actionName' key contains a bound action, removes function from being called by all input that it was bound by (if function was also bound by a different action name as well, those bound input are still active). Will also remove any touch button created (if button was manipulated manually there is no guarantee it will be cleaned up).
No description available.
Removes all functions bound. No actionNames will remain. All touch buttons will be removed. If button was manipulated manually there is no guarantee it will be cleaned up.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
bindButton is deprecated. Use BindButton instead.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
Responsible for storing data across multiple user created places
No description available.
No description available.
Returns a data store with the given name and scope
Returns the default data store
Returns an ordered data store with the given name and scope
No description available.
Inherits: Instance
A service that provides utility in cleaning up objects
Adds an Instance into the debris service that will later be destroyed. Second argument 'lifetime' is optional and specifies how long (in seconds) to wait before destroying the item. If no time is specified then the item added will automatically be destroyed in 10 seconds.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
Inherits: Instance
An object used to make dialog trees to converse with players
Indicates how the dialog may be used by players. Use Enum.DialogBehaviorType.SinglePlayer if only one player should interact with the dialog at a time, otherwise use Enum.DialogBehaviorType.MultiplePlayers.
The maximum distance that the player's character can be from the dialog's parent in order to use the dialog.
Indicates whether or not an extra choice is available for the player to exit the dialog tree at this node.
The prompt text for an extra choice that allows the player to exit the dialog tree at this node.
The chat message that is displayed to the player when they first activate the dialog.
Describes the purpose of the dialog, which is used to display a relevant icon on the dialog's activation button.
Describes the tone of the dialog, which is used to display a relevant color in the dialog interface.
No description available.
No description available.
Returns an array of the players currently conversing with this dialog.
No description available.
No description available.
No description available.
Inherits: Instance
An object used to make dialog trees to converse with players
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
Creates an Explosion! This can be used as a purely graphical effect, or can be made to damage objects.
How much force this Explosion exerts on objects within it's BlastRadius. Setting this to 0 creates a purely graphical effect. A larger number will cause Parts to fly away at higher velocities.
How big the Explosion is. This is a circle starting from the center of the Explosion's Position, the larger this property the larger the circle of destruction.
No description available.
Defines the behavior of the Explosion. More info
No description available.
Inherits: FaceInstance
Descibes a texture that is placed on one of the sides of the Part it is parented to.
No description available.
How visible the decal is. 1 is completely invisible, while 0 is completely opaque
Inherits: Decal
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
Makes the parent part or model object emit fire
The color the fire interpolates to from Color. The longer a particle exists in the fire, the close to this color it becomes.
Inherits: Instance
Prevents joint breakage from explosions, and stops Humanoids from taking damage
Inherits: Instance
No description available.
No description available.
No description available.
Inherits: Instance
Deprecated. Use TestService instead
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
Exposes functions for saving and loading data for the DataStoreService
Sets callback as a function to be executed any time the value associated with key is changed. It is important to disconnect the connection when the subscription to the key is no longer needed.
Increments the value of a particular key amd returns the incremented value
No description available.
Sets the value of the key. This overwrites any existing data stored in the key
Retrieves the value of the key from the website, and updates it with a new value. The callback until the value fetched matches the value on the web. Returning nil means it will not save.
Inherits: GlobalDataStore
A type of DataStore where values must be positive integers. This makes OrderedDataStore suitable for leaderboard related scripting where you are required to order large amounts of data efficiently.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: GuiBase
No description available.
A read-only Vector2 value that is the GuiObject's current position (x,y) in pixel space, from the top left corner of the GuiObject.
No description available.
A read-only Vector2 value that is the GuiObject's current size (width, height) in pixel space.
No description available.
No description available.
Inherits: GuiBase2d
No description available.
If true, this GuiObject can fire mouse events and will pass them to any GuiObjects layered underneath, while false will do neither.
No description available.
Deprecated. Use BackgroundColor3 instead
A Color3 value that specifies the background color for the GuiObject. This value is ignored if the Style property (not found on all GuiObjects) is set to something besides custom.
A number value that specifies how transparent the background of the GuiObject is. This value is ignored if the Style property (not found on all GuiObjects) is set to something besides custom.
Deprecated. Use BorderColor3 instead
A Color3 value that specifies the color of the outline of the GuiObject. This value is ignored if the Style property (not found on all GuiObjects) is set to something besides custom.
A number value that specifies the thickness (in pixels) of the outline of the GuiObject. Currently this value can only be set to either 0 or 1, any other number has no effect. This value is ignored if the Style property (not found on all GuiObjects) is set to something besides custom.
If set to true, any descendants of this GuiObject will only render if contained within it's borders. If set to false, all descendants will render regardless of position.
If true, allows a GuiObject to be dragged by the user's mouse. The events 'DragBegin' and 'DragStopped' are fired when the appropriate action happens, and only will fire on Draggable=true GuiObjects.
No description available.
No description available.
No description available.
No description available.
No description available.
A UDim2 value describing the position of the top-left corner of the GuiObject on screen. More information on UDim2 is available here.
No description available.
Overrides the default selection adornment (used for gamepads). For best results, this should point to a GuiObject.
A UDim2 value describing the size of the GuiObject on screen in both absolute and relative coordinates. More information on UDim2 is available here.
The direction(s) that an object can be resized in. More info.
No description available.
Smoothly moves a GuiObject from its current position to 'endPosition'. The only required argument is 'endPosition'. More info
Smoothly translates a GuiObject's current size to 'endSize'. The only required argument is 'endSize'. More info
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'. More info
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.
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.
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.
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.
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.
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.
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.
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.
No description available.
No description available.
No description available.
No description available.
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.
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.
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.
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.
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.
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.
Inherits: GuiObject
A container object used to layout other GUI objects
Determines how a frame will look. Uses Enum.FrameStyle. More info
Inherits: GuiObject
A GUI button containing an Image
Determines whether a button changes color automatically when reacting to mouse events.
Allows the mouse to be free in first person mode. If a button with this property set to true is visible, the mouse is 'free' in first person mode.
Determines how a button will look, including mouse event states. Uses Enum.ButtonStyle. More info
No description available.
Fired when the mouse is over the button, and the mouse down and up events fire without the mouse leaving the button.
Fired when the mouse button is pushed down on a button.
Fired when the mouse button is released on a button.
This function currently does not work :(
This function currently does not work :(
This function currently does not work :(
Inherits: GuiButton
A GUI button containing an Image
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
If ScaleType is set to Slice, this Rect is used to specify the central part of the image. Everything outside of this is considered to be the border.
No description available.
Inherits: GuiButton
A GUI button containing text
No description available.
No description available.
No description available.
Deprecated. Use TextColor3 instead
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: GuiLabel
A GUI object containing an Image
No description available.
No description available.
No description available.
No description available.
If ScaleType is set to Slice, this Rect is used to specify the central part of the image. Everything outside of this is considered to be the border.
No description available.
Inherits: GuiLabel
A GUI object containing text
No description available.
No description available.
No description available.
Deprecated. Use TextColor3 instead
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: GuiObject
Studio.App.RobloxRibbonMainWindow.ScrollingFrameTooltip
The size in pixels of the frame, without the scrollbars.
The "Down" image on the vertical scrollbar. Size of this is always ScrollBarThickness by ScrollBarThickness. This is also used as the "right" image on the horizontal scroll bar.
The absolute position the scroll frame is in respect to the canvas size. The minimum this can be set to is (0,0), while the max is the absolute canvas size - AbsoluteWindowSize.
Determines the size of the area that is scrollable. The UDim2 is calculated using the parent gui's size, similar to the regular Size property on gui objects.
No description available.
No description available.
The "Middle" image on the vertical scrollbar. Size of this can vary in the y direction, but is always set at ScrollBarThickness in x direction. This is also used as the "mid" image on the horizontal scroll bar.
No description available.
No description available.
How thick the scroll bar appears. This applies to both the horizontal and vertical scroll bars. Can be set to 0 for no bars render.
No description available.
Determines whether or not scrolling is allowed on this frame. If turned off, no scroll bars will be rendered.
The "Up" image on the vertical scrollbar. Size of this is always ScrollBarThickness by ScrollBarThickness. This is also used as the "left" image on the horizontal scroll bar.
No description available.
No description available.
No description available.
Inherits: GuiObject
A text entry box
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Deprecated. Use TextColor3 instead
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: GuiObject
A GUI that can show 3D objects
Current Camera of children objects
The rendered image of the ViewportFrame will be mutiplied by this color
A number value that specifies how transparent the rendered image of the ViewportFrame is
Directional light color for objects in the ViewportFrame.
Light direction. Value will be normalized. All values valid except (0,0,0).
Inherits: GuiBase2d
The base class of ScreenGui, BillboardGui, and SurfaceGui.
No description available.
No description available.
Inherits: LayerCollector
A GUI that adorns an object in the 3D world. Add Frames/Labels/Buttons to this object to have them rendered while attached to a 3D object
If true, this GuiObject can fire mouse events and will pass them to any GuiObjects layered underneath, while false will do neither.
The Object the billboard gui uses as its base to render from. Currently, the only way to set this property is thru a script, and must exist in the workspace. This will only render if the object assigned derives from BasePart.
If true, billboard gui does not get occluded by 3D objects, but always renders on the screen.
No description available.
No description available.
No description available.
No description available.
No description available.
A Vector3 (x,y,z) defined in studs that will offset the gui from the extents of the 3d object it is rendering from.
No description available.
Specifies the amount of influence lighting has on the billboard gui. A value of 0 is unlit, 1 is fully lit. Fractional values blend from unlit to lit.
No description available.
Specifies a Player that the BillboardGui will not render to.
A UDim2 value describing the size of the BillboardGui. More information on UDim2 is available here. Relative values are defined as one-to-one with studs.
A Vector2 (x,y) defined in studs that will offset the gui size from it's current size.
A Vector3 (x,y,z) defined in studs that will offset the gui from the centroid of the 3d object it is rendering from
No description available.
Inherits: LayerCollector
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: LayerCollector
The core GUI object on which tools are built. Add Frames/Labels/Buttons to this object to have them rendered as a 2D overlay
No description available.
No description available.
No description available.
Inherits: LayerCollector
Renders its contained GuiObjects flat against the face of a part.
If true, this GuiObject can fire mouse events and will pass them to any GuiObjects layered underneath, while false will do neither.
The Object the surface gui uses as its base to render from. Currently, the only way to set this property is thru a script, and must exist in the workspace. This will only render if the object assigned derives from BasePart.
No description available.
No description available.
No description available.
Specifies the amount of influence lighting has on the surface gui. A value of 0 is unlit, 1 is fully lit. Fractional values blend from unlit to lit.
No description available.
No description available.
No description available.
Inherits: GuiBase
No description available.
No description available.
No description available.
Inherits: GuiBase3d
Renders a thin cylinder than can be adorned with textures that 'flow' from one object to the next. Has basic pathing abilities and attempts to to not intersect anything. More info
Controls how the decals are positioned along the wire. More info
The space between two textures on the wire. Note: studs are relative depending on how far the camera is from the FloorWire.
The image we use to render the textures that flow from beginning to end of the FloorWire.
The size in studs of the Texture we use to flow from one object to the next.
How thick the wire is.
Inherits: PVAdornment
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: PVAdornment
No description available.
No description available.
Inherits: PVAdornment
A 3D GUI object to represent the visible selection around an object
No description available.
No description available.
No description available.
No description available.
Inherits: PVAdornment
A 3D GUI object to represent the visible selection around an object
No description available.
No description available.
No description available.
Inherits: HandlesBase
A 3D GUI object to represent draggable arc handles
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: HandlesBase
A 3D GUI object to represent draggable handles
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: PartAdornment
A 3D GUI object to represent the visible selection around a face of an object
No description available.
Inherits: SelectionLasso
A visual line drawn representation between two part objects
Inherits: Instance
The GuiService is a special service, which currently allows developers to control what GuiObject is currently being selected by the Gamepad Gui navigator, and allows clients to check if Roblox's main menu is currently open. This service has a lot of hidden members, which are mainly used internally by Roblox's CoreScripts.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Returns a Tuple containing two Vector2 values representing the offset of user GUIs in pixels from the top right corner of the screen and the bottom right corner of the screen respectively.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
Enabling http requests from scripts
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
An emum that selects the collision type for R15 and Rthro characters. InnerBox is classic style collisions for all characters, OuterBox is dynamically sized collisions based on Mesh size.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Takes a specified tool and equips it to the Humanoid's Character. Tool argument should be of type 'Tool'.
No description available.
No description available.
Returns a Enum.BodyPartR15 given a body part in the Humanoid's Character.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Attempts to move the Humanoid and it's associated character to 'part'. 'location' is used as an offset from part's origin.
No description available.
No description available.
No description available.
Replaces the desired bodypart on the Humanoid's Character using a specified Enum.BodyPartR15 and BasePart. Returns a success boolean.
No description available.
No description available.
Decreases health by the amount. Use this instead of changing health directly to make sure weapons are filtered for things such as ForceField(s).
Takes any active gear/tools that the Humanoid is using and puts them into the backpack. This function only works on Humanoids with a corresponding Player.
loadAnimation is deprecated. Use LoadAnimation instead.
takeDamage is deprecated. Use TakeDamage instead.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
An object that specifies the appearance of Humanoid characters
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
An object that describes a particular user input, such as mouse movement, touches, keyboard, and more.
An enum that describes what kind of input is being pressed. For types of input like Keyboard, this describes what key was pressed. For input like mousebutton, this provides no additional information.
A Vector3 value that describes a positional value of this input. For mouse and touch input, this is the screen position of the mouse/touch, described in the x and y components. For mouse wheel input, the z component describes whether the wheel was moved forward or backward.
An enum that describes what state of a particular input (touch began, touch moved, touch ended, etc.). See Enum.UserInputState for more info.
An enum that describes what kind of input this object is describing (mousebutton, touch, etc.). See Enum.UserInputType for more info.
Inherits: Instance
A service used to insert objects stored on the website into the game.
Can be set in non-filtering-enabled places to allow LoadAsset to be used in LocalScripts.
Allows free models to be inserted into place.
Deprecated
Deprecated
Inserts the Instance into the workspace. It is recommended to use Instance.Parent = game.Workspace instead, as this can cause issues currently.
No description available.
No description available.
Deprecated. Use GetBaseSets() instead.
Returns a table containing a list of the various setIds that are ROBLOX approved. More info on sets
Returns a table for the assets stored in the category. A category is an setId from www.roblox.com that links to a set. More info on table format. More info on sets
No description available.
No description available.
No description available.
Deprecated. Use GetUserSets() instead.
Returns a table containing a list of the various setIds that correspond to argument 'userId'. More info on sets
Returns a Model containing the Instance that resides at AssetId on the web. This call will also yield the script until the model is returned. Script execution can still continue, however, if you use a coroutine.
Similar to LoadAsset, but instead an AssetVersionId is passed in, which refers to a particular version of the asset which is not neccessarily the latest version.
Inherits: Instance
No description available.
Read-only boolean, true if the joint is active in world. Rigid joints may be inactive if they are redundant or form cycles.
Inherits: JointInstance
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: JointInstance
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
One keyframe of an animation
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Light
Makes the parent part emit light in a frustum shape from rectangle defined by part
Inherits: Instance
Responsible for all lighting aspects of the world (affects how things are rendered).
The hue of the global lighting. Changing this changes the color tint of all objects in the Workspace.
How much global light each Part in the Workspace receives. Standard range is 0 to 2 (0 being little light), but can be increased all the way to 10 (colors start to be appear very different at this value).
The hue of global lighting on the bottom surfaces of an object.
The hue of global lighting on the top surfaces of an object.
Exposure compensation amount. Applies a bias to the exposure level prior to the tonemap step. +1 indicates twice as much exposure and -1 means half as much exposure.
The distance at which fog completely blocks your vision. This distance is relative to the camera position. Units are in studs
The distance at which the fog gradient begins. This distance is relative to the camera position. Units are in studs.
The latitude position the level is placed at. This affects sun position. More info
Flag enabling shadows from sun and moon in the place
No description available.
Effective ambient value for outdoors, effectively shadow color outdoors (requires GlobalShadows enabled)
Color the shadows appear as. Shadows are drawn mostly for characters, but depending on the lighting will also show for Parts in the Workspace. Rendering settings can also affect if shadows are drawn.
This property controls how blurry the shadows are.
No description available.
The number of minutes that the current time is past midnight. If currently at midnight, returns 0. Will return decimal values if not at an exact minute.
Returns the lookVector (Vector3) of the moon. If this lookVector was used in a CFrame, the Part would face the moon.
Currently always returns 0.75. MoonPhase cannot be edited.
Returns the lookVector (Vector3) of the sun. If this lookVector was used in a CFrame, the Part would face the sun.
Sets the time to be a certain number of minutes after midnight. This works with integer and decimal values.
getMinutesAfterMidnight is deprecated. Use GetMinutesAfterMidnight instead.
setMinutesAfterMidnight is deprecated. Use SetMinutesAfterMidnight instead.
Fired whenever a property of Lighting is changed, or a skybox is added or removed. Skyboxes are of type 'Sky' and should be parented directly to lighting.
Inherits: Instance
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
A database of strings used in the game and their translations.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
The name of the player who is currently editing the script in Team Create.
Inherits: Script
A script that runs on clients, NOT servers. LocalScripts can only run when parented under one of the following: 1) A player's Backpack. 2) A player's Character model. 3) A player's PlayerGui. 4) A player's PlayerScripts. 5) The ReplicatedFirst service.
Inherits: LuaSourceContainer
A script fragment. Only runs when another script uses require() on it.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Will prompt 'player' to purchase the item associated with 'assetId'. 'equipIfPurchased' is an optional argument that will give the item to the player immediately if they buy it (only applies to gear). 'currencyType' is also optional and will attempt to prompt the user with a specified currency if the product can be purchased with this currency, otherwise we use the default currency of the product.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Takes one argument "assetId" which should be a number of an asset on www.roblox.com. Returns a table containing the product information (if this process fails, returns an empty table).
No description available.
No description available.
Checks to see if 'Player' owns the product associated with 'assetId'. Returns true if the player owns it, false otherwise. This call will produce a warning if called on a guest player.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Fired when a 'player' dismisses a purchase dialog for 'assetId'. If the player purchased the item 'isPurchased' will be true, otherwise it will be false. This call will produce a warning if called on a guest player.
No description available.
No description available.
No description available.
Callback that is executed for pending Developer Product receipts.
If this function does not return Enum.ProductPurchaseDecision.PurchaseGranted, then you will not be granted the money for the purchase!
The callback will be invoked with a table, containing the following informational fields:
PlayerId - the id of the player making the purchase.
PlaceIdWherePurchased - the specific place where the purchase was made.
PurchaseId - a unique identifier for the purchase, should be used to prevent granting an item multiple times for one purchase.
ProductId - the id of the purchased product.
CurrencyType - the type of currency used (Tix, Robux).
CurrencySpent - the amount of currency spent on the product for this purchase.Inherits: Instance
No description available.
No description available.
No description available.
Inherits: Instance
Used to receive input from the user. Actually tracks mouse events and keyboard events.
The CoordinateFrame of where the Mouse ray is currently hitting a 3D object in the Workspace. If the mouse is not over any 3D objects in the Workspace, this property is nil.
The current Texture of the Mouse Icon. Stored as a string, for more information on how to format the string go here
The CoordinateFrame of where the Mouse is when the mouse is not clicking. This CoordinateFrame will be very close to the Camera.CoordinateFrame.
The Part the mouse is currently over. If the mouse is not currently over any object (on the skybox, for example) this property is nil.
A Part or Model that the Mouse will ignore when trying to find the Target, TargetSurface and Hit.
The NormalId (Top, Left, Down, etc.) of the face of the part the Mouse is currently over.
The absolute pixel position of the Mouse along the x-axis of the viewport (game window). Values start at 0 on the left hand side of the screen and increase to the right.
The absolute pixel position of the Mouse along the y-axis of the viewport (game window). Values start at 0 on the top of the screen and increase to the bottom.
Fired when the first button (usually the left, but could be another) on the mouse is depressed.
Fired when the first button (usually the left, but could be another) on the mouse is release.
This event is currently non-operational.
This event is currently non-operational.
Fired constantly when the mouse is not firing any other event (i.e. the mouse isn't moving, nor any buttons being pressed or depressed).
Fired when a user presses a key on the keyboard. Argument is a string representation of the key. If the key has no string representation (such as space), the string passed in is the keycode for that character. Keycodes are currently in ASCII.
Fired when a user releases a key on the keyboard. Argument is a string representation of the key. If the key has no string representation (such as space), the string passed in is the keycode for that character. Keycodes are currently in ASCII.
Fired when the mouse X or Y member changes.
This event is currently non-operational.
This event is currently non-operational.
keyDown is deprecated. Use KeyDown instead.
Inherits: NetworkPeer
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
Inherits: NetworkReplicator
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: PVInstance
A structural class, not creatable
Determines whether or not physics acts upon the Part. If true, part stays 'Anchored' in space, not moving regardless of any collision/forces acting upon it. If false, physics works normally on the part.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Contains information regarding the Part's position and a matrix that defines the Part's rotation. Can read/write. More info
Determines whether physical interactions with other Parts are respected. If true, will collide and react with physics to other Parts. If false, other parts will pass thru instead of colliding
Determines whether this Part casts a shadow.
No description available.
No description available.
No description available.
A float value ranging from 0.0f to 1.0f. Sets how much the Part will rebound against another. a value of 1 is like a superball, and 0 is like a lead block.
A float value ranging from 0.0f to 1.0f. Sets how much the Part will be able to slide. a value of 1 is no sliding, and 0 is no friction, so infinite sliding.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Determines whether building tools (in-game and studio) can manipulate this Part. If true, no editing allowed. If false, editing is allowed.
If true the part will be massless when welded to another part that is not massless. The part will still have mass like a normal part if it is an assembly root part according to GetRootPart().
Specifies the look and feel the Part should have. Note: this does not define the color the Part is, see BrickColor for that. More info
Rotation around X, Y, and Z axis. Rotations applied in YXZ order.
No description available.
Specifies how shiny the Part is. A value of 1 is completely reflective (chrome), while a value of 0 is no reflectance (concrete wall)
Sets the value for the smallest change in size allowable by the Resize(NormalId, int) function.
Sets the value for the faces allowed to be resized by the Resize(NormalId, int) function.
No description available.
No description available.
No description available.
No description available.
An integer from -127 to 127. Compares before other all other part properties besides massless for deciding which part is the assembly root part according to GetRootPart().
No description available.
No description available.
No description available.
No description available.
Sets how visible an object is. A value of 1 makes the object invisible, while a value of 0 makes the object opaque.
How fast the Part is traveling in studs/second. This property is NOT recommended to be modified directly, unless there is good reason. Otherwise, try using a BodyForce to move a Part.
brickColor is deprecated. Use BrickColor instead.
Destroys SurfaceJoints with all parts that are touching this Instance (including internal joints in the Instance, as in a Model).
No description available.
No description available.
No description available.
Returns a number that is the mass of this Instance. Mass of a Part is immutable, and is changed only by the size of the Part.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Creates the appropriate SurfaceJoints with all parts that are touching this Instance (including internal joints in the Instance, as in a Model). This uses the SurfaceTypes defined on the surfaces of parts to create the appropriate welds. More info
Resizes a Part in the direction of the face defined by 'NormalId', by the amount specified by 'deltaAmount'. If the operation will expand the part to intersect another Instance, the part will not resize at all. Return true if the call is successful, false otherwise.
No description available.
No description available.
breakJoints is deprecated. Use BreakJoints instead.
makeJoints is deprecated. Use MakeJoints instead.
No description available.
No description available.
Deprecated. Use Touched instead
No description available.
Deprecated. Use TouchEnded instead
Fired when the part stops touching another part
No description available.
touched is deprecated. Use Touched instead.
Inherits: BasePart
No description available.
No description available.
formFactor is deprecated. Use FormFactor instead.
Inherits: Part
No description available.
No description available.
No description available.
Inherits: Part
Equivalent to a seat, except that the character stands up rather than sits down.
Inherits: Part
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
equipped is deprecated. Use Equipped instead.
unequipped is deprecated. Use Unequipped instead.
Inherits: Part
No description available.
No description available.
No description available.
Inherits: BasePart
Object representing a high performance bounded grid of static 4x4 parts
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Returns hasAnyWater, WaterForce, WaterDirection
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: TriangleMeshPart
A MeshPart is a physically simulatable mesh
No description available.
Inherits: TriangleMeshPart
No description available.
No description available.
No description available.
No description available.
Inherits: BasePart
Automatically finds and powers hinge joints in an assembly. Ignores motors.
No description available.
No description available.
No description available.
No description available.
Inherits: PVInstance
A construct used to group Parts and other objects together, also allows manipulation of multiple objects.
A Part that serves as a reference for the Model's CFrame. Used in conjunction with GetModelPrimaryPartCFrame and SetModelPrimaryPartCFrame. Use this to rotate/translate all Parts relative to the PrimaryPart.
Breaks all surface joints contained within
No description available.
No description available.
Returns a CFrame that has position of the centroid of all Parts in the Model. The rotation matrix is either the rotation matrix of the user-defined PrimaryPart, or if not specified then a part in the Model chosen by the engine.
Returns a Vector3 that is union of the extents of all Parts in the model.
Returns the cframe of the Model.PrimaryPart. If PrimaryPart is nil, then this function will throw an error.
Creates the appropriate SurfaceJoints between all touching Parts contrained within the model. Technically, this function calls MakeJoints() on all Parts inside the model.
Moves the centroid of the Model to the specified location, respecting all relative distances between parts in the model.
Rotates all parts in the model to the orientation that was set using SetIdentityOrientation(). If this function has never been called, rotation is reset to GetModelCFrame()'s rotation.
Takes the current rotation matrix of the model and stores it as the model's identity matrix. The rotation is applied when ResetOrientationToIdentity() is called.
Sets the cframe of the Model.PrimaryPart. If PrimaryPart is nil, then this function will throw an error. This also sets the cframe of all descendant Parts relative to the cframe change to PrimaryPart.
Similar to MoveTo(), except instead of moving to an explicit location, we use the model's current CFrame location and offset it.
breakJoints is deprecated. Use BreakJoints instead.
makeJoints is deprecated. Use MakeJoints instead.
Inherits: Model
No description available.
No description available.
No description available.
No description available.
No description available.
Sets the height at which falling characters and parts are destroyed. This property is not scriptable and can only be set in Studio
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Return type is (BasePart, Vector3) if the ray hits. If it misses it will return (nil, PointAtEndOfRay)
Return type is (BasePart, Vector3) if the ray hits. If it misses it will return (nil, PointAtEndOfRay)
No description available.
Returns parts in the area defined by the Region3, up to specified maxCount or 100, whichever is less
Returns parts in the area defined by the Region3, up to specified maxCount or 100, whichever is less
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
findPartOnRay is deprecated. Use FindPartOnRay instead.
findPartsInRegion3 is deprecated. Use FindPartsInRegion3 instead.
Inherits: Instance
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
A generic particle system.
No description available.
No description available.
No description available.
No description available.
No description available.
Specifies the amount of influence lighting has on the particle emmitter. A value of 0 is unlit, 1 is fully lit. Fractional values blend from unlit to lit.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
An enum that describes how a Player's camera is allowed to behave. More info.
No description available.
No description available.
No description available.
No description available.
No description available.
Read-only. If true, this Player's persistent data can be loaded, false otherwise. Info on Data Persistence.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
loadBoolean is deprecated. Use LoadBoolean instead.
loadInstance is deprecated. Use LoadInstance instead.
loadNumber is deprecated. Use LoadNumber instead.
loadString is deprecated. Use LoadString instead.
saveBoolean is deprecated. Use SaveBoolean instead.
saveInstance is deprecated. Use SaveInstance instead.
saveNumber is deprecated. Use SaveNumber instead.
saveString is deprecated. Use SaveString instead.
No description available.
No description available.
No description available.
No description available.
No description available.
Loads in a new character for this player. This will replace the player's current character, if they have one. This should be used in conjunction with Players.CharacterAutoLoads to control spawning of characters. This function only works from a server-side script (NOT a LocalScript).
No description available.
No description available.
Yields until the persistent data for this Player is ready to be loaded. Info on Data Persistence.
isFriendsWith is deprecated. Use IsFriendsWith instead.
waitForDataReady is deprecated. Use WaitForDataReady instead.
No description available.
No description available.
No description available.
No description available.
No description available.
Fired periodically after the user has been AFK for a while. Currently this event is only fired for the local Player. "time" is the time in seconds that the user has been idle.
No description available.
No description available.
Inherits: Instance
A container instance that contains LocalScripts. LocalScript objects that are placed in this container will be exectue only when a Player is the parent.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
Set to true, when a player joins a game, they get a character automatically, as well as when they die. When set to false, characters do not auto load and will only load in using Player:LoadCharacter().
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
localPlayer is deprecated. Use LocalPlayer instead.
numPlayers is deprecated. Use NumPlayers instead.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
getPlayerFromCharacter is deprecated. Use GetPlayerFromCharacter instead.
getPlayers is deprecated. Use GetPlayers instead.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
Inherits: Instance
A service used to query and award points for Roblox users using the universal point system.
Returns the number of points the current universe can award to players. Works with server scripts ONLY.
Will attempt to award the 'amount' points to 'userId', returns 'userId' awarded to, the number of points awarded, the new point total the user has in the game, and the total number of points the user now has. Will also fire PointsService.PointsAwarded. Works with server scripts ONLY.
Returns the balance of points that player with userId has in the current game (all placeID points combined within the game). Works with server scripts ONLY.
Returns the overall balance of points that player with userId has (the sum of all points across all games). Works with server scripts ONLY.
Fired when points are successfully awarded 'userId'. Also returns the updated balance of points for usedId in universe via 'userBalanceInUniverse', total points via 'userTotalBalance', and the amount points that were awarded via 'pointsAwarded'. This event fires on the server and also all clients in the game that awarded the points.
Inherits: Instance
The pose of a joint relative to it's parent part in a keyframe
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: PostEffect
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: ReflectionMetadataItem
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
Allow events defined in one script to be subscribed to by another script across client/server boundary
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
Allow functions defined in one script to be called by another script across client/server boundary
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
dummy summary
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
A container whose contents are replicated to all clients (but not back to the server) first before anything else. Useful for creating loading guis, tutorials, etc.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
A container whose contents are replicated to all clients and the server.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
A container whose contents should be scripts. Scripts that are added to the container are run on the server.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
getService is deprecated. Use GetService instead.
No description available.
No description available.
No description available.
No description available.
Inherits: ServiceProvider
The root of ROBLOX's parent-child hierarchy (commonly known as game after the global variable used to access it)
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Returns true if the game has finished loading, false otherwise. Check this before listening to the Loaded signal to ensure a script knows when a game finishes loading.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Fires when the game finishes loading. Use this to know when to remove your custom loading gui. It is best to check IsLoaded() before connecting to this event, as the game may load before the event is connected to.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
The sound will play when it is removed from the Workspace. Looped sounds don't play
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: SoundEffect
A Chorus audio effect that can be applied to a Sound or SoundGroup.
Inherits: SoundEffect
A Compressor audio effect that can be applied to a Sound or SoundGroup.
Inherits: SoundEffect
A Distortion audio effect that can be applied to a Sound or SoundGroup.
Inherits: SoundEffect
An echo audio effect that can be applied to a Sound or SoundGroup.
Inherits: SoundEffect
An Three-band Equalizer audio effect that can be applied to a Sound or SoundGroup.
Inherits: SoundEffect
A Flanging audio effect that can be applied to a Sound or SoundGroup.
Inherits: SoundEffect
A Pitch Shifting audio effect that can be applied to a Sound or SoundGroup.
Inherits: SoundEffect
A Reverb audio effect that can be applied to a Sound or SoundGroup.
Inherits: SoundEffect
A Tremolo audio effect that can be applied to a Sound or SoundGroup.
Inherits: Instance
No description available.
The ambient sound environment. May not work when using hardware sound
the relative distance factor, compared to 1.0 meters.
The doppler scale is a general scaling factor for how much the pitch varies due to doppler shifting in 3D sound. Doppler is the pitch bending effect when a sound comes towards the listener or moves away from it, much like the effect you hear when a train goes past you with its horn sounding. With dopplerscale you can exaggerate or diminish the effect.
No description available.
Setting this value makes the sound drop off faster or slower. The higher the value, the faster volume will attenuate, and conversely the lower the value, the slower it will attenuate. For example a rolloff factor of 1 will simulate the real world, where as a value of 2 will make sounds attenuate 2 times quicker.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
A container instance that contains LocalScripts. LocalScript objects that are placed in this container will be copied to new Players on startup.
Inherits: StarterPlayerScripts
A container instance that contains LocalScripts. LocalScript objects that are placed in this container will be copied to new characters on startup.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
Inherits: Instance
A service for interfacing with the current studio state from Lua.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
The Team class is used to represent a faction in a team game. The only valid location for a Team object is under the Teams service. More info
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
This Service-level object is the container for all Team objects in a level. A map that supports team games must have a Teams service. More info
No description available.
Inherits: Instance
Allows players to seamlessly leave a game and join another
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
Object representing a snapshot of the region of terrain
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
Used by networking and replication code to transmit touch events - no other purpose
Inherits: Instance
Makes two attachments emit trail when moving
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
The current state of how the tween is animating. Possible values are Begin, Playing, Paused, Completed and Cancelled. This property is modified by using functions such as Tween:Play(), Tween:Pause(), and Tween:Cancel(). Read-only.
Stops the tween animation. Animation can be restarted by calling Play(). Animation will start from the beginning values.
Fires when the tween either reaches PlaybackState Completed or Cancelled. PlaybackState of one of these types is passed as the first arg to the function listening to this event.
Inherits: TweenBase
An object linked to an instance that animates properties on the instance over a specified period of time. Useful for easily moving UI objects around, rotating objects, etc. without having to write a lot of code. To create a new tween, please use TweenService:Create.
Inherits: Instance
Service responsible for creating tweens on instances.
No description available.
No description available.
Inherits: UIConstraint
Ensures a GuiObject will always have a particular aspect ratio. If an element with a constraint is under the control of a layout, the constraint takes precedence in determining the element’s size, but not position. You can use a Constraint by parenting it to the element you wish to constrain.
The aspect ratio to maintain. This is the width/height. Only positive numbers allowed.
Describes how the aspect ratio will determine its size. Options are FitWithinMaxSize, ScaleWithParentSize. FitWithinMaxSize will make the element the maximum size it can be within the current possible AbsoluteSize of the element while maintaining the AspectRatio. ScaleWithParentSize will make the element the closest to the parent element’s maximum size while maintaining aspect ratio.
Describes which axis to use when determining the new size of the element, while keeping respect to the aspect ratio.
Inherits: UIConstraint
Ensures a GuiObject does not become smaller or larger than the min and max size. If an element with a constraint is under the control of a layout, the constraint takes precedence in determining the element’s size, but not position. You can use a Constraint by parenting it to the element you wish to constrain.
Inherits: UIConstraint
Ensures a GuiObject with text does not allow the font size to become larger or smaller than min and max text sizes. If an element with a constraint is under the control of a layout, the constraint takes precedence in determining the element’s size, but not position. You can use a Constraint by parenting it to the element you wish to constrain.
The biggest size the font is allowed to be.
The smallest size the font is allowed to be.
Inherits: UILayout
No description available.
No description available.
Determines which direction to fill the grid. Can be Horizontal or Vertical.
Determines how grid is placed within it's parent's container in the x direction. Can be Left, Center, or Right.
Determines how we decide which element to place next. Can be Name or Custom. If using Custom, make sure SetCustomSortFunction was called with an appropriate sort function.
Determines how grid is placed within it's parent's container in the y direction. Can be Top, Center, or Bottom.
Forces a relayout of all elements. Useful when sort is set to Custom.
When SortOrder is set to Custom, this lua function is used to determine the ordering of elements. Function should take two arguments (each will be an Instance child to compare), and return true if a comes before b, otherwise return false. In other words, use this function the same way you would use a table.sort function. The sorting should be deterministic, otherwise sort will fail and fall back to name order.
Inherits: UIGridStyleLayout
Sets the position of UI elements in a 2D grid (this can be modified to 1D grid for list layout). This will also set the elements to a particular size, although this can be overridden with particular constraints on elements. You can use a UIGridLayout by parenting it to a GuiObject. The UIGridLayout will then apply itself to all of its GuiObject siblings.
How much space between elements there should be.
Denotes what size each element should be. Can be overridden by elements using constraints on individual elements.
Determines how many cells over in the FillDirection we go before starting a new row or column. Set to 0 for max cell count. Will be clamped if this is set higher than the parent container allows room for.
Which corner we start laying the elements out from. Can be TopLeft, TopRight, BottomLeft, BottomRight.
Inherits: UIGridStyleLayout
Sets the position of UI elements inline. You can use a UIInlineLayout by parenting it to a GuiObject. The UIListLayout will then apply itself to all of its GuiObject siblings.
No description available.
Inherits: UIGridStyleLayout
Sets the position of UI elements in a list. You can use a UIListLayout by parenting it to a GuiObject. The UIListLayout will then apply itself to all of its GuiObject siblings.
Inherits: UIGridStyleLayout
Creates a paged viewing window, like the home screen of a mobile device. You can use a UIPageLayout by parenting it to a GuiObject. The UIPageLayout will then apply itself to all of its GuiObject siblings.
The page that is either currently being displayed or is the target of the current animation.
The easing direction to use when performing an animation.
The easing style to use when performing an animation.
No description available.
Determines the amount that pages are separated from each other by. Can be set either using scale (Percentage of parent's size in the current direction) or offset (a static spacing value, similar to pixel size).
No description available.
No description available.
If the instance is in the layout, then it sets CurrentPage to it and animtes to it. If circular layout is set, it will take the shortest path.
If the index is >= 0 and less than the size of the layout, acts like JumpTo. If it's out of bounds and circular is set, it will animate the full distance between the in-bounds index of CurrentPage and the new index.
Sets CurrentPage to the page after the current page and animates to it, or does nothing if there isn't a next page.
Fires when a page comes into view, and is going to be rendered.
Fires when a page leaves view, and will not be rendered.
Fires when an animation to CurrentPage is completed without being cancelled, and the view stops scrolling.
Inherits: UIGridStyleLayout
Provides a layout of rows and columns that are sized based on the cells in them.
Whether the table should expand to fill the available space of its container, column-wise.
Whether the table should expand to fill the available space of its container, row-wise.
Whether the direct siblings are considered the rows or the columns. The children of the direct siblings are the columns or rows, respectively.
Inherits: UIComponent
No description available.
The padding to apply on the bottom side relative to the parent's normal size.
The padding to apply on the left side relative to the parent's normal size.
The padding to apply on the right side relative to the parent's normal size.
The padding to apply on the top side relative to the parent's normal size.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
Returns true if the local device has an accelerometer, false otherwise.
No description available.
No description available.
No description available.
Returns true if the local device has an gyroscope, false otherwise.
Returns true if the local device accepts keyboard input, false otherwise.
No description available.
No description available.
No description available.
No description available.
Returns true if the local device accepts mouse input, false otherwise.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Returns true if the local device accepts touch input, false otherwise.
No description available.
No description available.
No description available.
Returns an InputObject that describes the device's current acceleration. This is fired with an InputObject, which has type Enum.InputType.Accelerometer, and position that shows the g force in each local device axis. The delta property describes the amount of rotation that last happened. This event only fires locally.
Returns an InputObject that describes the device's current gravity vector. This is fired with an InputObject, which has type Enum.InputType.Accelerometer, and position that shows the g force in each local device axis. The delta property describes the amount of rotation that last happened. This event only fires locally.
Returns an InputObject and a Vector4 that describes the device's current rotation vector. This is fired with an InputObject, which has type Enum.InputType.Gyroscope, and position that shows total rotation in each local device axis. The delta property describes the amount of rotation that last happened. The Vector4 is the device's current quaternion rotation in reference to it's default reference frame. This event only fires locally.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Fired when a user moves a device that has an accelerometer. This is fired with an InputObject, which has type Enum.InputType.Accelerometer, and position that shows the g force in each local device axis. This event only fires locally.
Fired when the force of gravity changes on a device that has an accelerometer. This is fired with an InputObject, which has type Enum.InputType.Accelerometer, and position that shows the g force in each local device axis. This event only fires locally.
Fired when a user rotates a device that has an gyroscope. This is fired with an InputObject, which has type Enum.InputType.Gyroscope, and position that shows total rotation in each local device axis. The delta property describes the amount of rotation that last happened. A second argument of Vector4 is the device's current quaternion rotation in reference to it's default reference frame. This event only fires locally.
No description available.
No description available.
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. This event will always fire regardless of game state.
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. This event will always fire regardless of game state.
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. This event will always fire regardless of game state.
No description available.
No description available.
No description available.
Fired when a user stops text entry into a textbox (usually by pressing return or clicking/tapping somewhere else on the screen). Argument is the textbox that was taken out of focus. This event only fires locally.
Fired when a user clicks/taps on a textbox to begin text entry. Argument is the textbox that was put in focus. This also fires if a textbox forces focus on the user. This event only fires locally.
Fired when a user moves their finger on a TouchEnabled device. 'touch' is an InputObject, which contains useful data for querying user input. This event only fires locally. This event will always fire regardless of game state.
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. This event will always fire regardless of game state.
Fired when a user moves their finger on a TouchEnabled device. 'touch' is an InputObject, which contains useful data for querying user input. This event only fires locally. This event will always fire regardless of game state.
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. This event only fires locally. This event will always fire regardless of game state.
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. This event will always fire regardless of game state.
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. This event will always fire regardless of game state.
Fired when a user places their finger on a TouchEnabled device. 'touch' is an InputObject, which contains useful data for querying user input. This event only fires locally. This event will always fire regardless of game state.
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. This event will always fire regardless of game state.
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.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: ValueBase
Stores a boolean value in it's Value member. Useful to share boolean information across multiple scripts.
No description available.
changed is deprecated. Use Changed instead.
Inherits: ValueBase
Stores a BrickColor value in it's Value member. Useful to share BrickColor information across multiple scripts.
No description available.
No description available.
changed is deprecated. Use Changed instead.
Inherits: ValueBase
Stores a CFrame value in it's Value member. Useful to share CFrame information across multiple scripts.
No description available.
changed is deprecated. Use Changed instead.
Inherits: ValueBase
Stores a Color3 value in it's Value member. Useful to share Color3 information across multiple scripts.
No description available.
changed is deprecated. Use Changed instead.
Inherits: ValueBase
Stores a double value in it's Value member. Value is clamped to be in range of Min and MaxValue. Useful to share double information across multiple scripts.
No description available.
The maximum we allow this Value to be set. If Value is set higher than this, it automatically gets adjusted to MaxValue
The minimum we allow this Value to be set. If Value is set lower than this, it automatically gets adjusted to MinValue
No description available.
changed is deprecated. Use Changed instead.
Inherits: ValueBase
Stores an int value in it's Value member. Value is clamped to be in range of Min and MaxValue. Useful to share int information across multiple scripts.
No description available.
changed is deprecated. Use Changed instead.
Inherits: ValueBase
Stores a int value in it's Value member. Useful to share int information across multiple scripts.
No description available.
changed is deprecated. Use Changed instead.
Inherits: ValueBase
No description available.
No description available.
changed is deprecated. Use Changed instead.
Inherits: ValueBase
No description available.
No description available.
changed is deprecated. Use Changed instead.
Inherits: ValueBase
Stores a Ray value in it's Value member. Useful to share Ray information across multiple scripts.
No description available.
changed is deprecated. Use Changed instead.
Inherits: ValueBase
No description available.
No description available.
changed is deprecated. Use Changed instead.
Inherits: ValueBase
No description available.
No description available.
changed is deprecated. Use Changed instead.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Inherits: Instance
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.