3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 #ifndef CRAFTDEF_HEADER
21 #define CRAFTDEF_HEADER
28 #include "inventory.h"
33 The crafting method depends on the inventory list
34 that the crafting input comes from.
40 // Cooking something in a furnace
42 // Using something as fuel for a furnace
47 The type a hash can be. The earlier a type is mentioned in this enum,
48 the earlier it is tried at crafting, and the less likely is a collision.
49 Changing order causes changes in behaviour, so know what you do.
53 // Hashes the normalized names of the recipe's elements.
54 // Only recipes without group usage can be found here,
55 // because groups can't be guessed efficiently.
56 CRAFT_HASH_TYPE_ITEM_NAMES,
58 // Counts the non-empty slots.
59 CRAFT_HASH_TYPE_COUNT,
61 // This layer both spares an extra variable, and helps to retain (albeit rarely used) functionality. Maps to 0.
62 // Before hashes are "initialized", all hashes reside here, after initialisation, none are.
63 CRAFT_HASH_TYPE_UNHASHED
66 const int craft_hash_type_max = (int) CRAFT_HASH_TYPE_UNHASHED;
69 Input: The contents of the crafting slots, arranged in matrix form
75 std::vector<ItemStack> items;
78 method(CRAFT_METHOD_NORMAL), width(0), items()
80 CraftInput(CraftMethod method_, unsigned int width_,
81 const std::vector<ItemStack> &items_):
82 method(method_), width(width_), items(items_)
84 std::string dump() const;
88 Output: Result of crafting operation
92 // Used for normal crafting and cooking, itemstring
94 // Used for cooking (cook time) and fuel (burn time), seconds
100 CraftOutput(std::string item_, float time_):
101 item(item_), time(time_)
103 std::string dump() const;
107 A list of replacements. A replacement indicates that a specific
108 input item should not be deleted (when crafting) but replaced with
109 a different item. Each replacements is a pair (itemstring to remove,
110 itemstring to replace with)
112 Example: If ("bucket:bucket_water", "bucket:bucket_empty") is a
113 replacement pair, the crafting input slot that contained a water
114 bucket will contain an empty bucket after crafting.
116 Note: replacements only work correctly when stack_max of the item
117 to be replaced is 1. It is up to the mod writer to ensure this.
119 struct CraftReplacements
121 // List of replacements
122 std::vector<std::pair<std::string, std::string> > pairs;
127 CraftReplacements(std::vector<std::pair<std::string, std::string> > pairs_):
130 std::string dump() const;
134 Crafting definition base class
136 class CraftDefinition
140 virtual ~CraftDefinition(){}
142 // Returns type of crafting definition
143 virtual std::string getName() const=0;
145 // Checks whether the recipe is applicable
146 virtual bool check(const CraftInput &input, IGameDef *gamedef) const=0;
147 // Returns the output structure, meaning depends on crafting method
148 // The implementation can assume that check(input) returns true
149 virtual CraftOutput getOutput(const CraftInput &input, IGameDef *gamedef) const=0;
150 // the inverse of the above
151 virtual CraftInput getInput(const CraftOutput &output, IGameDef *gamedef) const=0;
152 // Decreases count of every input item
153 virtual void decrementInput(CraftInput &input,
154 std::vector<ItemStack> &output_replacements, IGameDef *gamedef) const=0;
156 virtual CraftHashType getHashType() const = 0;
157 virtual u64 getHash(CraftHashType type) const = 0;
159 // to be called after all mods are loaded, so that we catch all aliases
160 virtual void initHash(IGameDef *gamedef) = 0;
162 virtual std::string dump() const=0;
166 A plain-jane (shaped) crafting definition
168 Supported crafting method: CRAFT_METHOD_NORMAL.
169 Requires the input items to be arranged exactly like in the recipe.
171 class CraftDefinitionShaped: public CraftDefinition
174 CraftDefinitionShaped():
175 output(""), width(1), recipe(), hash_inited(false), replacements()
177 CraftDefinitionShaped(
178 const std::string &output_,
180 const std::vector<std::string> &recipe_,
181 const CraftReplacements &replacements_):
182 output(output_), width(width_), recipe(recipe_),
183 hash_inited(false), replacements(replacements_)
185 virtual ~CraftDefinitionShaped(){}
187 virtual std::string getName() const;
188 virtual bool check(const CraftInput &input, IGameDef *gamedef) const;
189 virtual CraftOutput getOutput(const CraftInput &input, IGameDef *gamedef) const;
190 virtual CraftInput getInput(const CraftOutput &output, IGameDef *gamedef) const;
191 virtual void decrementInput(CraftInput &input,
192 std::vector<ItemStack> &output_replacements, IGameDef *gamedef) const;
194 virtual CraftHashType getHashType() const;
195 virtual u64 getHash(CraftHashType type) const;
197 virtual void initHash(IGameDef *gamedef);
199 virtual std::string dump() const;
206 // Recipe matrix (itemstrings)
207 std::vector<std::string> recipe;
208 // Recipe matrix (item names)
209 std::vector<std::string> recipe_names;
210 // bool indicating if initHash has been called already
212 // Replacement items for decrementInput()
213 CraftReplacements replacements;
217 A shapeless crafting definition
218 Supported crafting method: CRAFT_METHOD_NORMAL.
219 Input items can arranged in any way.
221 class CraftDefinitionShapeless: public CraftDefinition
224 CraftDefinitionShapeless():
225 output(""), recipe(), hash_inited(false), replacements()
227 CraftDefinitionShapeless(
228 const std::string &output_,
229 const std::vector<std::string> &recipe_,
230 const CraftReplacements &replacements_):
231 output(output_), recipe(recipe_),
232 hash_inited(false), replacements(replacements_)
234 virtual ~CraftDefinitionShapeless(){}
236 virtual std::string getName() const;
237 virtual bool check(const CraftInput &input, IGameDef *gamedef) const;
238 virtual CraftOutput getOutput(const CraftInput &input, IGameDef *gamedef) const;
239 virtual CraftInput getInput(const CraftOutput &output, IGameDef *gamedef) const;
240 virtual void decrementInput(CraftInput &input,
241 std::vector<ItemStack> &output_replacements, IGameDef *gamedef) const;
243 virtual CraftHashType getHashType() const;
244 virtual u64 getHash(CraftHashType type) const;
246 virtual void initHash(IGameDef *gamedef);
248 virtual std::string dump() const;
253 // Recipe list (itemstrings)
254 std::vector<std::string> recipe;
255 // Recipe list (item names)
256 std::vector<std::string> recipe_names;
257 // bool indicating if initHash has been called already
259 // Replacement items for decrementInput()
260 CraftReplacements replacements;
264 Tool repair crafting definition
265 Supported crafting method: CRAFT_METHOD_NORMAL.
266 Put two damaged tools into the crafting grid, get one tool back.
267 There should only be one crafting definition of this type.
269 class CraftDefinitionToolRepair: public CraftDefinition
272 CraftDefinitionToolRepair():
275 CraftDefinitionToolRepair(float additional_wear_):
276 additional_wear(additional_wear_)
278 virtual ~CraftDefinitionToolRepair(){}
280 virtual std::string getName() const;
281 virtual bool check(const CraftInput &input, IGameDef *gamedef) const;
282 virtual CraftOutput getOutput(const CraftInput &input, IGameDef *gamedef) const;
283 virtual CraftInput getInput(const CraftOutput &output, IGameDef *gamedef) const;
284 virtual void decrementInput(CraftInput &input,
285 std::vector<ItemStack> &output_replacements, IGameDef *gamedef) const;
287 virtual CraftHashType getHashType() const { return CRAFT_HASH_TYPE_COUNT; }
288 virtual u64 getHash(CraftHashType type) const { return 2; }
290 virtual void initHash(IGameDef *gamedef) {}
292 virtual std::string dump() const;
295 // This is a constant that is added to the wear of the result.
296 // May be positive or negative, allowed range [-1,1].
297 // 1 = new tool is completely broken
298 // 0 = simply add remaining uses of both input tools
299 // -1 = new tool is completely pristine
300 float additional_wear;
304 A cooking (in furnace) definition
305 Supported crafting method: CRAFT_METHOD_COOKING.
307 class CraftDefinitionCooking: public CraftDefinition
310 CraftDefinitionCooking():
311 output(""), recipe(""), hash_inited(false), cooktime()
313 CraftDefinitionCooking(
314 const std::string &output_,
315 const std::string &recipe_,
317 const CraftReplacements &replacements_):
318 output(output_), recipe(recipe_), hash_inited(false),
319 cooktime(cooktime_), replacements(replacements_)
321 virtual ~CraftDefinitionCooking(){}
323 virtual std::string getName() const;
324 virtual bool check(const CraftInput &input, IGameDef *gamedef) const;
325 virtual CraftOutput getOutput(const CraftInput &input, IGameDef *gamedef) const;
326 virtual CraftInput getInput(const CraftOutput &output, IGameDef *gamedef) const;
327 virtual void decrementInput(CraftInput &input,
328 std::vector<ItemStack> &output_replacements, IGameDef *gamedef) const;
330 virtual CraftHashType getHashType() const;
331 virtual u64 getHash(CraftHashType type) const;
333 virtual void initHash(IGameDef *gamedef);
335 virtual std::string dump() const;
343 std::string recipe_name;
344 // bool indicating if initHash has been called already
348 // Replacement items for decrementInput()
349 CraftReplacements replacements;
353 A fuel (for furnace) definition
354 Supported crafting method: CRAFT_METHOD_FUEL.
356 class CraftDefinitionFuel: public CraftDefinition
359 CraftDefinitionFuel():
360 recipe(""), hash_inited(false), burntime()
362 CraftDefinitionFuel(std::string recipe_,
364 const CraftReplacements &replacements_):
365 recipe(recipe_), hash_inited(false), burntime(burntime_), replacements(replacements_)
367 virtual ~CraftDefinitionFuel(){}
369 virtual std::string getName() const;
370 virtual bool check(const CraftInput &input, IGameDef *gamedef) const;
371 virtual CraftOutput getOutput(const CraftInput &input, IGameDef *gamedef) const;
372 virtual CraftInput getInput(const CraftOutput &output, IGameDef *gamedef) const;
373 virtual void decrementInput(CraftInput &input,
374 std::vector<ItemStack> &output_replacements, IGameDef *gamedef) const;
376 virtual CraftHashType getHashType() const;
377 virtual u64 getHash(CraftHashType type) const;
379 virtual void initHash(IGameDef *gamedef);
381 virtual std::string dump() const;
387 std::string recipe_name;
388 // bool indicating if initHash has been called already
392 // Replacement items for decrementInput()
393 CraftReplacements replacements;
397 Crafting definition manager
399 class ICraftDefManager
403 virtual ~ICraftDefManager(){}
405 // The main crafting function
406 virtual bool getCraftResult(CraftInput &input, CraftOutput &output,
407 std::vector<ItemStack> &output_replacements,
408 bool decrementInput, IGameDef *gamedef) const=0;
409 virtual std::vector<CraftDefinition*> getCraftRecipes(CraftOutput &output,
410 IGameDef *gamedef, unsigned limit=0) const=0;
412 // Print crafting recipes for debugging
413 virtual std::string dump() const=0;
416 class IWritableCraftDefManager : public ICraftDefManager
419 IWritableCraftDefManager(){}
420 virtual ~IWritableCraftDefManager(){}
422 // The main crafting function
423 virtual bool getCraftResult(CraftInput &input, CraftOutput &output,
424 std::vector<ItemStack> &output_replacements,
425 bool decrementInput, IGameDef *gamedef) const=0;
426 virtual std::vector<CraftDefinition*> getCraftRecipes(CraftOutput &output,
427 IGameDef *gamedef, unsigned limit=0) const=0;
429 // Print crafting recipes for debugging
430 virtual std::string dump() const=0;
432 // Add a crafting definition.
433 // After calling this, the pointer belongs to the manager.
434 virtual void registerCraft(CraftDefinition *def, IGameDef *gamedef) = 0;
436 // Delete all crafting definitions
437 virtual void clear()=0;
439 // To be called after all mods are loaded, so that we catch all aliases
440 virtual void initHashes(IGameDef *gamedef) = 0;
443 IWritableCraftDefManager* createCraftDefManager();