scummvm/queen/xref.txt

$Id$

Cross-reference for functions and variables for the original source code and
the ScummVM implementation.


BANKS
=====
erase()						Graphics::bankErase
loadbank()					Graphics::bankLoad
overpack()					Graphics::bankOverpack
unpack()					Graphics::bankUnpack


CREDIT SCRIPTING SYSTEM
=======================
Cinit()
Ctext()
Cupdate()
-
Ccol
Ccount
Cfp
Cflag
Cfontsize
Cjustify
Cpausecount
Czone


CUTAWAY
=======
CUTAWAY()					Cutaway::run
SCENE_START()
SCENE_END()
TROOM
IROOM
FINAL_ROOM


DEBUG
=====
cd_sample_check()
debuginfo()
select_new_room()
-
AREAVAR						(boolean, if true display objects/areas boxes)


GRAPHICS
========
bob()						Graphics::bobDraw
Box()						Graphics::boxDraw
calc_screen_scroll()
CHECK_PARALLAX()
clearallbobs()				Graphics::bobClearAll
clearbob()					Graphisc::bobClear
clearpanel()				Graphics::panelClear
drawbobs()					Graphics::bobDrawAll
drawbackdrop()				Graphics::backdropDraw
drawpanel()					Graphics::panelDraw
drawscreen()
freeallframes()				Graphics::frameEraseAll(true)
freeframes()				Graphics::frameEraseAll(false)
invbob()					Graphics::bobDrawInventoryItem
loadbackdrop()				Graphics::backdropLoad
loadfont()					*not needed*
loadpanel()					Graphics::panelLoad
makeanim()					Graphics::bobAnimNormal
movebob()					Graphics::bobMove
pastebob()					Graphics::bobPaste
requestor()
shrinkbob()					Graphics::bobShrink
sortbobs()					Graphics::bobSortAll
stringanim()				Graphics::bobAnimString
-
bobs						Graphics::_bobs
BDxres						Graphics::_backdropWidth
BDyres						Graphics::_backdropHeight
cambob						Graphics::_cameraBob
clothespal
dresspal
font						Graphics::FONT
font_sizes					Graphics::FONT_SIZES
sortedbobs					Graphics::_sortedBobs
scrollx						Graphics::_horizontalScroll


INVENTORY
=========
INVDWN()
INVENTORY()
INVUP()
DEL_ITEM_NUM()
INS_ITEM_NUM()
-
INV1,INV2,INV3,INV4


