OpenTTD-patches/src/newgrf_cargo.h

/* $Id$ */

/*
 * This file is part of OpenTTD.
 * OpenTTD 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, version 2.
 * OpenTTD 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 OpenTTD. If not, see <http://www.gnu.org/licenses/>.
 */

/** @file newgrf_cargo.h Cargo support for NewGRFs. */

#ifndef NEWGRF_CARGO_H
#define NEWGRF_CARGO_H

#include "newgrf_callbacks.h"
#include "cargo_type.h"
#include "gfx_type.h"

static const CargoID CT_DEFAULT      = NUM_CARGO + 0;
static const CargoID CT_PURCHASE     = NUM_CARGO + 1;
static const CargoID CT_DEFAULT_NA   = NUM_CARGO + 2;

/* Forward declarations of structs used */
struct CargoSpec;
struct GRFFile;

SpriteID GetCustomCargoSprite(const CargoSpec *cs);
uint16 GetCargoCallback(CallbackID callback, uint32 param1, uint32 param2, const CargoSpec *cs);
CargoID GetCargoTranslation(uint8 cargo, const GRFFile *grffile, bool usebit = false);
uint8 GetReverseCargoTranslation(CargoID cargo, const GRFFile *grffile);

#endif /* NEWGRF_CARGO_H */
(svn r4902) Newgrf : Introduction of the newgrf_cargo files. Clearing engine and newgrf_engine from cargo related structures. Apart from moving stuff cargo related, there is nothing really newcargo for now. 2006-05-18 02:43:23 +00:00			`/* $Id$ */`

(svn r17248) -Fix: add GPL license notice where appropriate 2009-08-21 20:21:05 +00:00			`/*`
			`* This file is part of OpenTTD.`
			`* OpenTTD 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, version 2.`
			`* OpenTTD 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 OpenTTD. If not, see <http://www.gnu.org/licenses/>.`
			`*/`

(svn r12971) -Documentation: add @file in files that missed them and add something more than whitespace as description of files that don't have a description. 2008-05-06 15:11:33 +00:00			`/** @file newgrf_cargo.h Cargo support for NewGRFs. */`
(svn r9385) -Cleanup: doxygen changes. Today, we are exploring the letter N. 2007-03-21 03:06:21 +00:00
(svn r4902) Newgrf : Introduction of the newgrf_cargo files. Clearing engine and newgrf_engine from cargo related structures. Apart from moving stuff cargo related, there is nothing really newcargo for now. 2006-05-18 02:43:23 +00:00			`#ifndef NEWGRF_CARGO_H`
			`#define NEWGRF_CARGO_H`

(svn r10690) -Codechange: use the enum that describes all callback IDs in favor of "just" using an untyped integer. 2007-07-25 19:06:29 +00:00			`#include "newgrf_callbacks.h"`
(svn r11680) -Codechange: refactor more out of openttd.h and functions.h. 2007-12-21 22:50:51 +00:00			`#include "cargo_type.h"`
(svn r11828) -Codechange: include table/* as the last includes and remove an unneeded include from openttd.h. 2008-01-13 01:21:35 +00:00			`#include "gfx_type.h"`
(svn r10690) -Codechange: use the enum that describes all callback IDs in favor of "just" using an untyped integer. 2007-07-25 19:06:29 +00:00
(svn r8891) -Codechange: Remove remains of global cargo scheme. All cargo mapping is now dealt with only in NewGRF code, on load where possible. 2007-02-24 23:36:40 +00:00			`static const CargoID CT_DEFAULT = NUM_CARGO + 0;`
			`static const CargoID CT_PURCHASE = NUM_CARGO + 1;`
			`static const CargoID CT_DEFAULT_NA = NUM_CARGO + 2;`
(svn r4902) Newgrf : Introduction of the newgrf_cargo files. Clearing engine and newgrf_engine from cargo related structures. Apart from moving stuff cargo related, there is nothing really newcargo for now. 2006-05-18 02:43:23 +00:00
(svn r9620) -Codechange: apply cargo translation table to newstation variables 0x60..0x65 2007-04-13 19:32:18 +00:00			`/* Forward declarations of structs used */`
(svn r9434) -Fix (r9418): remove typedef from forward declaration to appease MSVC or something 2007-03-24 16:09:39 +00:00			`struct CargoSpec;`
(svn r9620) -Codechange: apply cargo translation table to newstation variables 0x60..0x65 2007-04-13 19:32:18 +00:00			`struct GRFFile;`
(svn r9418) -Codechange: Implement actions 1/2/3 for cargos, callback handler and custom icon sprites 2007-03-23 20:55:45 +00:00
			`SpriteID GetCustomCargoSprite(const CargoSpec *cs);`
(svn r10690) -Codechange: use the enum that describes all callback IDs in favor of "just" using an untyped integer. 2007-07-25 19:06:29 +00:00			`uint16 GetCargoCallback(CallbackID callback, uint32 param1, uint32 param2, const CargoSpec *cs);`
(svn r11252) -Revert r11239, Fix r9620: cargo translation was not done correctly 2007-10-13 02:23:11 +00:00			`CargoID GetCargoTranslation(uint8 cargo, const GRFFile *grffile, bool usebit = false);`
(svn r10477) -Codechange: add some callbacks to customise the acceptance of industries. 2007-07-08 17:40:04 +00:00			`uint8 GetReverseCargoTranslation(CargoID cargo, const GRFFile *grffile);`
(svn r9418) -Codechange: Implement actions 1/2/3 for cargos, callback handler and custom icon sprites 2007-03-23 20:55:45 +00:00
(svn r4902) Newgrf : Introduction of the newgrf_cargo files. Clearing engine and newgrf_engine from cargo related structures. Apart from moving stuff cargo related, there is nothing really newcargo for now. 2006-05-18 02:43:23 +00:00			`#endif /* NEWGRF_CARGO_H */`