Addon Api Documentation website

[narkos]

@pieter i disabled account registration and comments.

I thought comments can be usefull... but you're right

[JoSchaap]

documentations shouldnt have comments or any other interaction then explaining how shit works

see it as adding a comment section to every wikipedia page

[narkos]

Comments were activated because when i made the website, i thought about good comments on php.net, so i thought some comments can be useful...

But without comments it will be proper for sure

[JariZ]

The comments on php.net helped me a lot.
Altough it would be more useful if people didn't had to register to place comments

[Nekochan]

@Ich1994 did it already :/

[zxz0O0]

Also what is that:

Code:

int Entity_World //Integer holding the EntityNum of 'World'
int AddonFrameInterval //Integer holding the interval of OnAddonFrame in milliseconds

Is that like global addon variables available in all the plugins?

Thx in advance for the answers!

Very good job!

Entity_World: Every entity has it's own number (ID). The last entity (2047) is the world entity. The entity which includes everything. It is needed if you for example want to display a hudelement to everyone.

AddonFrameInterval: The event OnAddonFrame is triggered by a thread in the addon. This thread has a specific interval which is currently 250ms (4FPS). However since this number could change one time in the developement I created this constant variable which holds this interval so plugin developers can use this instead of a number. For example if you want to do something every second:

CSHARP Code

private int counter = 0;
 
public override void OnAddonFrame()
{
      counter++;
      if(counter==1000/AddonFrameInterval)
      {
           counter = 0;
           //do your stuff here
           //exectued every second
      }
}

[narkos]

Thank you!

Will the next addon update have more variables like this? Is it usefull to create a new section for 'variables' as 'functions', 'events' and 'Struct/Enums' sections in the doc?
Or should i had them in 'Struct/Enums' section?

I saw in a post that you already added weaponbuilder to the next addon update? Can i get more infos yet to integrate to the doc?

Thanks!