2007-03-23 20:55:45 +00:00
|
|
|
/* $Id$ */
|
|
|
|
|
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/>.
|
|
|
|
*/
|
|
|
|
|
2008-05-06 15:11:33 +00:00
|
|
|
/** @file newgrf_cargo.cpp Implementation of NewGRF cargoes. */
|
|
|
|
|
2007-03-23 20:55:45 +00:00
|
|
|
#include "stdafx.h"
|
2007-03-26 08:43:14 +00:00
|
|
|
#include "debug.h"
|
2007-03-23 20:55:45 +00:00
|
|
|
#include "newgrf_spritegroup.h"
|
|
|
|
|
2012-11-10 20:46:39 +00:00
|
|
|
/** Resolver of cargo. */
|
2012-11-10 20:39:39 +00:00
|
|
|
struct CargoResolverObject : public ResolverObject {
|
|
|
|
CargoResolverObject(const CargoSpec *cs, CallbackID callback = CBID_NO_CALLBACK, uint32 callback_param1 = 0, uint32 callback_param2 = 0);
|
2007-03-23 20:55:45 +00:00
|
|
|
|
2012-11-10 20:39:39 +00:00
|
|
|
/* virtual */ const SpriteGroup *ResolveReal(const RealSpriteGroup *group) const;
|
|
|
|
};
|
2007-03-23 20:55:45 +00:00
|
|
|
|
2012-11-10 20:39:39 +00:00
|
|
|
/* virtual */ const SpriteGroup *CargoResolverObject::ResolveReal(const RealSpriteGroup *group) const
|
2007-03-23 20:55:45 +00:00
|
|
|
{
|
2007-05-20 09:17:42 +00:00
|
|
|
/* Cargo action 2s should always have only 1 "loaded" state, but some
|
|
|
|
* times things don't follow the spec... */
|
2009-05-23 12:13:42 +00:00
|
|
|
if (group->num_loaded > 0) return group->loaded[0];
|
|
|
|
if (group->num_loading > 0) return group->loading[0];
|
2007-03-23 20:55:45 +00:00
|
|
|
|
2007-05-20 09:17:42 +00:00
|
|
|
return NULL;
|
2007-03-23 20:55:45 +00:00
|
|
|
}
|
|
|
|
|
2012-11-10 20:46:39 +00:00
|
|
|
/**
|
|
|
|
* Constructor of the cargo resolver.
|
|
|
|
* @param cs Cargo being resolved.
|
|
|
|
* @param callback Callback ID.
|
|
|
|
* @param callback_param1 First parameter (var 10) of the callback.
|
|
|
|
* @param callback_param2 Second parameter (var 18) of the callback.
|
|
|
|
*/
|
2012-11-10 20:39:39 +00:00
|
|
|
CargoResolverObject::CargoResolverObject(const CargoSpec *cs, CallbackID callback, uint32 callback_param1, uint32 callback_param2)
|
|
|
|
: ResolverObject(cs->grffile, callback, callback_param1, callback_param2)
|
2007-03-23 20:55:45 +00:00
|
|
|
{
|
|
|
|
}
|
|
|
|
|
2012-11-10 20:46:39 +00:00
|
|
|
/**
|
|
|
|
* Get the custom sprite for the given cargo type.
|
|
|
|
* @param cs Cargo being queried.
|
|
|
|
* @return Custom sprite to draw, or \c 0 if not available.
|
|
|
|
*/
|
2007-03-23 20:55:45 +00:00
|
|
|
SpriteID GetCustomCargoSprite(const CargoSpec *cs)
|
|
|
|
{
|
2012-11-10 20:39:39 +00:00
|
|
|
CargoResolverObject object(cs);
|
2013-11-24 14:41:19 +00:00
|
|
|
const SpriteGroup *group = SpriteGroup::Resolve(cs->group, object);
|
2009-05-23 12:13:42 +00:00
|
|
|
if (group == NULL) return 0;
|
2007-03-23 20:55:45 +00:00
|
|
|
|
2009-05-23 12:13:42 +00:00
|
|
|
return group->GetResult();
|
2007-03-23 20:55:45 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2007-07-25 19:06:29 +00:00
|
|
|
uint16 GetCargoCallback(CallbackID callback, uint32 param1, uint32 param2, const CargoSpec *cs)
|
2007-03-23 20:55:45 +00:00
|
|
|
{
|
2012-11-10 20:39:39 +00:00
|
|
|
CargoResolverObject object(cs, callback, param1, param2);
|
2013-11-24 14:41:19 +00:00
|
|
|
const SpriteGroup *group = SpriteGroup::Resolve(cs->group, object);
|
2009-05-23 12:13:42 +00:00
|
|
|
if (group == NULL) return CALLBACK_FAILED;
|
2007-03-23 20:55:45 +00:00
|
|
|
|
2009-05-23 12:13:42 +00:00
|
|
|
return group->GetCallbackResult();
|
2007-03-23 20:55:45 +00:00
|
|
|
}
|
2007-04-13 19:32:18 +00:00
|
|
|
|
2012-02-07 22:46:26 +00:00
|
|
|
/**
|
|
|
|
* Translate a GRF-local cargo slot/bitnum into a CargoID.
|
|
|
|
* @param cargo GRF-local cargo slot/bitnum.
|
|
|
|
* @param grffile Originating GRF file.
|
|
|
|
* @param usebit Defines the meaning of \a cargo for GRF version < 7.
|
|
|
|
* If true, then \a cargo is a bitnum. If false, then \a cargo is a cargoslot.
|
|
|
|
* For GRF version >= 7 \a cargo is always a translated cargo bit.
|
|
|
|
* @return CargoID or CT_INVALID if the cargo is not available.
|
|
|
|
*/
|
2007-10-13 02:23:11 +00:00
|
|
|
CargoID GetCargoTranslation(uint8 cargo, const GRFFile *grffile, bool usebit)
|
2007-04-13 19:32:18 +00:00
|
|
|
{
|
2012-02-08 18:11:49 +00:00
|
|
|
/* Pre-version 7 uses the 'climate dependent' ID in callbacks and properties, i.e. cargo is the cargo ID */
|
|
|
|
if (grffile->grf_version < 7 && !usebit) return cargo;
|
|
|
|
|
|
|
|
/* Other cases use (possibly translated) cargobits */
|
|
|
|
|
2012-05-25 20:57:36 +00:00
|
|
|
if (grffile->cargo_list.Length() > 0) {
|
2012-02-08 18:11:49 +00:00
|
|
|
/* ...and the cargo is in bounds, then get the cargo ID for
|
|
|
|
* the label */
|
2012-05-25 20:57:36 +00:00
|
|
|
if (cargo < grffile->cargo_list.Length()) return GetCargoIDByLabel(grffile->cargo_list[cargo]);
|
2012-02-08 18:11:49 +00:00
|
|
|
} else {
|
2007-10-13 02:23:11 +00:00
|
|
|
/* Else the cargo value is a 'climate independent' 'bitnum' */
|
2012-02-07 22:46:26 +00:00
|
|
|
return GetCargoIDByBitnum(cargo);
|
2007-10-13 02:23:11 +00:00
|
|
|
}
|
|
|
|
return CT_INVALID;
|
2007-04-13 19:32:18 +00:00
|
|
|
}
|