Class
JointsService
NotCreatableServiceDeprecated
A service that stores joints created by surface connections.
Deprecated. This service has been deprecated in favor of constraints which should be used for surface connections instead
The JointsService is a service that stores joints created by surface connections. It also has API available for visualizing surface to surface contact, and joining surfaces together.
Methods 5#
| ClearJoinAfterMoveJoints | Will remove any 'create joints' that were made visible via the
JointsService:ShowPermissibleJoints() method. |
| CreateJoinAfterMoveJoints | Updates all visible joints for the parts assigned by the
JointsService:SetJoinAfterMoveTarget() and
JointsService:SetJoinAfterMoveInstance() methods. |
| SetJoinAfterMoveInstance | Sets the PVInstance that will be connected with the target PVInstance
specified by JointsService:SetJoinAfterMoveTarget(). |
| SetJoinAfterMoveTarget | Sets the PVInstance that will be connected with the PVInstance specified
by JointsService:SetJoinAfterMoveInstance(). |
| ShowPermissibleJoints | When used it will visibly display a potential surface connection between
the two BasePart, which were set with
JointsService:SetJoinAfterMoveTarget() and
JointsService:SetJoinAfterMoveInstance(). |
ClearJoinAfterMoveJoints(): ()#
Will remove any 'create joints' that were made visible via the
JointsService:ShowPermissibleJoints() method.
Returns
()
CreateJoinAfterMoveJoints(): ()#
Updates all visible joints for the parts assigned by the
JointsService:SetJoinAfterMoveTarget() and
JointsService:SetJoinAfterMoveInstance() methods.
Returns
()
SetJoinAfterMoveInstance(joinInstance: Instance): ()#
Sets the PVInstance that will be connected with the target PVInstance
specified by JointsService:SetJoinAfterMoveTarget().
| Name | Type | Default | Description |
|---|---|---|---|
joinInstance | Instance | The PVInstance to be joined to the target set by
JointsService:SetJoinAfterMoveTarget(). |
Returns
()
SetJoinAfterMoveTarget(joinTarget: Instance): ()#
Sets the PVInstance that will be connected with the PVInstance specified
by JointsService:SetJoinAfterMoveInstance().
| Name | Type | Default | Description |
|---|---|---|---|
joinTarget | Instance | The PVInstance to serve as the connection target for the
instance set by JointsService:SetJoinAfterMoveInstance(). |
Returns
()
ShowPermissibleJoints(): ()#
When used it will visibly display a potential surface connection between
the two BasePart, which were set with
JointsService:SetJoinAfterMoveTarget() and
JointsService:SetJoinAfterMoveInstance().
Returns
()
Inherited members#
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild