Search Unity

SceneManager's events, and events in general

Discussion in 'Documentation' started by Baste, Sep 7, 2016.

  1. Baste

    Baste

    Joined:
    Jan 24, 2013
    Posts:
    6,334
    SceneManager defines three static events:

    Code (csharp):
    1. public static event UnityAction<Scene, Scene> activeSceneChanged;
    2. public static event UnityAction<Scene, LoadSceneMode> sceneLoaded;
    3. public static event UnityAction<Scene> sceneUnloaded;
    None of the events have documented what their arguments are. It's not too hard to guess what the arguments are, but at least some people get confused.

    All publicly available events should document not only when they're raised, but also what data they send. This is just one example, I don't think I've ever seen an event document it's return data. I might be wrong.
     
    Baste, Sep 7, 2016
    #1
    mekartikshah, shottogan, dyupa and 4 others like this.

  2. Graham-Dunnett

    Graham-Dunnett

    Administrator

    Joined:
    Jun 2, 2009
    Posts:
    4,287
    I'll add this to the list of needed improvements to the docs. Hope it doesn't take too long for this to added, and similar docs found and improved.
     
    Graham-Dunnett, Sep 29, 2016
    #2
    Zullar likes this.

  3. DistulX2

    DistulX2

    Joined:
    Dec 19, 2016
    Posts:
    3
    Bump. Documents still do not reflect this information.
     
    DistulX2, May 16, 2017
    #3

  4. spacefrog

    spacefrog

    Joined:
    Jun 14, 2009
    Posts:
    734
    Bumpdee bump

    Documents still do not reflect this information.
     
    spacefrog, Jul 25, 2017
    #4

  5. Samacvuk

    Samacvuk

    Joined:
    Jan 8, 2017
    Posts:
    30
    Bumping
    Doc still does not contain this so much needed info on usage.
     
    Samacvuk, Aug 5, 2017
    #5

  6. thehippomaster21

    thehippomaster21

    Joined:
    Sep 9, 2017
    Posts:
    1
    Bump! Document still doesn't reflect this.
     
    thehippomaster21, Oct 14, 2017
    #6

  7. JetStreamSham

    JetStreamSham

    Joined:
    Jul 4, 2015
    Posts:
    27
    Bump.
    Docs still don't have this info.
     
    JetStreamSham, Oct 17, 2017
    #7

  8. paulsm_unity

    paulsm_unity

    Unity Technologies

    Joined:
    Sep 9, 2017
    Posts:
    3
    It is on our Radar guys.
     
    paulsm_unity, Oct 18, 2017
    #8

  9. callen

    callen

    Joined:
    Dec 31, 2013
    Posts:
    33
    Good to know, as I was just trying to find this exact info!
     
    callen, Oct 24, 2017
    #9

  10. mekartikshah

    mekartikshah

    Joined:
    Jan 10, 2017
    Posts:
    89
    Guys, when you are updating docs?
     
    mekartikshah, Jul 19, 2018
    #10

  11. jc-drile77

    jc-drile77

    Joined:
    Jul 1, 2014
    Posts:
    230
    jc-drile77, Aug 13, 2018
    #11
    mekartikshah likes this.