Skip to content

Commit

Permalink
Fix variadic CFrame methods (#726)
Browse files Browse the repository at this point in the history
## Changes

These methods are not fully documented as being variadic.

I don't know how to correctly document a variadic return when all
returned values have known type, and didn't find examples, so I went
with Luau's type syntax `...CFrame`. Please tell me if this should
instead be `Variant` or something else.

## 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.

---------
  • Loading branch information
Ketasaja authored Jul 22, 2024
1 parent c5ba746 commit 0a19d67
Showing 1 changed file with 30 additions and 42 deletions.
72 changes: 30 additions & 42 deletions content/en-us/reference/engine/datatypes/CFrame.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -743,120 +743,108 @@ methods:
deprecation_message: ''
- name: CFrame:ToWorldSpace
summary: |
Returns one or more `Datatype.CFrame` objects transformed from object to
world space.
Receives one or more `Datatype.CFrame` objects and returns them transformed from object to world space.
description: |
Returns one or more `Datatype.CFrame` objects transformed from object to
world space. Equivalent to:
Receives one or more `Datatype.CFrame` objects and returns them transformed from object to world space. Equivalent to:
`CFrame * cf`
parameters:
- name: cf
type: CFrame
- name: ...
type: Tuple<CFrame>
default:
summary: ''
returns:
- type: CFrame
- type: Tuple<CFrame>
summary: ''
code_samples: []
tags: []
deprecation_message: ''
- name: CFrame:ToObjectSpace
summary: |
Returns one or more `Datatype.CFrame` objects transformed from world to
object space.
Receives one or more `Datatype.CFrame` objects and returns them transformed from world to object space.
description: |
Returns one or more `Datatype.CFrame` objects transformed from world to
object space. Equivalent to:
Receives one or more `Datatype.CFrame` objects and returns them transformed from world to object space. Equivalent to:
`CFrame:Inverse() * cf`
parameters:
- name: cf
type: CFrame
- name: ...
type: Tuple<CFrame>
default:
summary: ''
returns:
- type: CFrame
- type: Tuple<CFrame>
summary: ''
code_samples: []
tags: []
deprecation_message: ''
- name: CFrame:PointToWorldSpace
summary: |
Returns one or more `Datatype.Vector3` objects transformed from object to
world space.
Receives one or more `Datatype.Vector3` objects and returns them transformed from object to world space.
description: |
Returns one or more `Datatype.Vector3` objects transformed from object to
world space. Equivalent to:
Receives one or more `Datatype.Vector3` objects and returns them transformed from object to world space. Equivalent to:
`CFrame * v3`
parameters:
- name: v3
type: Vector3
- name: ...
type: Tuple<Vector3>
default:
summary: ''
returns:
- type: Vector3
- type: Tuple<Vector3>
summary: ''
code_samples: []
tags: []
deprecation_message: ''
- name: CFrame:PointToObjectSpace
summary: |
Returns one or more `Datatype.Vector3` objects transformed from world to
object space.
Receives one or more `Datatype.Vector3` objects and returns them transformed from world to object space.
description: |
Returns one or more `Datatype.Vector3` objects transformed from world to
object space. Equivalent to:
Receives one or more `Datatype.Vector3` objects and returns them transformed from world to object space. Equivalent to:
`CFrame:Inverse() * v3`
parameters:
- name: v3
type: Vector3
- name: ...
type: Tuple<Vector3>
default:
summary: ''
returns:
- type: Vector3
- type: Tuple<Vector3>
summary: ''
code_samples: []
tags: []
deprecation_message: ''
- name: CFrame:VectorToWorldSpace
summary: |
Returns one or more `Datatype.Vector3` objects rotated from object to
world space.
Receives one or more `Datatype.Vector3` objects and returns them rotated from object to world space.
description: |
Returns one or more `Datatype.Vector3` objects rotated from object to
world space. Equivalent to:
Receives one or more `Datatype.Vector3` objects and returns them rotated from object to world space. Equivalent to:
`(CFrame - CFrame.Position) * v3`
parameters:
- name: v3
type: Vector3
- name: ...
type: Tuple<Vector3>
default:
summary: ''
returns:
- type: Vector3
- type: Tuple<Vector3>
summary: ''
code_samples: []
tags: []
deprecation_message: ''
- name: CFrame:VectorToObjectSpace
summary: |
Returns one or more `Datatype.Vector3` objects rotated from world to
object space.
Receives one or more `Datatype.Vector3` objects and returns them rotated from world to object space.
description: |
Returns one or more `Datatype.Vector3` objects rotated from world to
object space. Equivalent to:
Receives one or more `Datatype.Vector3` objects and returns them rotated from world to object space. Equivalent to:
`(CFrame:Inverse() - CFrame:Inverse().Position) * v3`
parameters:
- name: v3
type: Vector3
- name: ...
type: Tuple<Vector3>
default:
summary: ''
returns:
- type: Vector3
- type: Tuple<Vector3>
summary: ''
code_samples: []
tags: []
Expand Down

0 comments on commit 0a19d67

Please sign in to comment.