PcoWSkbVqDnWTu_dm2ix
We use cookies on this site to enhance your user experience
I want to find out more Accept
Collapse Sidebar
  1. API REFERENCE
  2. SlidingBallConstraint

SlidingBallConstraint

Show deprecated
Hide content
CONTENT
  1. API REFERENCE
  2. SlidingBallConstraint

SlidingBallConstraint

Show deprecated

The base class for constraints that allow their attachments to slide along an axis.

Properties

ActuatorType

ActuatorType

Sets whether the translation of the PrismaticConstraint is actuated and, if so, what kind of actuation.
float

CurrentPosition

[ReadOnly] [NotReplicated]

The current offset between the SlidingBallConstraint’s Attachment.
bool

LimitsEnabled

Sets whether the SlidingBallConstraint will limit the range of translation.
float

LowerLimit

The lower position limit along the x-axis of Constraint/Attachment0 for a SlidingBallConstraint if SlidingBallConstraint/LimitsEnabled is true.
float

MotorMaxAcceleration

The maximum acceleration a SlidingBallConstraint with SlidingBallConstraint/ActuatorType set to Enum/ActuatorType can apply when trying to reach its desired SlidingBallConstraint/Velocity.
float

MotorMaxForce

The maximum force a SlidingBallConstraint with SlidingBallConstraint/ActuatorType set to Enum/ActuatorType can apply when trying to reach its desired SlidingBallConstraint/Velocity.
float

Restitution

How elastic Attachment connected by a SlidingBallConstraint will be when they reach the end of the range specified by SlidingBallConstraint/UpperLimit and SlidingBallConstraint/LowerLimit when SlidingBallConstraint/LimitsEnabled is set to true. Constrained between 0 and 1.
float

ServoMaxForce

The maximum force a SlidingBallConstraint with SlidingBallConstraint/ActuatorType set to Enum/ActuatorType can apply when trying to reach its desired SlidingBallConstraint/Speed.
float

Size

The visualized size of the SlidingBallConstraint.
float

Speed

The desired speed a SlidingBallConstraint with SlidingBallConstraint/ActuatorType set to Enum/ActuatorType will attempt to maintain while translating towards its SlidingBallConstraint/TargetPosition. Measured in studs/second.
float

TargetPosition

The target position a SlidingBallConstraint will attempt to translate to if its SlidingBallConstraint/ActuatorType is set to Enum/ActuatorType. Measured in studs.
float

UpperLimit

The upper position limit along the x-axis of Constraint/Attachment0 for a SlidingBallConstraint if SlidingBallConstraint/LimitsEnabled is true.
float

Velocity

The velocity a SlidingBallConstraint with SlidingBallConstraint/ActuatorType set to Enum/ActuatorType will attempt to achieve. Measured in studs/second.

Inherited from Constraint: Show Hide

bool

Active

[ReadOnly] [NotReplicated]

Indicates if the constraint is currently active in the world
bool

Visible

Toggles the visibility of this Constraint.
bool

Enabled

Toggles whether or not this Constraint is enabled.
BrickColor

Color

The color of the constraint.
Attachment

Attachment1

The Attachment that is connected to Constraint/Attachment0
Attachment

Attachment0

The Attachment that is connected to Constraint/Attachment1

Inherited from Instance: Show Hide

int

DataCost

[ReadOnly] [NotReplicated]

The cost of saving the instance using data persistence.
Instance

Parent

Determines the hierarchical parent of the Instance.
bool

RobloxLocked

If true, the Instance and its descendants cannot be indexed or edited by a Script or LocalScript and will throw an error if it is attempted.
string

ClassName

[ReadOnly] [NotReplicated]

A read-only string representing the class this Instance belongs to.
string

Name

A non-unique identifier of the Instance.
bool

Archivable

Determines if an Instance can be cloned using /Instance/Clone or saved to file.

Functions

Inherited from Instance: Show Hide

Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the Instance found with the given name.
Array

GetDescendants ( )

[CustomLuaState]

Returns an array containing all of the descendants of the instance
Objects

GetChildren ( )

Returns an array containing all of the Instance's children.
void

Destroy ( )

Sets the Instance/Parent property to nil, locks the Instance/Parent property, disconnects all connections and calls Destroy on all children.
RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.
string

GetFullName ( )

Returns a string describing the Instance's ancestry.
Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the Instance for whom Instance/IsA returns true for the given className.
bool

IsAncestorOf ( Instance descendant )

Returns true if an Instance is an ancestor of the given descendant.
bool

IsDescendantOf ( Instance ancestor )

Returns true if an Instance is a descendant of the given ancestor.
Instance

FindFirstChildOfClass ( string className )

Returns the first child of the Instance whose Instance/ClassName|ClassName is equal to the given className.
Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the Instance for whom Instance/IsA returns true for the given className.
Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the Instance whose Instance/ClassName is equal to the given className.
Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the Instance whose Instance/Name is equal to the given name.
bool

IsA ( string className )

Returns true if an Instance's class matches or inherits from a given class
Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]

Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does.
string

GetDebugId ( int scopeLength )

[NotBrowsable]

Returns a coded string of the Instances DebugId used internally by Roblox.
Instance

Clone ( )

Create a deep copy of a Roblox instance and descendants where Archivable = true.
void

ClearAllChildren ( )

This function destroys all of an Instance's children.

Events

Inherited from Instance: Show Hide

RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the Instance is removed.
RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the Instance/Parent property of the object or one of its ancestors is changed.
RBXScriptSignal

ChildAdded ( Instance child )

Fires when an object is parented to this Instance.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires when a child is removed from this Instance.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the Instance.
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.