OpenTTD Source: src/ai/ai_instance.hpp Source File

OpenTTD Source 14.0-beta3

ai_instance.hpp
Go to the documentation of this file.
1 /*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
7
10 #ifndef AI_INSTANCE_HPP
11 #define AI_INSTANCE_HPP
12
13 #include "../script/script_instance.hpp"
14
16 class AIInstance : public ScriptInstance {
17 public:
18 AIInstance();
19
24 void Initialize(class AIInfo *info);
25
26 int GetSetting(const std::string &name) override;
27 ScriptInfo *FindLibrary(const std::string &library, int version) override;
28
29 private:
30 void RegisterAPI() override;
31 void Died() override;
32 CommandCallbackData *GetDoCommandCallback() override;
33 void LoadDummyScript() override;
34 };
35
36 #endif /* AI_INSTANCE_HPP */
AIInstance::GetSetting
int GetSetting(const std::string &name) override
Get the value of a setting of the current instance.
Definition: ai_instance.cpp:86
AIInstance::GetDoCommandCallback
CommandCallbackData * GetDoCommandCallback() override
Get the callback handling DoCommands in case of networking.
Definition: ai_instance.cpp:119
ScriptInstance
Runtime information about a script like a pointer to the squirrel vm and the current state.
Definition: script_instance.hpp:25
AIInstance::Initialize
void Initialize(class AIInfo *info)
Initialize the AI and prepare it for its first run.
Definition: ai_instance.cpp:40
AIInstance::FindLibrary
ScriptInfo * FindLibrary(const std::string &library, int version) override
Find a library.
Definition: ai_instance.cpp:91
AIInstance::LoadDummyScript
void LoadDummyScript() override
Load the dummy script.
Definition: ai_instance.cpp:80
CommandCallbackData
void CommandCallbackData(Commands cmd, const CommandCost &result, const CommandDataBuffer &data, CommandDataBuffer result_data)
Define a callback function for the client, after the command is finished.
Definition: command_type.h:495
AIInstance::Died
void Died() override
Tell the script it died.
Definition: ai_instance.cpp:60
AIInfo
All static information from an AI like name, version, etc.
Definition: ai_info.hpp:16
AIInstance
Runtime information about an AI like a pointer to the squirrel vm and the current state.
Definition: ai_instance.hpp:16
AIInstance::RegisterAPI
void RegisterAPI() override
Register all API functions to the VM.
Definition: ai_instance.cpp:50
ScriptInfo
All static information from an Script like name, version, etc.
Definition: script_info.hpp:30