mirror of
https://github.com/rojo-rbx/rojo.git
synced 2026-10-23 22:11:38 +00:00
rules
This commit is contained in:
Joe
parent
a9b4f8e83b
commit
e6efc04756
8494 changed files with 495610 additions and 0 deletions
212
.cursor/rules/roblox/reference/engine/classes/JointInstance.yaml
Normal file
212
.cursor/rules/roblox/reference/engine/classes/JointInstance.yaml
Normal file
|
|
@ -0,0 +1,212 @@
|
|||
# This file is automatically generated. Please don't edit it manually.
|
||||
# To submit a bug report on the content, see
|
||||
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
|
||||
|
||||
name: JointInstance
|
||||
type: class
|
||||
memory_category: BaseParts
|
||||
summary: |
|
||||
The base class for joints.
|
||||
description: |
|
||||
`JointInstance` is the base class for joints such as `Class.Weld|Welds` and
|
||||
`Class.Motor|Motors`.
|
||||
|
||||
`Class.Weld`, `Class.WeldConstraint`, `Class.Motor`, and `Class.Motor6D` all
|
||||
combine multiple parts into the same
|
||||
[assembly](../../../physics/assemblies.md). Every assembly has a root part
|
||||
(`Class.BasePart:GetRootPart()`) and when
|
||||
`Class.JointInstance.C0|C0`/`Class.JointInstance.C1|C1` of a
|
||||
`Class.JointInstance` is modified, the root part will stay where it was.
|
||||
|
||||
Welds do not have any directionality. You can imagine rigid joints forming a
|
||||
tree branching down from the root part. All the parts down the tree from root
|
||||
will move, and their welded "children" in this tree will move with them.
|
||||
code_samples: []
|
||||
inherits:
|
||||
- Instance
|
||||
descendants:
|
||||
- DynamicRotate
|
||||
- Glue
|
||||
- ManualSurfaceJointInstance
|
||||
- Motor
|
||||
- Rotate
|
||||
- Snap
|
||||
- VelocityMotor
|
||||
- Weld
|
||||
tags:
|
||||
- NotCreatable
|
||||
deprecation_message: ''
|
||||
properties:
|
||||
- name: JointInstance.Active
|
||||
summary: |
|
||||
Determines if the joint is currently active in the world.
|
||||
description: |
|
||||
This property determines if the joint is currently active in the world.
|
||||
|
||||
If the `Class.JointInstance` is not in `Class.Workspace` or
|
||||
`Class.JointsService`, or one of its parts is not in `Class.Workspace`,
|
||||
the joint will be inactive.
|
||||
|
||||
Rigid joints like `Class.Weld`, `Class.Snap`, `Class.WeldConstraint`,
|
||||
`Class.Motor`, or `Class.Motor6D` may also be disabled due to conflicts
|
||||
with other rigid joints, such as joints between the same two parts or
|
||||
indirect cycles in the weld graph. Joints disabled this way may be
|
||||
re-enabled later when another joint or part is added or removed.
|
||||
code_samples: []
|
||||
type: boolean
|
||||
tags:
|
||||
- ReadOnly
|
||||
- NotReplicated
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Behavior
|
||||
serialization:
|
||||
can_load: false
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Physics
|
||||
- name: JointInstance.C0
|
||||
summary: |
|
||||
Determines how the offset point is attached to
|
||||
`Class.JointInstance.Part0`.
|
||||
description: |
|
||||
`C0` is the position aspect of the orientation between two parts in a
|
||||
weld. `Class.JointInstance.Part0|Part0` and
|
||||
`Class.JointInstance.Part1|Part1` move accordingly to this value, which
|
||||
denotes their respective positions.
|
||||
|
||||
When animating a `Class.Motor6D`, it's recommended to tween its
|
||||
`Class.Motor6D.Transform|Transform` property instead of `C0`.
|
||||
code_samples: []
|
||||
type: CFrame
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Data
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Physics
|
||||
- name: JointInstance.C1
|
||||
summary: |
|
||||
Subtracted from the `Class.JointInstance.C0|C0` property to create an
|
||||
offset point for `Class.JointInstance.Part1|Part1`.
|
||||
description: |
|
||||
This property is subtracted from the `Class.JointInstance.C0|C0` property
|
||||
to create an offset point for `Class.JointInstance.Part1|Part1`.
|
||||
|
||||
When animating a `Class.Motor6D`, it's recommended to tween its
|
||||
`Class.Motor6D.Transform|Transform` property instead of `C1`.
|
||||
code_samples: []
|
||||
type: CFrame
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Data
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Physics
|
||||
- name: JointInstance.Enabled
|
||||
summary: |
|
||||
Sets whether the joint is active or not.
|
||||
description: |
|
||||
This property sets whether the joint is active or not.
|
||||
|
||||
When this property is set to `true` and the joint's
|
||||
`Class.JointInstance.Part0|Part0` and `Class.JointInstance.Part1|Part1`
|
||||
properties are set, the joint will ensure that its two parts will be
|
||||
connected and behave according to joint type.
|
||||
|
||||
See also `Class.JointInstance.Active|Active` which determines if the joint
|
||||
is currently active in the world.
|
||||
code_samples: []
|
||||
type: boolean
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Behavior
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Physics
|
||||
- name: JointInstance.Part0
|
||||
summary: |
|
||||
The first `Class.BasePart` that the joint connects.
|
||||
description: |
|
||||
This property indicates the first `Class.BasePart` that the joint
|
||||
connects.
|
||||
code_samples: []
|
||||
type: BasePart
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Data
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Physics
|
||||
- name: JointInstance.Part1
|
||||
summary: |
|
||||
The second `Class.BasePart` that the joint connects.
|
||||
description: |
|
||||
This property indicates the second `Class.BasePart` that the joint
|
||||
connects.
|
||||
code_samples: []
|
||||
type: BasePart
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Data
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Physics
|
||||
- name: JointInstance.part1
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: BasePart
|
||||
tags:
|
||||
- Hidden
|
||||
- NotReplicated
|
||||
- Deprecated
|
||||
deprecation_message: |
|
||||
This deprecated property is a variant of `Class.JointInstance.Part1|Part1`
|
||||
which should be used instead.
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Data
|
||||
serialization:
|
||||
can_load: false
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Physics
|
||||
methods: []
|
||||
events: []
|
||||
callbacks: []
|
||||
Loading…
Add table
Add a link
Reference in a new issue