LOGIC
=====
DISP_OBJECTS()				Logic::roomSetupObjects
DISP_ROOM()					Logic::roomDisplay
FIND_BOB()					Logic::findBob
FIND_DEFAULT()
FIND_FRAME()				Logic::findFrame
FIND_GRAPHIC()
FIND_SACTION()
FIND_SCALE()				Logic::findScale
FIND_STATE()				Logic::findState*
FIND_VERB()
LOOK()
LOOK_ICON()
LOOK_ITEM()
LOOK_ROOM()
P1_SET_CONDITIONS()
P2_SET_AREAS()
P3_SET_OBJECTS()
P3_COPY_FROM()
P4_SET_ITEMS()
restart_game()
SELECT()
SELECT_ITEM()
SELECT_NOUN()
SELECT_VERB()
SETUP_BOBS()				Graphics::bobSetupControl
SETUP_FURNITURE()			Logic::roomSetupFurniture
SETUP_ITEMS()
SETUP_JOE()					Walk::joeSetup
SETUP_ROOM()
SETUP_SCRVARS()
update() 					Graphics::update
USE_UNDERWEAR()
USE_CLOTHES()
USE_DRESS()
USE_JOURNAL()				Graphics::useJournal
WALK()
-
A_ANIMstr 				Logic::_aAnim
A_ANIM_MAX				Logic::_numAAnim
A_NAMEstr 				Logic::_aName
A_NAME_MAX				Logic::_numAName
A_FILEstr 				Logic::_aFile
A_FILE_MAX				Logic::_numAFile
ACTOR_DATA_MAX			Logic::_numActors
AREA					Logic::_area
AREAMAX					Logic::_areaMax
COM_A					Logic::_cmdArea
COM_A_MAX				Logic::_numCmdArea
COM_O					Logic::_cmdObject
COM_O_MAX				Logic::_numCmdObject
COM_G					Logic::_cmdGameState
COM_G_MAX				Logic::_numCmdGameState
COM_I					Logic::_cmdInventory
COM_I_MAX				Logic::_numCmdInventory
COM_LIST				Logic::_cmdList
COM_LIST_MAX			Logic::_numCmdList
DESCTOT					Logic::_numDescriptions
FMAX					Logic::_numFurnitureStatic
FMAXA					Logic::_numFurnitureAnimated
FMAXLEN					Logic::_numFurnitureAnimatedLen
FRAMES					Logic::_numFrames
FURN_DATA_MAX			Logic::_numFurniture
GAMESTATE				Logic::_gameState
GRAPHIC_ANIM_MAX		Logic::_numGraphicAnim
GRAPHIC_DATA			Logic::_graphicData
GRAPHIC_MAX				Logic::_numGraphics
ITEMTOT					Logic::_numItems
ITEM_DATA				Logic::_itemData
JOE_RESPstr 			Logic::_joeResponse
JOEF,JX,JY				Logic::_joe.*
NAMETOT					Logic::_numNames
NEW_ANIM				Logic::_newAnim
OBJ_DESC_MAX			Logic::_numObjDesc
OBJECT_BOX				Logic::_objectBox
OBJECT_DATA				Logic::_objectData
OBJECT_DESCRstr			Logic::_objDescription
OBJECT_NAMEstr			Logic::_objName
OBJMAX					Logic::_objMax
OBJTOT					Logic::_numObjects
OLDROOM,ROOM,NEW_ROOM  	Logic::_*oom
ROOMTOT					Logic::_numRooms
ROOM_DATA				Logic::_roomData
ROOM_NAMEstr			Logic::_roomName
VERB_NAMEstr			Logic::_verbName
WALK_OFF_DATA			Logic::_walkOffData
WALK_OFF_MAX			Logic::_numWalkOffs


PERSONS
=======
ALLOCATE_PERSON				Logic::personAllocate
SET_PERSON_DATA				Logic::personSetData
SETUP_PERSON				Logic::personSetup
OBJ_PERSON					Logic::objectForPerson
-
PERSON_FRAMES				Logic::_personFrames
P_ANIMstr					Person.anim
P_BANK						Person.bankNum
P_NAMEstr					Person.name
P_STAND,P_BNUM,P_ROOM		Person.actor->*
P_X,P_Y,P_COLOR				Person.actor->*


RESOURCE
========
tflen() 					Resource::fileSize
topen()						Resource::loadFile
tseek() 					*not needed*


SCREEN
======
changejoepal()
check_colors()
dynalum()					Graphics::dynalumUpdate
fadein()
fadeout()
palscroll()
putcharacter()				Graphics::displayChar
setpal()
-
FULLSCREEN					Graphics::_fullscreen
palette						Graphics::_paletteRoom
panelflag					Graphics::_panelFlag
tpal						Graphics::_paletteScreen


SOUND
=====
alter_current_volume()
playsong()
sfxbusy()
sfxplay()
-
bamflag
bamindex
SFXNAME						Graphics::_sfxName
tmpbamflag


TALK
====
MAKE_SPEAK_BOB
MOVE_SPEAK
SPEAK						Talk::?
SPEAK_SUB
talk						Talk::run
TALK_PROC


TEXTS
=====
blanktexts()				Graphics::textClear
drawtext()					Graphics::textDrawAll
Ink() 						Graphics::textCurrentColor
MIDDLE() 
text()						Graphics::textSet
textlen() 					Graphics::textWidth
-
textcol						Graphics::_curTextColor
texts						Graphics::_texts


WALK
====
CALC_PATH()					Walk::calcPath
CALC_WALK()					Walk::incWalkData
CALC_X()					Walk::calcC
CALC_Y()					Walk::calcC
CALCSCALE()					Area::calcScale
FACE_JOE()					Walk::joeFace
FIND_FREE_AREA				Walk::findFreeArea
FIND_NEWP()					Walk::findAreaPosition
FIND_OLDP()					Walk::findAreaPosition
MOVE_JOE()					Walk::joeMove
MOVE_OTHER()				Walk::personMove
-
AREALIST					Walk::_areaList
AREASTRIKE					Walk::_areaStrike
movdata						Walk::_moveData
WALK_DATA					Walk::_walkData
WALKI						Walk::_walkDataCount


