Incorrect type information for Blockcast, Spherecast, and Shapecast methods

Daw588 · November 29, 2023, 6:34pm

The type information for Blockcast, Spherecast, and Shapecast methods are incorrect; they are suppose to return RaycastResult?, just like the Raycast method, but they claim to return RaycastResult.

This can lead to bugs in developers’ code due to the lack of acknowledgment that the methods may return nil.

subcritical · January 22, 2024, 8:13pm

I don’t think raycast is special here - in Studio it’s always non-optional RaycastResult. Do you have some custom tooling with special types?

Either way, we’ll change these all to RaycastResult?.

Daw588 · January 22, 2024, 8:17pm

I’m using Luau LSP by JohnnyMorganz, which uses the official Luau type checker, the same one that Roblox Studio uses. As for the Roblox types, I believe they come from the Roblox API dump.

subcritical · January 22, 2024, 8:29pm

This seems to be an issue with luau-lsp - They have the wrong types for shapecast etc. Feel free to file an issue for that project.

github.com

JohnnyMorganz/luau-lsp/blob/main/scripts/globalTypes.d.lua#L8307


      
          declare class WorldRoot extends Model
          	function ArePartsTouchingOthers(self, partList: { BasePart }, overlapIgnored: number?): boolean
          	function Blockcast(self, cframe: CFrame, size: Vector3, direction: Vector3, params: RaycastParams?): RaycastResult
          	function BulkMoveTo(self, partList: { BasePart }, cframeList: { CFrame }, eventMode: EnumBulkMoveMode?): nil
          	function CacheCurrentTerrain(self, id: string, center: Vector3, radius: number): string
          	function ClearCachedTerrain(self, id: string): boolean
          	function GetPartBoundsInBox(self, cframe: CFrame, size: Vector3, overlapParams: OverlapParams?): { BasePart }
          	function GetPartBoundsInRadius(self, position: Vector3, radius: number, overlapParams: OverlapParams?): { BasePart }
          	function GetPartsInPart(self, part: BasePart, overlapParams: OverlapParams?): { BasePart }
          	function IKMoveTo(self, part: BasePart, target: CFrame, translateStiffness: number?, rotateStiffness: number?, collisionsMode: EnumIKCollisionsMode?): nil
          	function Raycast(self, origin: Vector3, direction: Vector3, raycastParams: RaycastParams?): RaycastResult?
          	function RaycastCachedTerrain(self, id: string, origin: Vector3, direction: Vector3, ignoreWater: boolean): RaycastResult
          	function SetInsertPoint(self, point: Vector3, ignoreGrid: boolean?): nil
          	function Shapecast(self, part: BasePart, direction: Vector3, params: RaycastParams?): RaycastResult
          	function Spherecast(self, position: Vector3, radius: number, direction: Vector3, params: RaycastParams?): RaycastResult
          end
          
          
declare class Workspace extends WorldRoot
          	AirDensity: number
          	AllowThirdPartySales: boolean
          	AvatarUnificationMode: EnumAvatarUnificationMode

We’ll fix this in the Studio property dump and autocomplete, but that won’t help folks who are using this project until they update.

UnFusion2 · July 11, 2024, 11:05pm

This was a problem with the third-party luau-lsp, which has since fixed the issue. Any future discussion about their solution should be reported in their Github issues. Thanks!

system · July 25, 2024, 11:05pm

This topic was automatically closed 14 days after the last reply. New replies are no longer allowed.