ScummVM API documentation
GameSaveArea.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/*
23 * Copyright (C) 2006-2010 - Frictional Games
24 *
25 * This file is part of Penumbra Overture.
26 */
27
28#ifndef GAME_GAME_SAVE_AREA_H
29#define GAME_GAME_SAVE_AREA_H
30
31#include "hpl1/engine/engine.h"
32#include "hpl1/penumbra-overture/GameEntity.h"
33
34using namespace hpl;
35
36//-----------------------------------------
37
39 kSerializableClassInit(cGameSaveArea_SaveData);
40
41public:
42 cVector3f mvSize;
43
44 tString msMessageCat;
45 tString msMessageEntry;
46
47 tString msSound;
48
49 bool mbHasBeenUsed;
50
51 iGameEntity *CreateEntity();
52};
53
54//------------------------------------------
55
56class cGameSaveArea : public iGameEntity {
57 typedef iGameEntity super;
58 friend class cAreaLoader_GameSaveArea;
59
60public:
61 cGameSaveArea(cInit *apInit, const tString &asName);
62 ~cGameSaveArea(void);
63
64 void OnPlayerPick();
65 void OnPlayerInteract();
66
67 void SetMessageCat(const tString &asCat) { msMessageCat = asCat; }
68 void SetMessageEntry(const tString &asEntry) { msMessageEntry = asEntry; }
69
70 void SetSound(const tString &asSound) { msSound = asSound; }
71
72 void SetHasBeenUsed(bool abX) { mbHasBeenUsed = abX; }
73
74 tString &GetMessageCat() { return msMessageCat; }
75 tString &GetMessageEntry() { return msMessageEntry; }
76
77 tString &GetSound() { return msSound; }
78
79 bool GetHasBeenUsed() { return mbHasBeenUsed; }
80
81 // SaveObject implementation
82 iGameEntity_SaveData *CreateSaveData();
83 void SaveToSaveData(iGameEntity_SaveData *apSaveData);
84 void LoadFromSaveData(iGameEntity_SaveData *apSaveData);
85
86private:
87 tString msMessageCat;
88 tString msMessageEntry;
89
90 tString msSound;
91
92 bool mbHasBeenUsed;
93};
94
95//--------------------------------------
96
98
99public:
100 cAreaLoader_GameSaveArea(const tString &asName, cInit *apInit);
102
103 iEntity3D *Load(const tString &asName, const cVector3f &avSize, const cMatrixf &a_mtxTransform, cWorld3D *apWorld);
104
105private:
106 cInit *mpInit;
107};
108
109#endif // GAME_GAME_SAVE_AREA_H
Definition: str.h:59
Definition: GameSaveArea.h:97
Definition: GameSaveArea.h:38
Definition: GameSaveArea.h:56
Definition: Init.h:70
Definition: World3D.h:179
Definition: Resources.h:133
Definition: Entity3D.h:81
Definition: GameEntity.h:76
Definition: GameEntity.h:126