immibis
/
colobot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Minor changes to CBotProgram docs

dev-time-step
krzys-h 2015-12-21 21:46:50 +01:00
parent eedf8dacea
commit c8498740f2
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/CBot/CBotProgram.h
View File

@ -173,13 +173,13 @@ public:
* \parblock * \parblock
* * timer < 0 do nothing * * timer < 0 do nothing
* * timer >= 0 call SetTimer(int timer) before executing * * timer >= 0 call SetTimer(int timer) before executing
* \parblockend * \endparblock
* \return true if the program execution finished, false if the program is suspended (you then have to call Run() again) * \return true if the program execution finished, false if the program is suspended (you then have to call Run() again)
*/ */
bool Run(void* pUser = nullptr, int timer = -1); bool Run(void* pUser = nullptr, int timer = -1);
/** /**
* \brief GetRunPos Gives the current position in the executing program * \brief Gives the current position in the executing program
* \param[out] functionName Name of the currently executed function * \param[out] functionName Name of the currently executed function
* \param[out] start Starting position in the code string of currently executed instruction * \param[out] start Starting position in the code string of currently executed instruction
* \param[out] end Ending position in the code string of currently executed instruction * \param[out] end Ending position in the code string of currently executed instruction
@ -263,6 +263,7 @@ public:
* AddFunction("message", rMessage, cMessage); * AddFunction("message", rMessage, cMessage);
* \endcode * \endcode
* *
* For more sophisticated examples, see the Colobot source code, mainly the src/script/scriptfunc.cpp file
* *
* \param name Name of the function * \param name Name of the function
* \param rExec Execution function * \param rExec Execution function
@ -283,11 +284,14 @@ public:
/*! /*!
* \brief Save the current execution status into a file * \brief Save the current execution status into a file
* \param pf file handle * \param pf
* \paramblock * \parblock
* file handle
*
* This file handle must have been opened by this library! Otherwise crashes on Windows * This file handle must have been opened by this library! Otherwise crashes on Windows
*
* TODO: Verify this * TODO: Verify this
* \endparamblock * \endparblock
* \return true on success, false on write error * \return true on success, false on write error
*/ */
bool SaveState(FILE* pf); bool SaveState(FILE* pf);
@ -295,7 +299,7 @@ public:
/*! /*!
* \brief Restore the execution state from a file * \brief Restore the execution state from a file
* *
* The previous program code must be already recompiled to call this function * The previous program code must already have been recompiled with Compile() before calling this function
* *
* \param pf file handle * \param pf file handle
* \return true on success, false on read error * \return true on success, false on read error