Code sample and return list for GetPlayerPlaceInstanceAsync are broken

[buildthomas]

For the page:
https://developer.roblox.com/en-us/api-reference/function/TeleportService/GetPlayerPlaceInstanceAsync

(..)
		local success, errorMessage, placeId, jobId = pcall(function()
			return TeleportService:GetPlayerPlaceInstanceAsync(followId)
		end)
(..)

This code shouldn’t work I believe, and the parameter list is missing a value. This API returns 4 values outside of a pcall, and should return 5 with a pcall around it (due to the extra bool from the pcall).

Please refer to this post for more info:

GetPlayerPlaceInstanceAsync still doesn't work correctly

unknownValue there would be the error message. This is the old description for the returned parameters, from the old wiki: succeeded - true if the player was found errorMsg - the error message if anything went wrong with the lookup placeId - the id of the place the player is active in instanceId - the id of the instance of the player’s place That’s without a pcall – with a pcall, you would naturally add another bool in front of it when catching the return value. This API is weird in that it …

Here’s code from a 2+ year old game of mine which works as expected:

...
local success, _, _, placeId, jobId = pcall(function()
	return TeleportService:GetPlayerPlaceInstanceAsync(userId)
end)
if success and placeId then
   ...

The return list and code sample should be amended to use all 5 return values outside of the pcall.

[buildthomas]

Side-note: I think Developer Hub editors should probably have some sort of manual/automated testing step for the code samples they write, this prevents editing issues like this (which are easily made with quirky API signatures like this, I had to do a double-take here myself to see the issue).