minetest/src/texture_override.h
Hugues Ross 5cf6318117
Refactor texture overrides and add new features (#9600)
* Refactor texture overrides, and add new features:

- Texture overrides can support multiple targets in one line
- Texture override files can have comment lines
- Item images/wield images can be overridden

* Formatting changes

* Address soime feedback

- Pass vectors by const reference
- Log syntax errors as warnings
- Remove 'C' prefix from TextureOverrideSource

* Simplify override target checks with an inline helper function

* make linter happy

* Apply feedback suggestions

Co-Authored-By: rubenwardy <rw@rubenwardy.com>

* Remove remaining != 0 checks

* Update copyright notice

Co-authored-by: sfan5 <sfan5@live.de>
Co-authored-by: rubenwardy <rw@rubenwardy.com>
2020-04-14 20:41:29 +02:00

73 lines
1.9 KiB
C++

/*
Minetest
Copyright (C) 2020 Hugues Ross <hugues.ross@gmail.com>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
You should have received a copy of the GNU Lesser 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.
*/
#pragma once
#include "irrlichttypes.h"
#include <string>
#include <vector>
//! Bitmask enum specifying what a texture override should apply to
enum class OverrideTarget : u8
{
INVALID = 0,
TOP = 1 << 0,
BOTTOM = 1 << 1,
LEFT = 1 << 2,
RIGHT = 1 << 3,
FRONT = 1 << 4,
BACK = 1 << 5,
INVENTORY = 1 << 6,
WIELD = 1 << 7,
SIDES = LEFT | RIGHT | FRONT | BACK,
ALL_FACES = TOP | BOTTOM | SIDES,
ITEM_TARGETS = INVENTORY | WIELD,
};
struct TextureOverride
{
std::string id;
std::string texture;
u8 target;
// Helper function for checking if an OverrideTarget is found in
// a TextureOverride without casting
inline bool hasTarget(OverrideTarget overrideTarget) const
{
return (target & static_cast<u8>(overrideTarget)) != 0;
}
};
//! Class that provides texture override information from a texture pack
class TextureOverrideSource
{
public:
TextureOverrideSource(std::string filepath);
//! Get all overrides that apply to item definitions
std::vector<TextureOverride> getItemTextureOverrides();
//! Get all overrides that apply to node definitions
std::vector<TextureOverride> getNodeTileOverrides();
private:
std::vector<TextureOverride> m_overrides;
};