ScummVM API documentation
xsheetfile.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 NANCY_RESOURCE_XSHEETFILE_H
23#define NANCY_RESOURCE_XSHEETFILE_H
24
25#include "common/array.h"
26#include "common/path.h"
27#include "common/rect.h"
28#include "common/str.h"
29
30namespace Nancy {
31
32// An XSheet puts a character in a conversation together from parts, its trees:
33// cels, or movies from Nancy15 on. For each of its frames, it names the cel or
34// the movie frame that every tree shows.
35struct XSheetFile {
36 static const uint kMaxTrees = 4;
37
38 // Nancy13 and up; earlier games name the trees in their conversations
40
41 // Nancy15 and up: where the trees that are movies go, one for each slot
43
44 // Milliseconds a frame up to Nancy18, frames a second from Nancy19 on
45 uint32 frameTiming = 0;
46
47 uint numFrames = 0;
48
49 // For each tree, the cel of every frame before Nancy16, and the movie frame
50 // of every frame from Nancy16 on
53
54 bool load(const Common::String &name);
55};
56
57} // End of namespace Nancy
58
59#endif // NANCY_RESOURCE_XSHEETFILE_H
Definition: str.h:59
Definition: actionmanager.h:32
Definition: xsheetfile.h:35