SC2Mapster.com

SC2Mapster Forums

General > General Chat

SC2 API Documentation

  • 3 posts
  • vjeux Moderator Avatar of vjeux
    BNet
    vjeux.vjeux (EU)
    Join date
    04 Jan 2005
    Posts
    744
    Assets
    5
    Projects
    2
    Last login
    07 Sep 2010
    on Fri, 05 Mar 2010 17:42:22

    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 on 14 Mar 2010 by vjeux
  • nZifnab Regular Shmoe Avatar of nZifnab
    Join date
    02 Jun 2005
    Posts
    37
    Last login
    15 Jun 2010
    8 days later (on Sun, 14 Mar 2010 04:45:49)
    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/

  • vjeux Moderator Avatar of vjeux
    BNet
    vjeux.vjeux (EU)
    Join date
    04 Jan 2005
    Posts
    744
    Assets
    5
    Projects
    2
    Last login
    07 Sep 2010
    4 hours later (on Sun, 14 Mar 2010 09:38:30)

    Thanks it is now fixed :)

  • 3 posts

You must login to post a comment. Don't have an account? Register to get one!