Skip to content

Commit 0b56613

Browse files
Update RaycastResult.yaml (#1015)
## Changes <!-- Please summarize your changes. --> Changed the references from "instance" to BasePart. Referring to the type of the intersected object as "instance" is too generic and may be confusing, since Models and Folders are also instances that some intersected object could have been a child of, but raycasts can only return a reference to the object in of itself and never the parent model. The (poorly named) _instance_ property of RaycastResult can only ever hold a basepart or a terrain cell, and terrain descends from basepart so basepart is accurate and more specific than instance. <!-- Please link to any applicable information (forum posts, bug reports, etc.). --> ## Checks By submitting your pull request for review, you agree to the following: - [x ] This contribution was created in whole or in part by me, and I have the right to submit it under the terms of this repository's open source licenses. - [x ] I understand and agree that this contribution and a record of it are public, maintained indefinitely, and may be redistributed under the terms of this repository's open source licenses. - [x ] To the best of my knowledge, all proposed changes are accurate. ---------
1 parent 5d4e7ea commit 0b56613

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

content/en-us/reference/engine/datatypes/RaycastResult.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ properties:
2525
tags: []
2626
deprecation_message: ''
2727
- name: RaycastResult.Instance
28-
type: Instance
28+
type: BasePart
2929
summary: |
3030
The `Class.BasePart` or `Class.Terrain` cell that the ray intersected.
3131
description: |
@@ -47,10 +47,10 @@ properties:
4747
- name: RaycastResult.Position
4848
type: Vector3
4949
summary: |
50-
The position of the intersection between the ray and the part.
50+
The world space point at which the intersection occurred.
5151
description: |
5252
The world space point at which the intersection occurred, usually a point
53-
directly on the surface of the instance.
53+
directly on the surface of the `Class.BasePart` or `Class.Terrain` cell.
5454
code_samples: []
5555
tags: []
5656
deprecation_message: ''

0 commit comments

Comments
 (0)