ViewportFrame Article & Documentation state outdated limitations

Lighting settings

Incorrect information

The “ViewportFrame GUI” Article, which can be found here, states in the “Notes / Performance” section at the bottom of the page that:

• Objects inside viewports will be rendered using a fixed lighting setting [...]

The ViewportFrame documentation, which can be found here, states in the “Caveats” section near the top of the page that:

• Objects inside viewport frames are rendered using a fixed Lighting setting.

Correct information

As of release 384, ViewportFrames have had Ambient, LightColor, and LightDirection properties which do, in fact, offer control over lighting settings.


LayerCollector behavior

Incorrect information

The ViewportFrame documentation, linked above, states in the “Caveats” section that:

• Currently, 3D objects can only be displayed in ScreenGuis or PluginGuis.

Correct information

3D objects (in ViewportFrames) can in fact be displayed inside all LayerCollectors, which is to say that they can be displayed inside SurfaceGuis and BillboardGuis too. The real caveat here is that they must be a descendant of a PlayerGui, and they should have their Adornee set (reference).

7 Likes

Thank you for the detailed correction – this should be visible soon :slight_smile:

1 Like

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