Search Unity

Bolt API Documentation?

Discussion in 'Visual Scripting' started by ModLunar, Sep 27, 2020.

  1. ModLunar

    ModLunar

    Joined:
    Oct 16, 2016
    Posts:
    374
    Are there plans to majorly improve the Scripting API documentation for Bolt?

    Right now, it's very confusing (despite being an awesome tool), especially with why there are so many classes/interfaces that all sound the same, without XML-C# docs comments or anything to differentiate/explain them:

    FlowMacro
    FlowGraph (isn't this just a FlowMacro, since a FlowMacro is a graph? What's the difference?)
    Flow (How do I get a reference to one of these that's already playing from a FlowMachine component in my scene?)
    IGraphRoot (what is a graph "root"?)
    GraphReference (why is this needed?)
    Graph (why is this different from a GraphReference?)

    These are just some examples of my confusion.
    Docs would be seriously appreciated, or even a roadmap of improving them soon.

    Thanks!
     
    Ex-Crow and Brody-TOG like this.
  2. Brody-TOG

    Brody-TOG

    Joined:
    May 7, 2020
    Posts:
    15
    Seconding this, as someone who wants to use Bolt for production and add custom/reflected units and know what else I can do to customize/integrate with Bolt, it's frustrating how much is currently left up to old forum posts and tribal knowledge to piece together.
     
    ModLunar likes this.
  3. Ex-Crow

    Ex-Crow

    Joined:
    Aug 14, 2020
    Posts:
    111
    It's being worked on according to the new roadmap post:
     
    ModLunar likes this.