ScummVM API documentation
credits_gump.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 ULTIMA8_GUMPS_CREDITSGUMP_H
23
#define ULTIMA8_GUMPS_CREDITSGUMP_H
24
25
#include "ultima/shared/std/string.h"
26
#include "ultima/ultima8/gumps/modal_gump.h"
27
#include "ultima/ultima8/misc/classtype.h"
28
29
namespace
Ultima
{
30
namespace
Ultima8 {
31
32
class
RenderedText;
33
37
class
CreditsGump
:
public
ModalGump
{
38
public
:
39
ENABLE_RUNTIME_CLASSTYPE()
40
41
CreditsGump
();
42
CreditsGump
(
const
Std::string
&text,
int
parskip = 24,
43
uint32 flags = FLAG_PREVENT_SAVE, int32 layer = LAYER_MODAL);
44
~
CreditsGump
()
override
;
45
46
// Init the gump, call after construction
47
void
InitGump
(
Gump
*newparent,
bool
take_focus =
true
)
override
;
48
49
// Set a configuration option to true when user watches entire sequence
50
void
SetFlagWhenFinished(
Std::string
configKey) {
51
_configKey = configKey;
52
}
53
54
void
Close
(
bool
no_del =
false
)
override
;
55
56
void
run
()
override
;
57
58
// Paint the Gump
59
void
PaintThis
(
RenderSurface
*, int32 lerp_factor,
bool
scaled)
override
;
60
61
bool
OnKeyDown(
int
key,
int
mod)
override
;
62
63
protected
:
64
65
void
extractLine(
Std::string
&text,
char
&modifier,
Std::string
&line);
66
67
Std::string
_text;
68
int
_parSkip;
69
70
enum
CreditsState {
71
CS_PLAYING,
72
CS_FINISHING,
73
CS_CLOSING
74
} _state;
75
76
int
_timer;
77
78
RenderedText
*_title;
79
RenderedText
*_nextTitle;
80
int
_nextTitleSurf;
81
82
RenderSurface
*_scroll[4];
83
int
_scrollHeight[4];
84
int
_currentSurface;
85
int
_currentY;
86
87
Std::string
_configKey;
88
};
89
90
}
// End of namespace Ultima8
91
}
// End of namespace Ultima
92
93
#endif
Ultima::Ultima8::CreditsGump::InitGump
void InitGump(Gump *newparent, bool take_focus=true) override
Ultima::Ultima8::CreditsGump::PaintThis
void PaintThis(RenderSurface *, int32 lerp_factor, bool scaled) override
Overloadable method to Paint just this Gump (RenderSurface is relative to this)
Ultima::Ultima8::ModalGump
Definition:
modal_gump.h:34
Ultima::Ultima8::RenderSurface
Definition:
render_surface.h:40
Ultima::Ultima8::Gump
Definition:
gump.h:47
Ultima::Ultima8::RenderedText
Definition:
rendered_text.h:30
Ultima
Definition:
detection.h:27
Ultima::Std::string
Definition:
string.h:30
Ultima::Ultima8::CreditsGump
Definition:
credits_gump.h:37
Ultima::Ultima8::CreditsGump::run
void run() override
Run the gump.
Ultima::Ultima8::CreditsGump::Close
void Close(bool no_del=false) override
engines
ultima
ultima8
gumps
credits_gump.h
Generated on Fri Aug 30 2024 09:20:16 for ScummVM API documentation by
1.8.13