oneVR / VRWorldToolkit

Unity Editor extension for making VRChat worlds
MIT License
414 stars 19 forks source link

Updated Layer Warnings for the VRC Mirror Reflection Script (CustomMirrorEditor.cs) #24

Closed BluWizard10 closed 1 year ago

BluWizard10 commented 1 year ago

Based on my research, it has come to my attention that one of the Layer Warnings are somewhat inaccurate as of late. I have made changes to reflect this.

Most notably, VRChat has moved all of it's HUD, Main Menu, and Tooltips to a different Layer a long time ago. Since VRChat v2021.4.2 (Build 1156), they moved these UI elements to reserved2 in order to make it completely immune to Post Processing Volumes and other effects. And since it is still known that performance can be degraded if it's UI elements are reflected in the Mirror, I added a warning when the reserved2 Layer is enabled, advising users to refrain from using it.

Since the UiMenu is still used for Nameplates, I modified the warning for this Layer as well to reflect this.

Lastly, I've also modified the warning against Mirrors with it's Reflect Layers set to Everything as a safety procedure. It warns that performance may be heavily degraded if all Reflect Layers are enabled at the same time. I did this because the VRCMirror.prefab in the SDK Examples still has Everything set by default (and the old warning doesn't work anymore for some reason).

I've also added some other Warnings and Tooltips that I think are relevant. See the Changelog below for more info.

Changelog: