ScummVM API documentation
game.h
1 /* ScummVM - Graphic Adventure Engine
2  *
3  * ScummVM is the legal property of its developers, whose names
4  * are too numerous to list here. Please refer to the COPYRIGHT
5  * file distributed with this source distribution.
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program. If not, see <http://www.gnu.org/licenses/>.
19  *
20  */
21 
22 #ifndef AGS_PLUGINS_CORE_GAME_H
23 #define AGS_PLUGINS_CORE_GAME_H
24 
25 #include "ags/plugins/ags_plugin.h"
26 
27 namespace AGS3 {
28 namespace Plugins {
29 namespace Core {
30 
31 class Game : public ScriptContainer {
32  BUILT_IN_HASH(Game)
33 public:
34  virtual ~Game() {}
35  void AGS_EngineStartup(IAGSEngine *engine) override;
36 
37  void IsAudioPlaying(ScriptMethodParams &params);
38  void SetAudioTypeSpeechVolumeDrop(ScriptMethodParams &params);
39  void SetAudioTypeVolume(ScriptMethodParams &params);
40  void StopAudio(ScriptMethodParams &params);
41  void ChangeTranslation(ScriptMethodParams &params);
42  void DoOnceOnly(ScriptMethodParams &params);
43  void GetColorFromRGB(ScriptMethodParams &params);
44  void GetFrameCountForLoop(ScriptMethodParams &params);
45  void GetLocationName(ScriptMethodParams &params);
46  void GetLoopCountForView(ScriptMethodParams &params);
47  void GetMODPattern(ScriptMethodParams &params);
48  void GetRunNextSettingForLoop(ScriptMethodParams &params);
49  void GetSaveSlotDescription(ScriptMethodParams &params);
50  void GetViewFrame(ScriptMethodParams &params);
51  void InputBox(ScriptMethodParams &params);
52  void SetSaveGameDirectory(ScriptMethodParams &params);
53  void StopAllSounds(ScriptMethodParams &params);
54  void GetCharacterCount(ScriptMethodParams &params);
55  void GetDialogCount(ScriptMethodParams &params);
56  void GetFileName(ScriptMethodParams &params);
57  void GetFontCount(ScriptMethodParams &params);
58  void GetGlobalMessages(ScriptMethodParams &params);
59  void GetGlobalStrings(ScriptMethodParams &params);
60  void SetGlobalString(ScriptMethodParams &params);
61  void GetGUICount(ScriptMethodParams &params);
62  void GetIgnoreUserInputAfterTextTimeoutMs(ScriptMethodParams &params);
63  void SetIgnoreUserInputAfterTextTimeoutMs(ScriptMethodParams &params);
64  void GetInSkippableCutscene(ScriptMethodParams &params);
65  void GetInventoryItemCount(ScriptMethodParams &params);
66  void GetMinimumTextDisplayTimeMs(ScriptMethodParams &params);
67  void SetMinimumTextDisplayTimeMs(ScriptMethodParams &params);
68  void GetMouseCursorCount(ScriptMethodParams &params);
69  void GetName(ScriptMethodParams &params);
70  void SetName(ScriptMethodParams &params);
71  void GetNormalFont(ScriptMethodParams &params);
72  void SetNormalFont(ScriptMethodParams &params);
73  void GetSkippingCutscene(ScriptMethodParams &params);
74  void GetSpeechFont(ScriptMethodParams &params);
75  void SetSpeechFont(ScriptMethodParams &params);
76  void GetSpriteWidth(ScriptMethodParams &params);
77  void GetSpriteHeight(ScriptMethodParams &params);
78  void GetTextReadingSpeed(ScriptMethodParams &params);
79  void SetTextReadingSpeed(ScriptMethodParams &params);
80  void GetTranslationFilename(ScriptMethodParams &params);
81  void GetUseNativeCoordinates(ScriptMethodParams &params);
82  void GetViewCount(ScriptMethodParams &params);
83  void PlayVoiceClip(ScriptMethodParams &params);
84 };
85 
86 } // namespace Core
87 } // namespace Plugins
88 } // namespace AGS3
89 
90 #endif
Definition: plugin_base.h:131
Definition: game.h:31
Definition: ags_plugin.h:328
Definition: plugin_base.h:151
Definition: ags.h:40