scummvm/engines/stark/resources/speech.h
2021-12-26 21:19:38 +01:00

106 lines
2.8 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 3 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, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef STARK_RESOURCES_SPEECH_H
#define STARK_RESOURCES_SPEECH_H
#include "common/str.h"
#include "engines/stark/resources/object.h"
namespace Stark {
namespace Formats {
class XRCReadStream;
}
namespace Resources {
class ItemVisual;
class LipSync;
class Sound;
/**
* Speech resource
*
* Speech resources are used to define dialog lines.
* A Speech resource contains text for a character and references
* a Sound resource for the dubbing.
*/
class Speech : public Object {
public:
static const Type::ResourceType TYPE = Type::kSpeech;
Speech(Object *parent, byte subType, uint16 index, const Common::String &name);
virtual ~Speech();
// Resource API
void readData(Formats::XRCReadStream *stream) override;
void onGameLoop() override;
void onExitLocation() override;
void onPreDestroy() override;
void saveLoadCurrent(ResourceSerializer *serializer) override;
/** Obtain the text associated to the speech line */
Common::String getPhrase() const;
/** Play the voice over */
void playSound();
/** Return true if the speech is playing */
bool isPlaying();
/** Stop the speech if it is playing */
void stop();
/** Is the character saying the line April ? */
bool characterIsApril() const;
/** Should the character change to the talk anim while this is playing? */
void setPlayTalkAnim(bool playTalkAnim);
/** Get the character's id - index in the KnowledgeSet */
int32 getCharacterId();
protected:
void printData() override;
void setCharacterTalkAnim();
void removeCharacterTalkAnim() const;
ItemVisual *getCharacterItem() const;
void stopOtherSpeechesFromSameCharacter();
int32 getPauseAfterSpeechDuration() const;
Common::String _phrase;
int32 _character;
bool _playTalkAnim;
bool _removeTalkAnimWhenComplete;
Sound *_soundResource;
LipSync *_lipSync;
int32 _waitTimeRemaining;
};
} // End of namespace Resources
} // End of namespace Stark
#endif // STARK_RESOURCES_SPEECH_H