Please login or register.

Login with username, password and session length
Advanced search  

News:

IRC channel - server: waelisch.de  channel: #wme (read more)

Author Topic: undocumented methods and properties  (Read 3743 times)

0 Members and 1 Guest are viewing this topic.

joaomesq

  • Teacher / Game Designer
  • Lurker
  • *
  • Karma: 1
  • Offline Offline
  • Gender: Male
  • Posts: 44
    • View Profile
    • Nó Górdio
undocumented methods and properties
« on: February 12, 2005, 06:15:58 PM »

Just to warn everybody that the property Scene.Name is missing in the docs.

It's was obvious that it had to exist but it is undocumented. This (minor) problem makes me think that a community-based help file would be nice. For those with some programming background, undocumented or unorthodox features are nothing new, but for the inexperienced user it's the diference between using or not using the program. So here is my suggestion:

1 -  All Mnemonic have to do is "dump" the new method and property syntax and the rest of the us add description, examples and, if applicable, tutorials. When a new version of the engine is available, the documentation is freezed and released with the engine as stand-alone;

2 - To avoid new releases with unfinished documentation every 1st day of the month all docs should be complete;

2 - Mnemonic don't have to worry about writing docs;

What's your opinion?

EDIT: Just realised Scene.Name is actually a property. Sorry about that  :-\. Fixed
« Last Edit: February 12, 2005, 06:20:55 PM by joaomesq »
Logged
Crisis is just another word for opportunity

deadworm222

  • Regular poster
  • ***
  • Karma: 0
  • Offline Offline
  • Gender: Male
  • Posts: 197
  • Wintermute Army
    • View Profile
Re: undocumented methods and properties
« Reply #1 on: February 13, 2005, 01:34:00 PM »

A Wiki-based system?
Logged

Mnemonic

  • WME developer
  • Administrator
  • Addicted to WME forum
  • *
  • Karma: 41
  • Offline Offline
  • Gender: Male
  • Posts: 5683
    • View Profile
    • Dead:Code Site
Re: undocumented methods and properties
« Reply #2 on: February 13, 2005, 03:53:06 PM »

We were discussing something like that long long time ago at IRC, something like the PHP online documentation has. It would be nice, definitely, but the question is if anyone would contribute to such system :)
Logged
Yes, I do have a twitter account
Please don't send me technical questions in private messages, use the forum. ::wave

joaomesq

  • Teacher / Game Designer
  • Lurker
  • *
  • Karma: 1
  • Offline Offline
  • Gender: Male
  • Posts: 44
    • View Profile
    • Nó Górdio
Re: undocumented methods and properties
« Reply #3 on: February 13, 2005, 05:04:20 PM »

I think everyone of us in our daily work could contribute something.

For instance, I'm currently building an Ultraedit Auto-Complete file of WME Script v. 1.3.2 for my personal use, but when it's finished I dont't mind (of course) to share it. It's purpose it's not perfect because Ultraedit doesn't do object type detection, but forces me to browse extensively through the methods and properties available.:-\

 I think I saw somewhere is this forum several inventory scripts. Why don't put it in the docs as examples? They're already built, so the script author just have to adapt them.

In this case I knew Scene.Name existed but I couldn't find it in the docs, so I checked in the forum. After I would go to the docs and add the missing property. It makes sense to me. I would solve my problem and prevent other's problem at the same time.

You could argue that the forum exists to do this type of things but I think a more structured approach option would be better. For me is also important to have a copy in a file for those who can't be online all the time.
Logged
Crisis is just another word for opportunity

metamorphium

  • Global Moderator
  • Addicted to WME forum
  • *
  • Karma: 12
  • Offline Offline
  • Gender: Male
  • Posts: 1511
  • Vampires!
    • View Profile
    • CBE  software s.r.o.
Re: undocumented methods and properties
« Reply #4 on: February 13, 2005, 06:05:00 PM »

We were discussing something like that long long time ago at IRC, something like the PHP online documentation has. It would be nice, definitely, but the question is if anyone would contribute to such system :)

For this is the best WakaWikki system. We used something like this when I was working with NeoEngine. But still I find the
WME documentation very good.
Logged
J.U.L.I.A. Enhanced Edition, Vampires!, J.U.L.I.A., J.U.L.I.A. Untold, Ghost in the Sheet
 

Page created in 0.017 seconds with 18 queries.