ZONES
=====
ClearZones()				Logic::zoneClearAll
SETUP_PANEL_ZONES()			Logic::zoneSetupPanel
SETUP_ZONES()				Logic::zoneSetup
SetZone()					Logic::zoneSet
zone()						Logic::zoneIn / Logic::zoneInArea
-
zones						Logic::_zones


(UNSORTED)
==========
game_save()
game_load()
R_MAP()
check_cut_quit()
CLEAR_COMMAND()
EXECUTE_ACTION()
CHECK_PLAYER()
SETUP_VARS()
ALTER_STATE()
ALTER_DEFAULT()
REDISP_OBJECT()		
SETUP_SCREENS()
GRAB_DIR()
GRAB_JOE()
int prompt_do()
SETUP_HERO()				Logic::joeSetupInRoom
find_cd_cut()
find_cd_desc()
menutext()
OPEN_CLOSE_OTHER()
CREATE_ANIM()				Logic::animCreate
-
VersionStr					Logic::language (add more functions if needed)
Gstr
PERstr
TALKstr
Pstr
Kstr
SANIMstr
WORDstr
TEMPstr
COMMANDstr
bank9
OBJECT_DESCRstr
PERSON2str
JOE2str
PKEYstr
JOEKEYstr
SUBJ1,SUBJ2,
TALK_SELECTED
JOEH,
NEWDEF,
NEWA,
MAPC,M,A,XD,YD,RES,
PSY,PSX,CSX,DX1,DX2,DY1,DY2,CCF,CSY,PCF,FRAME,
AM,WX,WY,Y1,
A2,PX,PY,OLDP,NEWP,LD,F1,F2,F3,F4,F5,F6,F7,F8,JDIR,DIFF,
SFXTOGGLE,VOICETOGGLE,MUSICTOGGLE,TEXTTOGGLE
DESC2,DESC,
SUBJECT,
OBJMAXv,
KEYVERB,
OBJ_DESC_DATA,
PERSON_DATA,
PERSON_OBJ,OBJ_CUT,OBJ_ANIM,CUTJOEF,CUTQUIT,
FS,FE,FACE,TY,DY,BS,DS,
TEMPA,
I2,
OLDVERB,VERB,
OLDNOUN,NOUN,NOUN2,
PARSE,ACTION,ACTION2,CLEVEL,
OLDX,X,OLDY,Y,NEWP,
SFACTOR, // shrink factor, used to scale (down) the bobs
JOEWALK, // legal values = 0,1,2,3
ENTRY_OBJ,SFRAME,
EFRAME,SPEED,
BODY,BF,RF,AF,SCENE,
DEFCOMM,
TALKSPD,
VOLUME,CUTON,
N,V,
tx,ty,ds,bs,bx,by,dx,dy,SX,SY,F,IX,IY,X2,X1,IY,SFAC,FDIR,
OBJ,E,SF2,P_VALUE,P_GAMES,T,
OLDBANK,RET,OLDS,CH,GSET,OFFSET,
OLDG,COND,COM,TEMPI,CURRCOM,TA2,COMMAX,S2,S1,ITEM,TYPE,HEAD,C,
OLDLEVEL,BANK,FD,NAME,TL,TI,TS,WC,IMAGE,OWALK,LEVELMAX,JMAX,
LEVEL,BNUM,D,P,LI,R,FTOT,A1,A12,CURRBOB,
COMPANEL,
MKEY,
PERSON_FACE,
PERSON_FACE_MAX,FF,
TALKHEAD,TALKQUIT,OUTLINE,
CANTQUIT,
CURRSONG,
walkgameload
actiondata
key_commands
key_language
nopalscroll
in_journal
decbase
choice
no_check_keys
config_request
MouseButton
mouseflag
drawmouseflag

AREAMAXv		*no need to be global*
CURRY 			*no need to be global*
OMAX,OMAXA 		*no need to be global*