SC2Mapster Forums

General > General Chat

SC2 API Documentation

This thread has been locked by Zarakk.

Pew pew lazor pidgeons

  • 3 posts
    #1 Mar 05, 2010 at 17:42 UTC - 0 likes

    I am currently leading the SC2 API Documentation effort and this post is going to be the place to talk about it. http://kb.sc2mapster.com/sc2-api/

    What has been achieved so far:

    Functions

    http://kb.sc2mapster.com/sc2-api/functions/

    Types

    http://kb.sc2mapster.com/sc2-api/types/

    • The type list is done

    What need to be done:

    Functions

    • The function list has been somewhat organized but it's still quite messy.
    • Only few functions are documented so far. Need to document more.
    How to document

    In order to document, just copy the source of an already documented function and customize it. Once you are done, add the little description next to the documented function in the list.

    Make sure you have at least one example! This is the most important part. If you have questions about the function, do not hesitate to post a comment right after.

    Type

    Everything is to be done

    Thanks!

    Last edited Mar 14, 2010 by vjeux
    #2 Mar 14, 2010 at 04:45 UTC - 0 likes
    Quote from vjeux: Go

    http://kb.sc2mapster.com/sc2-api/functions/list/

    That link is broken :)

    Did you mean: http://www.sc2mapster.com/api-docs/functions/

    #3 Mar 14, 2010 at 09:38 UTC - 0 likes

    Thanks it is now fixed :)

  • 3 posts