Page 1 of 1

List of system varibles and functions.

Posted: 18 Jun 2014, 14:30
by faserg1
Hi all! I have one small idea — collect here system varibles and functions. There will be info about that. So, I will start.

Common
Varibles
  • Boolean ServerShutdownRequested; //Is Server Requested Shutdows
    Examples:

    Links:
  • Boolean MatchEndRequested; //Is Math and Requested
    Examples:

    Links:
Functions
Empty...
CSmMode
Varibles
  • CSmPlayer[] AllPlayers; //Players, Spectators and Bots
    Examples:

    Links:
  • CSmPlayer[] Players; //Connected and playing players :D
    Examples:

    Links:
  • CSmPlayer[] Spectators; //Spectators
    Examples:

    Links:
  • CSmPlayer[] BotPlayers; //Bots
    Examples:

    Links:
  • Boolean UseClans; //Is need to use clans and clans functional.
    Examples:

    Links:
Functions
Empty...

Maybe someone attach it topic to top... But I don't thonk so... I just ask all to help me and collect all things here ;)

Re: List of system varibles and functions.

Posted: 18 Jun 2014, 14:35
by steeffeen
why don't you just look at the classes documentation?

Hosted by me
how-to

Re: List of system varibles and functions.

Posted: 18 Jun 2014, 14:37
by faserg1
Ha, anyway, I don't find there system varibles and functions.

Re: List of system varibles and functions.

Posted: 18 Jun 2014, 14:39
by steeffeen
do you mean they aren't there or you don't know how to find them?
because they are all there.

example:
Boolean ServerShutdownRequested;
-> CSmMode

Re: List of system varibles and functions.

Posted: 18 Jun 2014, 14:42
by faserg1
Hmmm... Forget that they are const :shock: ... but anyway sometimes it hard to find...
Also... Maybe post here more info about that?

Re: List of system varibles and functions.

Posted: 18 Jun 2014, 14:45
by fleo
I agree that having a documentation with comments and examples would be amazing.

You should do that on github, it'd be easier to make it participative.

Re: List of system varibles and functions.

Posted: 18 Jun 2014, 14:46
by faserg1
Have an idea: edit source file...
Doxygen can read special comments and post they in documentaton...

Re: List of system varibles and functions.

Posted: 18 Jun 2014, 14:48
by steeffeen
just to make that clear: the Const keyword in the documentation rather means "read-only"
the values change, but they are changed only by the server and not by your script

@comments
you should rather request nadeo to add them so they are generated automatically
maybe something for your wishlist

Re: List of system varibles and functions.

Posted: 18 Jun 2014, 14:49
by faserg1
I now, what mean const... I am coder... But on C++. I just forget were placed varibles... :cry:

Hey! I have more ideas! :D
That will help all of us!
steeffeen, I need your help! Can I tolk with you in PM?

Re: List of system varibles and functions.

Posted: 18 Jun 2014, 14:55
by steeffeen
faserg1 wrote:I now, what mean const... I am coder...
well usually Const means "constant" and not "read-only" ;)

just send a pm, but i won't inject comments in the generated doc file
i can host it though
just keep in mind that you would have to adjust it after each update Nadeo does since the doc source file will be regenerated