RBX.lua.SkateboardPlatform (Object)

Up one category:
Class reference

[▲] SkateboardPlatform Clone FindFirstChild GetChildren GetDebugId GetFullName IsA IsAncestorOf IsDescendantOf Destroy ClearAllChildren ApplySpecificImpulse BreakJoints GetMass MakeJoints Resize Name Parent Archivable ClassName RobloxLocked DataCost Anchored BrickColor CFrame CanCollide Controller ControllingHumanoid Elasticity Friction Locked Material Position Reflectance ResizeIncrement ResizeableFaces RotVelocity Shape Size Steer StickyWheels Throttle Transparency Velocity FormFactor AncestryChanged Changed ChildAdded ChildRemoved DescendantAdded DescendantRemoving Equipped Touched LocalSimulationTouched MoveStateChanged Unequipped

A SkateboardPlatform can be used to create a skateboard. When characters get on a skateboard, they are stuck to it until they press the escape key. Until then, the character uses skateboard animations and travels faster than a walking character.

Clone( )
Returns	Instance
Description:	Returns a clone of the object and its children, unless its Archivable property is false. The clone will have the same properties as the original object and the same descendants (except those with an Archivable property set to false). The clone's Parent will be nil.
Member of:	Instance

FindFirstChild( string name, bool recursive = false )
Returns	Instance
Description:	Returns the first child found with a name of name. Returns nil if no such child exists. If the optional recursive argument is true, will recursively descend the hierarchy while searching rather than only searching the immediate object.
Member of:	Instance

GetChildren( )
Returns	table
Description:	Returns a read-only table of the object's children.
Member of:	Instance

GetFullName( )
Returns	String path to object
Description:	Returns a string with a dot (.) character separating a path of object hierarchy excluding "game".
Member of:	Instance

IsA( string className )
Returns	bool
Description:	Returns true if the Instance is that class or a subclass.
Member of:	Instance

IsAncestorOf( Instance descendant )
Returns	boolean is ancestor
Description:	Returns true if the object is an ancestor of descendant.
Member of:	Instance

IsDescendantOf( Instance ancestor )
Returns	bool
Description:	Returns true if the object is an descendant of ancestor.
Member of:	Instance

Remove( )
Returns	nil
Description:	Sets the Parent property to nil and calls Remove() on all children.
Member of:	Instance

BreakJoints( )
Returns	nil
Description:	Breaks any surface connection with any adjacent part, including Welds and other JointInstances.
Member of:	BasePart, Model

GetMass( )
Returns	Number object mass
Description:	Returns the Number of the object's mass.
Member of:	BasePart

MakeJoints( )
Returns	nil
Description:	Creates a joint on any side of the object that has a surface ID that can make a joint.
Member of:	BasePart, Model

Resize( NormalId NormalId, Integer DeltaAmount )
Returns	nil
Description:	Changes the size of an object just like using the Studio resize tool. NormalId is a side, DeltaAmount is how much to grow/shrink on that side.
Member of:	BasePart

Name
Type	string
Description	The name of the object, which is often used to identify it in the context of its parent. Note that names are not unique identifiers; multiple children of an object may share the same name. In a script where you want to access an object using a name, for example, game.Workspace["Brick"], the first object found with that name is that object. This "first object" can be found in the Explorer menu.Names are great for showing a very brief title or summary of an object.
Member of	Instance

Parent
Type	Instance
Description	The hierarchical parent of the object. When no scripts hold references to an object, it will still be maintained as long as it's parent is set to an object which does have references to it, either by other objects or scripts. The toplevel DataModel object (the one referred to as the "game" by scripts) has no parent, but always has a reference held to it by the game engine, and exists for the duration of a session.
Member of	Instance

Archivable
Type	bool
Description	Sets whether or not the object is saved when publishing or saving to file. Also sets whether or not the object is clonable.
Member of	Instance

ClassName
Type	string
Description	A unique string per type of Instance. Should only be used as a unique identifier, as it does not reveal any information about nature of the type hierarchy the type is in. For this use, see IsA.
Member of	Instance

Anchored
Type	bool
Description	Sets whether or not the object is frozen in place.
Member of	BasePart

BrickColor
Property	BrickColor BrickColor
Description	Stores the color of the object.
Member of	BasePart

CFrame
Property	CFrame CFrame
Description	The current Position and rotation of an object.
Member of	BasePart, Pose

CanCollide
Property	Bool CanCollide
Description	If true, then the object will collide with other objects.
Member of	BasePart

Controller (Property)

Elasticity
Property	Number Elasticity
Description	Sets how much the object will rebound against another. a value of 1 is like a superball, and 0 is like a lead block.
Member of	BasePart

Friction
Property	Number Friction
Description	Sets how much friction the object has. A value of 1 is a no-slick grip, 0 is a waxy floor.
Member of	BasePart

Locked
Property	Bool Is Locked
Description	If True, the object will not be selectable.
Member of	BasePart

Material
Property	Meterial
Description	Sets the material that the object is made out of.
Member of	BasePart

When used in 3D objects, such as Parts and other items, this property is a Vector3.

Position
Property	Vector3 Position
Description	Stores the current location of the object in world coordinates.
Member of	BasePart, Explosion

Position
Property	UDim2 Position
Description	Sets the position of the GUI object in object coordinates.
Member of	GuiObject

