util.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos 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.
 *
 * xoreos 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 xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef ENGINES_AURORA_UTIL_H
#define ENGINES_AURORA_UTIL_H

#include "src/common/ustring.h"

#include "src/aurora/types.h"

#include "src/sound/types.h"

namespace Common {
    class SeekableReadStream;
}

namespace Aurora {
    class GFF3File;
}

namespace Engines {

void playVideo(const Common::UString &video);

Sound::ChannelHandle playSound(const Common::UString &sound, Sound::SoundType soundType,
        bool loop = false, float volume = 1.0f, bool pitchVariance = false);

void checkConfigInt   (const Common::UString &key, int    min, int    max);
void checkConfigDouble(const Common::UString &key, double min, double max);

bool longDelay(uint32 ms);

Aurora::GFF3File *loadOptionalGFF3(const Common::UString &gff3, Aurora::FileType type,
                                   uint32 id = 0xFFFFFFFF, bool repairNWNPremium = false);

Aurora::GFF4File *loadOptionalGFF4(const Common::UString &gff4, Aurora::FileType fileType,
                                   uint32 type = 0xFFFFFFFF);

bool dumpResList(const Common::UString &name);

bool dumpStream(Common::SeekableReadStream &stream, const Common::UString &fileName);
bool dumpResource(const Common::UString &name, Aurora::FileType type, const Common::UString &file = "");
bool dumpResource(const Common::UString &name, const Common::UString &file = "");

bool dumpTGA(const Common::UString &name, const Common::UString &file = "");

bool dump2DA(const Common::UString &name, const Common::UString &file = "");

} // End of namespace Engines

#endif // ENGINES_AURORA_UTIL_H