scummvm/engines/dm/timeline.h
2016-09-20 22:26:00 +02:00

205 lines
10 KiB
C++

/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
/*
* Based on the Reverse Engineering work of Christophe Fontanel,
* maintainer of the Dungeon Master Encyclopaedia (http://dmweb.free.fr/)
*/
#ifndef DM_TIMELINE_H
#define DM_TIMELINE_H
#include "dm/dm.h"
namespace DM {
class Champion;
class Sensor;
/* Event types */
enum TimelineEventType {
/* Used when a creature in a group was damaged or killed by a Poison Cloud or by a closing door or if Lord Chaos is surrounded by = 3, Fluxcages */
kDMEventTypeCreateReactionDangerOnSquare = -3, // @ CM3_EVENT_CREATE_REACTION_EVENT_29_DANGER_ON_SQUARE
/* Used when a projectile impacts with a creature in a group */
kDMEventTypeCreateReactionHitByProjectile = -2, // @ CM2_EVENT_CREATE_REACTION_EVENT_30_HIT_BY_PROJECTILE
/* Used when the party bumps into a group or performs a melee attack */
kDMEventTypeCreateReactionPartyIsAdjacent = -1, // @ CM1_EVENT_CREATE_REACTION_EVENT_31_PARTY_IS_ADJACENT
kDMEventTypeNone = 0, // @ C00_EVENT_NONE
kDMEventTypeDoorAnimation = 1, // @ C01_EVENT_DOOR_ANIMATION
kDMEventTypeDoorDestruction = 2, // @ C02_EVENT_DOOR_DESTRUCTION
kDMEventTypeCorridor = 5, // @ C05_EVENT_CORRIDOR
kDMEventTypeWall = 6, // @ C06_EVENT_WALL
kDMEventTypeFakeWall = 7, // @ C07_EVENT_FAKEWALL
kDMEventTypeTeleporter = 8, // @ C08_EVENT_TELEPORTER
kDMEventTypePit = 9, // @ C09_EVENT_PIT
kDMEventTypeDoor = 10, // @ C10_EVENT_DOOR
kDMEventTypeEnableChampionAction = 11, // @ C11_EVENT_ENABLE_CHAMPION_ACTION
kDMEventTypeHideDamageReceived = 12, // @ C12_EVENT_HIDE_DAMAGE_RECEIVED
kDMEventTypeViAltarRebirth = 13, // @ C13_EVENT_VI_ALTAR_REBIRTH
kDMEventTypePlaySound = 20, // @ C20_EVENT_PLAY_SOUND
kDMEventTypeCPSE = 22, // @ C22_EVENT_CPSE
kDMEventTypeRemoveFluxcage = 24, // @ C24_EVENT_REMOVE_FLUXCAGE
kDMEventTypeExplosion = 25, // @ C25_EVENT_EXPLOSION
kDMEventTypeGroupReactionDangerOnSquare = 29, // @ C29_EVENT_GROUP_REACTION_DANGER_ON_SQUARE
kDMEventTypeGroupReacionHitByProjectile = 30, // @ C30_EVENT_GROUP_REACTION_HIT_BY_PROJECTILE
kDMEventTypeGroupReactionPartyIsAdjecent = 31, // @ C31_EVENT_GROUP_REACTION_PARTY_IS_ADJACENT
kDMEventTypeUpdateAspectGroup = 32, // @ C32_EVENT_UPDATE_ASPECT_GROUP
/* Events = 33,-36 and = 38,-41 are used for individual creatures only while the group is attacking the party */
kDMEventTypeUpdateAspectCreature0 = 33, // @ C33_EVENT_UPDATE_ASPECT_CREATURE_0
kDMEventTypeUpdateAspectCreature1 = 34, // @ C34_EVENT_UPDATE_ASPECT_CREATURE_1
kDMEventTypeUpdateAspectCreature2 = 35, // @ C35_EVENT_UPDATE_ASPECT_CREATURE_2
kDMEventTypeUpdateAspectCreature3 = 36, // @ C36_EVENT_UPDATE_ASPECT_CREATURE_3
kDMEventTypeUpdateBehaviourGroup = 37, // @ C37_EVENT_UPDATE_BEHAVIOR_GROUP
kDMEventTypeUpdateBehavior0 = 38, // @ C38_EVENT_UPDATE_BEHAVIOR_CREATURE_0
kDMEventTypeUpdateBehavior1 = 39, // @ C39_EVENT_UPDATE_BEHAVIOR_CREATURE_1
kDMEventTypeUpdateBehavior2 = 40, // @ C40_EVENT_UPDATE_BEHAVIOR_CREATURE_2
kDMEventTypeUpdateBehavior3 = 41, // @ C41_EVENT_UPDATE_BEHAVIOR_CREATURE_3
/* Projectiles created by a champion (by casting a spell, shooting a weapon or throwing an object) or by a creature (by casting a spell) ignore impacts during their first movement otherwise an impact would always occur immediately as these projectiles are created on the champion or creature square */
kDMEventTypeMoveProjectileIgnoreImpacts = 48, // @ C48_EVENT_MOVE_PROJECTILE_IGNORE_IMPACTS
/* Projectiles created by projectile launcher sensors never ignore impacts as well as all other projectiles after their first movement */
kDMEventTypeMoveProjectile = 49, // @ C49_EVENT_MOVE_PROJECTILE
kDMEventTypeWatchdoge = 53, // @ C53_EVENT_WATCHDOG
kDMEventTypeMoveGroupSilent = 60, // @ C60_EVENT_MOVE_GROUP_SILENT
kDMEventTypeMoveGroupAudible = 61, // @ C61_EVENT_MOVE_GROUP_AUDIBLE
kDMEventTypeEnableGroupGenerator = 65, // @ C65_EVENT_ENABLE_GROUP_GENERATOR
kDMEventTypeLight = 70, // @ C70_EVENT_LIGHT
kDMEventTypeInvisibility = 71, // @ C71_EVENT_INVISIBILITY
kDMEventTypeChampionShield = 72, // @ C72_EVENT_CHAMPION_SHIELD
kDMEventTypeThievesEye = 73, // @ C73_EVENT_THIEVES_EYE
kDMEventTypePartyShield = 74, // @ C74_EVENT_PARTY_SHIELD
kDMEventTypePoisonChampion = 75, // @ C75_EVENT_POISON_CHAMPION
kDMEventTypeSpellShield = 77, // @ C77_EVENT_SPELLSHIELD
kDMEventTypeFireShield = 78, // @ C78_EVENT_FIRESHIELD
kDMEventTypeFootprints = 79, // @ C79_EVENT_FOOTPRINTS
kDMEventTypeMagicMap0 = 80, // @ C80_EVENT_MAGIC_MAP
kDMEventTypeMagicMap1 = 81, // @ C81_EVENT_MAGIC_MAP
kDMEventTypeMagicMap2 = 82, // @ C82_EVENT_MAGIC_MAP
kDMEventTypeMagicMap3 = 83 // @ C83_EVENT_MAGIC_MAP
};
#define kDMMaskGeneratedCreatureCount 0x0007 // @ MASK0x0007_GENERATED_CREATURE_COUNT
#define kDMMaskRandomizeGeneratedCreatureCount 0x0008 // @ MASK0x0008_RANDOMIZE_GENERATED_CREATURE_COUNT
class TimelineEvent {
public:
int32 _mapTime;
TimelineEventType _type;
byte _priority; // CHECKME: byte? or int16? Inconsistency in the code
uint16 getTypePriority() { return (_type << 8) + _priority; }
union B_unionTimelineEvent {
struct {
byte _mapX;
byte _mapY;
} _location;
int16 _attack;
int16 _defense;
int16 _lightPower;
uint16 _slot; // Thing
int16 _slotOrdinal;
};
B_unionTimelineEvent _Bu;
int16 getMapXY() { return (_Bu._location._mapX << 8) + _Bu._location._mapY; }
union C_uionTimelineEvent {
struct {
byte _cell;
byte _effect;
} A;
class {
uint16 _backing;
public:
uint16 getMapX() { return _backing & 0x1F; }
uint16 getMapY() { return (_backing >> 5) & 0x1F; }
Direction getDir() { return (Direction)((_backing >> 10) & 0x3); }
uint16 getStepEnergy() { return (_backing >> 12) & 0xF; }
void setMapX(uint16 val) { _backing = (_backing & ~0x1F) | (val & 0x1F); }
void setMapY(uint16 val) { _backing = (_backing & ~(0x1F << 5)) | ((val & 0x1F) << 5); }
void setDir(Direction val) { _backing = (_backing & ~(0x3 << 10)) | ((val & 0x3) << 10); }
void setStepEnergy(uint16 val) { _backing = (_backing & ~(0xF << 12)) | ((val & 0xF) << 12); }
} _projectile;
uint16 _slot;
int16 _soundIndex;
byte _ticks;
};
C_uionTimelineEvent _Cu;
}; // @ EVENT
class Timeline {
DMEngine *_vm;
public:
uint16 _eventMaxCount; // @ G0369_ui_EventMaximumCount
TimelineEvent *_events; // @ G0370_ps_Events
uint16 _eventCount; // @ G0372_ui_EventCount
uint16 *_timeline; // @ G0371_pui_Timeline
uint16 _firstUnusedEventIndex; // @ G0373_ui_FirstUnusedEventIndex
explicit Timeline(DMEngine *vm);
~Timeline();
void initTimeline(); // @ F0233_TIMELINE_Initialize
void deleteEvent(uint16 eventIndex);// @ F0237_TIMELINE_DeleteEvent
void fixChronology(uint16 timelineIndex); // @ F0236_TIMELINE_FixChronology
bool isEventABeforeB(TimelineEvent *eventA, TimelineEvent *eventB); // @ F0234_TIMELINE_IsEventABeforeEventB
uint16 getIndex(uint16 eventIndex); // @ F0235_TIMELINE_GetIndex
uint16 addEventGetEventIndex(TimelineEvent *event); // @ F0238_TIMELINE_AddEvent_GetEventIndex_CPSE
void processTimeline(); // @ F0261_TIMELINE_Process_CPSEF
bool isFirstEventExpiered(); // @ F0240_TIMELINE_IsFirstEventExpired_CPSE
void extractFirstEvent(TimelineEvent *event); // @ F0239_TIMELINE_ExtractFirstEvent
void processEventDoorAnimation(TimelineEvent *event); // @ F0241_TIMELINE_ProcessEvent1_DoorAnimation
void processEventSquareFakewall(TimelineEvent *event); // @ F0242_TIMELINE_ProcessEvent7_Square_FakeWall
void processEventDoorDestruction(TimelineEvent *event); // @ F0243_TIMELINE_ProcessEvent2_DoorDestruction
void processEventSquareDoor(TimelineEvent *event); // @ F0244_TIMELINE_ProcessEvent10_Square_Door
void processEventSquarePit(TimelineEvent *event); // @ F0251_TIMELINE_ProcessEvent9_Square_Pit
void moveTeleporterOrPitSquareThings(uint16 mapX, uint16 mapY); // @ F0249_TIMELINE_MoveTeleporterOrPitSquareThings
void processEventSquareTeleporter(TimelineEvent *event); // @ F0250_TIMELINE_ProcessEvent8_Square_Teleporter
void processEventSquareWall(TimelineEvent *event); // @ F0248_TIMELINE_ProcessEvent6_Square_Wall
void triggerProjectileLauncher(Sensor *sensor, TimelineEvent *event); // @ F0247_TIMELINE_TriggerProjectileLauncher
void processEventSquareCorridor(TimelineEvent *event); // @ F0245_TIMELINE_ProcessEvent5_Square_Corridor
void processEventsMoveGroup(TimelineEvent *event); // @ F0252_TIMELINE_ProcessEvents60to61_MoveGroup
void procesEventEnableGroupGenerator(TimelineEvent *event); // @ F0246_TIMELINE_ProcessEvent65_EnableGroupGenerator
void processEventEnableChampionAction(uint16 champIndex); // @ F0253_TIMELINE_ProcessEvent11Part1_EnableChampionAction
void processEventMoveWeaponFromQuiverToSlot(uint16 champIndex, uint16 slotIndex);// @ F0259_TIMELINE_ProcessEvent11Part2_MoveWeaponFromQuiverToSlot
bool hasWeaponMovedSlot(int16 champIndex, Champion *champ,
uint16 sourceSlotIndex, int16 destSlotIndex); // @ F0258_TIMELINE_HasWeaponMovedToSlot
void processEventHideDamageReceived(uint16 champIndex); // @ F0254_TIMELINE_ProcessEvent12_HideDamageReceived
void processEventLight(TimelineEvent *event); // @ F0257_TIMELINE_ProcessEvent70_Light
void refreshAllChampionStatusBoxes(); // @ F0260_TIMELINE_RefreshAllChampionStatusBoxes
void processEventViAltarRebirth(TimelineEvent *event); // @ F0255_TIMELINE_ProcessEvent13_ViAltarRebirth
void saveEventsPart(Common::OutSaveFile *file);
void saveTimelinePart(Common::OutSaveFile *file);
void loadEventsPart(Common::InSaveFile *file);
void loadTimelinePart(Common::InSaveFile *file);
signed char _actionDefense[44]; // @ G0495_ac_Graphic560_ActionDefense
void initConstants();
};
}
#endif