playMaker

Author Topic: API documentation  (Read 3554 times)

DARK_ETERNAL

  • Full Member
  • ***
  • Posts: 111
    • View Profile
API documentation
« on: October 22, 2012, 09:56:13 AM »
Greetings.

I've got my hands dirty trying Playmaker with the editor. Pretty cool, if I may say. But, as I'm attempting to learn how to control Playmaker FSM through scripts, I've been searching for script documentation, and found nothing. It'd be good to have a full-detailed documentation of the scripts used by Playmaker, so we programmers know what, when and how to manipulate Playmaker objects through scripts. Or, if it already exists, it'd be great to have it more visible (API reference in the page only shows how to write custom actions, not what some guy using his own custom scripts, like myself, would want).

Thanks in advance.
Check out our new game: Nitro Chimp. Now live in App Store!

Trailer: http://www.youtube.com/watch?v=yxfkGy4N-lQ

Download: https://itunes.apple.com/app/nitro-chimp/id557150450?l=en&mt=8

kiriri

  • Hero Member
  • *****
  • Posts: 506
    • View Profile
Re: API documentation
« Reply #1 on: October 22, 2012, 10:00:12 AM »
+1
 I mean, a full API documentation would probably stretch it a bit too far, but a rough overview would be very useful indeed!
Best,
Sven

jeanfabre

  • Administrator
  • Hero Member
  • *****
  • Posts: 12342
  • Official Playmaker Support
    • View Profile
Re: API documentation
« Reply #2 on: October 25, 2012, 11:27:16 PM »
Yes.

 I am more an more thinking that I should do something about it, more and more users are getting into this, and this is very good, There is not much to digest and once you have some snippets you are good for 99% of the cases.

 Keep reminding me, ok :) I might have time to squeeze a first draft  on the wiki that next month.

bye,

 Jean

DARK_ETERNAL

  • Full Member
  • ***
  • Posts: 111
    • View Profile
Re: API documentation
« Reply #3 on: October 26, 2012, 08:35:54 AM »
I can give away some of my notes, but they might be incomplete, since they come from my own understanding of the API, but I guess they're still useful. It might take some time to organize them and sharing it. Thanks for your attention.
Check out our new game: Nitro Chimp. Now live in App Store!

Trailer: http://www.youtube.com/watch?v=yxfkGy4N-lQ

Download: https://itunes.apple.com/app/nitro-chimp/id557150450?l=en&mt=8