ScummVM API documentation
cc_character.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//
24// Wrapper around script "Character" struct, managing access to its variables.
25// Assumes object data contains CharacterInfo object.
26//
27//=============================================================================
28
29#ifndef AGS_ENGINE_AC_DYNOBJ_CC_CHARACTER_H
30#define AGS_ENGINE_AC_DYNOBJ_CC_CHARACTER_H
31
32#include "ags/engine/ac/dynobj/cc_ags_dynamic_object.h"
33
34namespace AGS3 {
35
37public:
38 // return the type name of the object
39 const char *GetType() override;
40 void Unserialize(int index, AGS::Shared::Stream *in, size_t data_sz) override;
41
42 uint8_t ReadInt8(void *address, intptr_t offset) override;
43 int16_t ReadInt16(void *address, intptr_t offset) override;
44 int32_t ReadInt32(void *address, intptr_t offset) override;
45 void WriteInt8(void *address, intptr_t offset, uint8_t val) override;
46 void WriteInt16(void *address, intptr_t offset, int16_t val) override;
47 void WriteInt32(void *address, intptr_t offset, int32_t val) override;
48
49protected:
50 // Calculate and return required space for serialization, in bytes
51 size_t CalcSerializeSize(const void *address) override;
52 // Write object data into the provided stream
53 void Serialize(const void *address, AGS::Shared::Stream *out) override;
54};
55
56} // namespace AGS3
57
58#endif
Definition: stream.h:52
Definition: cc_ags_dynamic_object.h:88
Definition: cc_character.h:36