Search Unity

  1. Click here to see what's on sale for the "Best of Super Sale" on the Asset Store
    Dismiss Notice
  2. Good news ✨ We have more Unite Now videos available for you to watch on-demand! Come check them out and ask our experts any questions!
    Dismiss Notice

Looking for documentation UnityEditorInternal

Discussion in 'Scripting' started by Ali_Akbar_Montazeri, Jan 11, 2017.

  1. Ali_Akbar_Montazeri

    Ali_Akbar_Montazeri

    Joined:
    Dec 6, 2014
    Posts:
    189
    Hi, I have no idea why unity didn't make documentation for UnityEditorInternal.

    I'm looking for the documentation for UnityEditorInternal. Thanks
     
  2. Kiwasi

    Kiwasi

    Joined:
    Dec 5, 2013
    Posts:
    16,749
    As I understand it developers aren't supposed to use UnityEditorInternal. It will be documented, but only internally for use by Unity staff.

    Use at your own risk, there is no guareentee it won't change randomly on an update.
     
  3. TonyLi

    TonyLi

    Joined:
    Apr 10, 2012
    Posts:
    10,839
    Kiwasi likes this.
  4. Ali_Akbar_Montazeri

    Ali_Akbar_Montazeri

    Joined:
    Dec 6, 2014
    Posts:
    189
    Thanks for your answer guys.
     
  5. mgear

    mgear

    Joined:
    Aug 3, 2010
    Posts:
    6,315
    Last edited: Mar 24, 2018
  6. Ali_Akbar_Montazeri

    Ali_Akbar_Montazeri

    Joined:
    Dec 6, 2014
    Posts:
    189
    Wow ! Precious treasure ! :O
     
  7. Deleted User

    Deleted User

    Guest

    I actually don't know why there is not documentation on everything developers "CAN" use? No offense, but I just found out that it IS possible to alter the order of VR SDKs via code, which I needed for my build pipeline, but instead of documenting this I had to use google to find someone who found the API for it. This is one of a number of unnecessary hurdles.
    Please be more "you're good developers and know what you're doing, we give you guns" instead of "here's your rubber mallet, but be careful with it"
     
  8. palex-nx

    palex-nx

    Joined:
    Jul 23, 2018
    Posts:
    1,737
    Writing good documentations is about as hard as writing the good API. Having documented everything like in MSDN or man pages would double unity pro subscription price, that's why )
     
    DonLoquacious likes this.
  9. TonyLi

    TonyLi

    Joined:
    Apr 10, 2012
    Posts:
    10,839
    A public API is like a promise that the API will stay more or less stable. I think the idea behind the internal stuff is that it's not for public use, and it's not guaranteed to remain the same between versions. Since it's internal, Unity has no obligation to support it.

    That said, there are some things that everyone uses anyway, such as ReorderableList, that would cause major issues if Unity were to remove it or change it.
     
  10. DonLoquacious

    DonLoquacious

    Joined:
    Feb 24, 2013
    Posts:
    1,667
    I'm not even sure doubling the price would be effective. Since each piece of documentation can be viewed as a promise for consistent behaviour, as much as information to the developers using it, you can't really half-ass it / have new blood writing it. You need the author, or at least someone intimately familiar with its inner workings and effects. It would also make new versions increasingly difficult to make, as they'd have to tip-toe around all of those additional promises, all for functionality 99% of devs don't even need to know about or use directly.
     
unityunity