ScummVM API documentation
tinlib.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  * Text utility defines
21  */
22 
23 #ifndef TINSEL_TINLIB_H // prevent multiple includes
24 #define TINSEL_TINLIB_H
25 
26 #include "tinsel/dw.h"
27 #include "tinsel/object.h"
28 #include "tinsel/palette.h"
29 
30 namespace Tinsel {
31 
32 enum EXTREME {
33  EX_USEXY, EX_BOTTOM, EX_BOTTOMLEFT,
34  EX_BOTTOMRIGHT, EX_LEFT, EX_RIGHT,
35  EX_TOP, EX_TOPLEFT, EX_TOPRIGHT
36 };
37 
38 enum WHICH_VER {VER_GLITTER, VER_COMPILE};
39 #define VER_LEN 10
40 
41 // Support functions
42 void TinGetVersion(WHICH_VER which, char *buffer, int length);
43 
44 // Library functions in TINLIB.C
45 
46 void ActorBrightness(int actor, int brightness);
47 void ActorPalette(int actor, int startColor, int length);
48 void Control(int param);
49 void HookScene(SCNHANDLE scene, int entrance, int transition);
50 void NewScene(CORO_PARAM, SCNHANDLE scene, int entrance, int transition);
51 void Offset(EXTREME extreme, int x, int y);
52 void FnRestartGame();
53 void RestoreScene();
54 void ResumeLastGame();
55 void SaveScene(CORO_PARAM);
56 void Stand(CORO_PARAM, int actor, int x, int y, SCNHANDLE film);
57 void SetTextPal(COLORREF col);
58 
59 void KeepOnScreen(OBJECT *pText, int *pTextX, int *pTextY);
60 
61 enum SPEECH_TYPE { IS_SAY, IS_SAYAT, IS_TALK, IS_TALKAT };
62 
63 } // End of namespace Tinsel
64 
65 #endif // TINSEL_TINLIB_H
uint32 SCNHANDLE
Definition: dw.h:31
#define CORO_PARAM
Definition: coroutines.h:107
Definition: actors.h:36