diff options
| author | truebrain <truebrain@openttd.org> | 2011-11-29 23:27:26 +0000 |
|---|---|---|
| committer | truebrain <truebrain@openttd.org> | 2011-11-29 23:27:26 +0000 |
| commit | 4d91f645c15bb3128adf969afcf7f15bd0f14fa0 (patch) | |
| tree | 8ccc602deda6aa29bedcd19f697558348e7af3d6 /src/script/api/script_event.hpp | |
| parent | 2c877b074ed656a6cf1d4d4e415cce407980add5 (diff) | |
| download | openttd-4d91f645c15bb3128adf969afcf7f15bd0f14fa0.tar.xz | |
(svn r23370) -Add: support @api tag in API header files, to select which API should receive the defined classes and functions
Diffstat (limited to 'src/script/api/script_event.hpp')
| -rw-r--r-- | src/script/api/script_event.hpp | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/src/script/api/script_event.hpp b/src/script/api/script_event.hpp index eb15ded2e..ed7684943 100644 --- a/src/script/api/script_event.hpp +++ b/src/script/api/script_event.hpp @@ -18,6 +18,7 @@ * Class that handles all event related functions. * You can lookup the type, and than convert it to the real event-class. * That way you can request more detailed information about the event. + * @api ai */ class ScriptEvent : public ScriptObject { public: @@ -72,6 +73,7 @@ protected: /** * Class that handles all event related functions. + * @api ai * @note it is not needed to create an instance of ScriptEvent to access it, as * all members are static, and all data is stored AI-wide. */ @@ -89,20 +91,18 @@ public: */ static ScriptEvent *GetNextEvent(); -#ifndef EXPORT_SKIP /** * Insert an event to the queue for the company. * @param event The event to insert. - * @note DO NOT CALL YOURSELF; leave it to the internal AI programming. + * @api -all */ static void InsertEvent(ScriptEvent *event); /** * Free the event pointer. - * @note DO NOT CALL YOURSELF; leave it to the internal AI programming. + * @api -all */ static void FreeEventPointer(); -#endif /* EXPORT_SKIP */ private: /** |