Note, the lowercase property operates differently. Rather than setting the location of an object, the lowercase position property specifies a goal location for that object.

position
Property	Vector3 position
Description	Sets the goal position for the object.
Member of	BodyPosition

Reflectance
Property	Number Reflectance
Description	Sets how reflective the object is. A value of 1 is like chrome, a value of 0 is a concrete wall.
Member of	BasePart

ResizeIncrement
Property	Int Steps to resize by
Description	Sets the distance to resize by, using Resize.
Member of	BasePart

ResizeableFaces
Property	Faces Sides which can be resized
Description	Sets which sides can be resized using Resize
Member of	Seat, SpawnLocation

RotVelocity
Property	Vector3 RotVelocity
Description	Stores the rotational velocity of the object.
Member of	BasePart

Shape
Property	PartType PartType
Description	Sets the type of shape the object has.
Member of	Part

Up one category:
Properties

When used in 3D objects, this property is a Vector3 representing how big, on each side, an object is. Size Property Vector3 Size Description Sets the size of the object in object coordinates. Member of BasePart

When used in 2D GUI objects, this property is a UDim2 representing the size of an object. Size Property UDim2 Size Description Sets the size of the GUI object in object coordinates. Member of GuiObject

In the fire or smoke object, Size is an Int.

Size
Property	Int Size
Description	Sets the size of flames or smoke based on an integer.
Member of	Fire, Smoke

Steer
Property	Number Direction to turn
Description	The direction of movement, tied to the keys A and D. Must be one of 1 (right), 0 (straight), or -1 (left). Will refresh back to 0 unless constantly set.
Member of	VehicleSeat

Throttle
Property	Number Direction to accelerate
Description	The direction of movement, tied to the keys W and S. Must be an integer 1 (forward) 0 (null) or -1 (reverse). Will refresh back to 0 unless constantly set.
Member of	VehicleSeat

Transparency
Type	float
Description	Sets how see through an object is. 1 being totally see through and 0 being completely visible.
Member of	BasePart, Decal, GuiBase3d

Up one category:
Properties

There are two different Velocity properties:

Velocity
Type	Vector3
Description	Stores the speed and movement direction of the object.
Member of	BasePart

velocity
Type	Vector3
Description	Determines the constant directional force applied to the parent object.
Member of	BodyVelocity

FormFactor
Property	FormFactor FormFactor
Description	Sets how the object is resized.
Member of	FormFactorPart

AncestryChanged (Property)

AncestryChanged ( Instance child, Instance parent )
Description	Fired when an ancestor of the Instance the event which is a member of child has its parent changed to parent.
Member of:	Instance

Changed ( Property property )
Description	Fired whenever a property of the object changes.
Member of:	Instance

ChildAdded ( Instance child )
Description	Fired after a child is added.
Member of:	Instance

ChildRemoved ( Instance child )
Description	Fired when a child is removed from the object.
Member of:	Instance

DescendantAdded ( Instance descendant )
Description	Fired when a descendant is added to the object.
Member of:	Instance

DescendantRemoving ( Instance descendant )
Description	Fired when a descendant is being removed.
Member of:	Instance

Equipped ( Mouse mouse )
Description	Fired when tool is equipped.
Member of:	Tool

Equipped ( Instance humanoid, Instance skateboardController )
Description	Fired when a skateboard is equipped.
Member of:	SkateboardPlatform

Description

This event is triggered even a tool is equipped.

In a LocalScript:

Example

local function onEquipped(mouse)
  mouse.KeyDown:connect(onKeyDown)
  mouse.Button1Down.connect(function() onButton1Down(mouse) end)
end
tool.Equipped:connect(onEquipped)

Getting The Mouse Secretly

In one of your games you might want a player to have to click or press a key or something, but what if you don't want them to have to select a hopperbin or tool? One neat thing we can do with the tool is parent it into a player, and the equipped event will fire, giving us their mouse. Then we can do the clicking and pressing stuffs and delete the tool! Here's an example of a script that would get the mouse without them seeing anything:

Example

--This would go in the starterpack.
Player = script.Parent.Parent --Get the player.
Tool = Instance.new("Tool") --Create a tool.
Handle = Instance.new("Part",Tool) --Make a handle part so it will equip.
Handle.Name = "Handle" --Make sure it's called handle, or it won't work.
Tool.Equipped:connect(function(mouse) --When it's equipped fire a function.
    Tool.Parent = nil --Delete the tool so they don't see anything.
    mouse.KeyDown:connect(function(key) --When they press a key fire a function.
        print(key) --Print the key they pressed.
    end) --End the key function.
end) --End the equip function.
Tool.Parent = Player.Character --Parent it to the their character AFTER we have the equipped function ready so it will fire.

Now when the player presses a key it will print, and they didn't have to equip a tool or do anything!

Limitations

• Tool may equip before script add the connection, if both are added to Workspace on another machine.
• This event may not fire if the tool moves or removes before it reaches the right state.

Touched ( BasePart otherPart )
Description	Fired when another object comes in contact with this object.
Member of:	BasePart

LocalSimulationTouched ( Instance part )
Description	Fired when another part comes in contact with another object. This event only sends data to the client notifying it that two parts have collided, whereas Touched sends data to the server.
Member of:	BasePart

Unequipped ( )
Description	Fired whenever you unequipp the object.
Member of:	Tool, Flag, SkateboardPlatform