JointsService
A service that stores joints created by surface connections.
| Memory category | Instances |
|---|
Member index 5
Description
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.
History 17
- 573 Change ReturnType of ShowPermissibleJoints from void to null
- 573 Change ReturnType of SetJoinAfterMoveTarget from void to null
- 573 Change ReturnType of SetJoinAfterMoveInstance from void to null
- 573 Change ReturnType of CreateJoinAfterMoveJoints from void to null
- 573 Change ReturnType of ClearJoinAfterMoveJoints from void to null
- 462 Change ThreadSafety of ShowPermissibleJoints from to Unsafe
- 462 Change ThreadSafety of SetJoinAfterMoveTarget from to Unsafe
- 462 Change ThreadSafety of SetJoinAfterMoveInstance from to Unsafe
- 462 Change ThreadSafety of CreateJoinAfterMoveJoints from to Unsafe
- 462 Change ThreadSafety of ClearJoinAfterMoveJoints from to Unsafe
- 379 Change Tags of JointsService from [NotCreatable, Service] to [NotCreatable, Service, Deprecated]
- 47 Add ShowPermissibleJoints
- 47 Add SetJoinAfterMoveTarget
- 47 Add SetJoinAfterMoveInstance
- 47 Add CreateJoinAfterMoveJoints
- 47 Add ClearJoinAfterMoveJoints
- 47 Add JointsService
Members 5
ClearJoinAfterMoveJoints
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| null | ||
Will remove any 'create joints' that were made visible via the JointsService:ShowPermissibleJoints() method.
| Thread safety | Unsafe |
|---|
History 3
- 573 Change ReturnType of ClearJoinAfterMoveJoints from void to null
- 462 Change ThreadSafety of ClearJoinAfterMoveJoints from to Unsafe
- 47 Add ClearJoinAfterMoveJoints
CreateJoinAfterMoveJoints
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| null | ||
Updates all visible joints for the parts assigned by the JointsService:SetJoinAfterMoveTarget() and JointsService:SetJoinAfterMoveInstance() methods.
| Thread safety | Unsafe |
|---|
History 3
- 573 Change ReturnType of CreateJoinAfterMoveJoints from void to null
- 462 Change ThreadSafety of CreateJoinAfterMoveJoints from to Unsafe
- 47 Add CreateJoinAfterMoveJoints
SetJoinAfterMoveInstance
| Parameters (1) | ||
|---|---|---|
| joinInstance | Instance | |
| Returns (1) | ||
| null | ||
Sets the PVInstance that will be connected with the target PVInstance specified by JointsService:SetJoinAfterMoveTarget().
| Thread safety | Unsafe |
|---|
History 3
- 573 Change ReturnType of SetJoinAfterMoveInstance from void to null
- 462 Change ThreadSafety of SetJoinAfterMoveInstance from to Unsafe
- 47 Add SetJoinAfterMoveInstance
SetJoinAfterMoveTarget
| Parameters (1) | ||
|---|---|---|
| joinTarget | Instance | |
| Returns (1) | ||
| null | ||
Sets the PVInstance that will be connected with the PVInstance specified by JointsService:SetJoinAfterMoveInstance().
| Thread safety | Unsafe |
|---|
History 3
- 573 Change ReturnType of SetJoinAfterMoveTarget from void to null
- 462 Change ThreadSafety of SetJoinAfterMoveTarget from to Unsafe
- 47 Add SetJoinAfterMoveTarget
ShowPermissibleJoints
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| null | ||
When used it will visibly display a potential surface connection between the two BasePart, which were set with JointsService:SetJoinAfterMoveTarget() and JointsService:SetJoinAfterMoveInstance().
| Thread safety | Unsafe |
|---|
History 3
- 573 Change ReturnType of ShowPermissibleJoints from void to null
- 462 Change ThreadSafety of ShowPermissibleJoints from to Unsafe
- 47 Add ShowPermissibleJoints