Search Unity

[PostProcessScene] is under-documented and references deprecated methods

Discussion in 'Documentation' started by Baste, Oct 13, 2016.

  1. Baste

    Baste

    Joined:
    Jan 24, 2013
    Posts:
    6,338
    [PostProcessScene]'s docs reference specifices that it's called "Application.LoadLevel or Application.LoadLevelAdditive is called". Those methods are deprecated, and the method should be updated to reflect that.

    The old documentation also glosses over that the method won't be called when a scene is loaded in a build. The user can deduct that from the fact that the attribute is a UnityEditor attribute and thus won't be included, but it should be spelled out.

    Really, the documentation about the loading stuff is backwards. What you want to convey is that this is a script to change what's in your scene after the game builds, and that it also runs when you load in the editor to be able to see what the build result will be. If the wording captures the intention of the attribute, it's a lot easier to undestand exactly what it does.
     
  2. Graham-Dunnett

    Graham-Dunnett

    Administrator

    Joined:
    Jun 2, 2009
    Posts:
    4,287
    Hey Baste, yes, you are 100% right. I'll get this added into the docs list of items.