Please add detailed documentation and sample images about the difference between studs, size and extents offset properties

The API reference page on BillboardGui for StudsOffset(WorldSpace) and ExtentsOffset(WorldSpace) is very vague and unclear, even up to reusing the same wording to further obscure the difference between these properties. SizeOffset is also contributing to this. There are five offset properties and the difference is massively unclear other than making best case assumptions on their use.

All pages:
https://developer.roblox.com/en-us/api-reference/property/BillboardGui/ExtentsOffset
https://developer.roblox.com/en-us/api-reference/property/BillboardGui/ExtentsOffsetWorldSpace
https://developer.roblox.com/en-us/api-reference/property/BillboardGui/SizeOffset
https://developer.roblox.com/en-us/api-reference/property/BillboardGui/StudsOffset
https://developer.roblox.com/en-us/api-reference/property/BillboardGui/StudsOffsetWorldSpace

It would be very helpful to explain the difference between these two, or show how their differences may highlight in gameplay. Knowing which one is best to use for certain scenarios would improve the UI development experience greatly.

10 Likes

Hey @colbert2677! Thank you very much for reporting this. I’ve added it to the documentation todo list, and we’ll get to it in due time.

Appreciated!

5 Likes