Author Topic: Documentation?  (Read 263 times)

defe

  • Newbie
  • *
  • Posts: 8
    • View Profile
Documentation?
« on: May 17, 2019, 02:26:59 pm »
I've seen mention of documentation for the non-open parts, but haven't been able to actually find any source for it.  I've got several mods planned, and have started really tearing apart the available source, but if external method calls and their arguments aren't enough to make clear what's going on, then I find it hard to keep finding the thread of what I need to figure out to do what I want.

Are the docs just not available yet?  If so, is there any idea when we might be able to expect them?  Or am I just missing the link somewhere?

Thanks!

- DJ DefE D

ai_enabled

  • AtomicTorch Founder
  • Hero Member
  • *****
  • Posts: 1363
    • View Profile
Re: Documentation?
« Reply #1 on: May 18, 2019, 02:27:08 pm »
Hello!

Unfortunately, the documentation is not yet ready.
We've tried to keep API reasonably simple and add comments to most of the methods. If you're using Visual Studio you could use Object Browser to explore CryoFall scripting API. IntelliSense for autocomplete should also display the comments.

Regards!

defe

  • Newbie
  • *
  • Posts: 8
    • View Profile
Re: Documentation?
« Reply #2 on: November 04, 2019, 07:14:27 pm »
It has been close to six months, has there been any progress on documentation?  It's easy enough to read the documentation in the parts where I have the source, but the closed parts of the API are a bit more black box than I can sort out for the types of things I'm looking to do. 

Is it perhaps possible to just get documentation for that part of the API if it's a matter of scheduling?  I really want to get busy on some heavy duty modding, but I just do not have enough information to do anything but simple mods at this point.

ai_enabled

  • AtomicTorch Founder
  • Hero Member
  • *****
  • Posts: 1363
    • View Profile
Re: Documentation?
« Reply #3 on: November 05, 2019, 02:33:07 am »
defe, no progress was made in this regard as we're focusing on adding more features and content into the game.
Have you tried "Object Browser" in Visual Studio 2019 as was suggested before? We've provided comments to the most methods in API and they should be browsable from there.

Regards!

defe

  • Newbie
  • *
  • Posts: 8
    • View Profile
Re: Documentation?
« Reply #4 on: November 05, 2019, 04:33:12 am »
I have looked at the DLLs and such with the object browser, but comments on compiled code does not show there.  It gives me an idea of the shape of it all, but not the function.

ai_enabled

  • AtomicTorch Founder
  • Hero Member
  • *****
  • Posts: 1363
    • View Profile
Re: Documentation?
« Reply #5 on: November 05, 2019, 04:42:48 am »
We're shipping accompanying XML files for .NET assemblies (DLLs) with VS-formatted XML documentation.
If you load the csproj in VS you can inspect the project references and open Objects Browser for any of the API assemblies. Here is a screenshot of how it looks.

Regards!

defe

  • Newbie
  • *
  • Posts: 8
    • View Profile
Re: Documentation?
« Reply #6 on: November 05, 2019, 03:36:36 pm »
Ah, great, I'll give that a try.

Thanks!