Document RaycastParams, RaycastResult, and add a description to Raycast, GizmoRaycast, and IKMoveTo

Halalaluyafail3 · April 29, 2020, 4:29am

The developer hub currently doesn’t document RaycastParams and RaycastResult, and provides no description for WorldRoot:Raycast, StudioService:GizmoRaycast, and WorldRoot:IKMoveTo.

Some info

RaycastParams RaycastParams.new()
Creates a RaycastParams and returns it.
All the members of RaycastParams can be read from and written to.

bool RaycastParams.IgnoreWater
Whether the raycast should ignore water

Enum.RaycastFilterType RaycastParams.FilterType
What the FilterDescendantsInstances should do

Instances RaycastParams.FilterDescendantsInstances
A sequence of instances used in raycasting, behavior determined by RaycastParams.FilterType

RaycastResult can’t be created manually, instead it’s only the return value for WorldRoot:Raycast and StudioService:GizmoRaycast

Instance RaycastResult.Instance
The instance intersected

Vector3 RaycastResult.Position
The location of the intersection

Vector3 RaycastResult.Normal
The surface normal of the face intersected

Enum.Material RaycastResult.Material
The material of the face intersected

Both WorldRoot:Raycast and StudioService:GizmoRaycast will return nil if there was no intersection.

Maximum_ADHD · May 24, 2020, 9:58pm

Wew, more mismanagement!
There is official documentation present in Roblox’s auto-complete metadata file.

github.com

MaximumADHD/Roblox-Client-Tracker/blob/roblox/AutocompleteMetadata.xml#L2304-L2343


      
            <Properties>

              <number name="Envelope">Indicates the amount of variance allowed from the Value. A computed value.</number>

              <number name="Time">The relative time at which the keypoint is positioned.</number>

              <number name="Value">The base value of this keypoint.</number>

            </Properties>

          </ItemStruct>

          

          <ItemStruct name="Rect">

            <Function name="new" static="true">

              <returns>

                <Rect></Rect>

              </returns>

              <parameters>

                <Vector2 name="min"></Vector2>

                <Vector2 name="max"></Vector2>

              </parameters>

              <description>Constructs a new Rect with min as top left corner and max as bottom right corner.</description>

            </Function>

            <Function name="new" static="true">

              <returns>

This file has been truncated. show original

Ozzypig · May 27, 2020, 11:25pm

Hi guys, I’ve just published the RaycastParams, RaycastResult, and WorldRoot:Raycast pages. Should be visible ~~soon~~ now. The other two I’m waiting on engineer info. It’s taking a bit longer than expected.

Halalaluyafail3 · May 28, 2020, 12:41am

I noticed one thing in the documentation for RaycastResult; it states that the Instance property is a BasePart, but with GizmoRaycast it can be a Constraint or Attachment. Can this be fixed?