src/newgrf_cargo.cpp
author truelight
Sat, 20 Oct 2007 10:42:28 +0000
branchnoai
changeset 9718 f82a4facea8b
parent 9694 e72987579514
child 8424 4a488a90ccab
permissions -rw-r--r--
(svn r11309) [NoAI] -Sync: with trunk r11145:11308.
9517
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
     1
/* $Id$ */
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
     2
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
     3
#include "stdafx.h"
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
     4
#include "openttd.h"
9566
9936b201d53f (svn r9505) [NoAI] -Sync with trunk r9468:9504
truelight
parents: 9517
diff changeset
     5
#include "debug.h"
9517
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
     6
#include "cargotype.h"
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
     7
#include "newgrf.h"
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
     8
#include "newgrf_callbacks.h"
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
     9
#include "newgrf_spritegroup.h"
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    10
#include "newgrf_cargo.h"
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    11
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    12
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    13
static uint32 CargoGetRandomBits(const ResolverObject *object)
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    14
{
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    15
	return 0;
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    16
}
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    17
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    18
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    19
static uint32 CargoGetTriggers(const ResolverObject *object)
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    20
{
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    21
	return 0;
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    22
}
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    23
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    24
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    25
static void CargoSetTriggers(const ResolverObject *object, int triggers)
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    26
{
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    27
	return;
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    28
}
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    29
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    30
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    31
static uint32 CargoGetVariable(const ResolverObject *object, byte variable, byte parameter, bool *available)
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    32
{
9566
9936b201d53f (svn r9505) [NoAI] -Sync with trunk r9468:9504
truelight
parents: 9517
diff changeset
    33
	DEBUG(grf, 1, "Unhandled cargo property 0x%X", variable);
9936b201d53f (svn r9505) [NoAI] -Sync with trunk r9468:9504
truelight
parents: 9517
diff changeset
    34
9517
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    35
	*available = false;
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    36
	return 0;
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    37
}
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    38
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    39
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    40
static const SpriteGroup *CargoResolveReal(const ResolverObject *object, const SpriteGroup *group)
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    41
{
9624
b71483f2330f (svn r9915) [NoAI] -Sync with trunk -r9815:9914
glx
parents: 9599
diff changeset
    42
	/* Cargo action 2s should always have only 1 "loaded" state, but some
b71483f2330f (svn r9915) [NoAI] -Sync with trunk -r9815:9914
glx
parents: 9599
diff changeset
    43
	 * times things don't follow the spec... */
b71483f2330f (svn r9915) [NoAI] -Sync with trunk -r9815:9914
glx
parents: 9599
diff changeset
    44
	if (group->g.real.num_loaded > 0) return group->g.real.loaded[0];
b71483f2330f (svn r9915) [NoAI] -Sync with trunk -r9815:9914
glx
parents: 9599
diff changeset
    45
	if (group->g.real.num_loading > 0) return group->g.real.loading[0];
9517
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    46
9624
b71483f2330f (svn r9915) [NoAI] -Sync with trunk -r9815:9914
glx
parents: 9599
diff changeset
    47
	return NULL;
9517
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    48
}
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    49
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    50
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    51
static void NewCargoResolver(ResolverObject *res, const CargoSpec *cs)
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    52
{
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    53
	res->GetRandomBits = &CargoGetRandomBits;
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    54
	res->GetTriggers   = &CargoGetTriggers;
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    55
	res->SetTriggers   = &CargoSetTriggers;
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    56
	res->GetVariable   = &CargoGetVariable;
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    57
	res->ResolveReal   = &CargoResolveReal;
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    58
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    59
	res->u.cargo.cs = cs;
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    60
9694
e72987579514 (svn r10775) [NoAI] -Sync: with trunk r10535:r10774.
rubidium
parents: 9641
diff changeset
    61
	res->callback        = CBID_NO_CALLBACK;
9517
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    62
	res->callback_param1 = 0;
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    63
	res->callback_param2 = 0;
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    64
	res->last_value      = 0;
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    65
	res->trigger         = 0;
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    66
	res->reseed          = 0;
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    67
}
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    68
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    69
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    70
SpriteID GetCustomCargoSprite(const CargoSpec *cs)
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    71
{
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    72
	const SpriteGroup *group;
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    73
	ResolverObject object;
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    74
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    75
	NewCargoResolver(&object, cs);
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    76
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    77
	group = Resolve(cs->group, &object);
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    78
	if (group == NULL || group->type != SGT_RESULT) return 0;
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    79
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    80
	return group->g.result.sprite;
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    81
}
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    82
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    83
9694
e72987579514 (svn r10775) [NoAI] -Sync: with trunk r10535:r10774.
rubidium
parents: 9641
diff changeset
    84
uint16 GetCargoCallback(CallbackID callback, uint32 param1, uint32 param2, const CargoSpec *cs)
9517
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    85
{
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    86
	ResolverObject object;
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    87
	const SpriteGroup *group;
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    88
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    89
	NewCargoResolver(&object, cs);
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    90
	object.callback = callback;
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    91
	object.callback_param1 = param1;
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    92
	object.callback_param2 = param2;
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    93
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    94
	group = Resolve(cs->group, &object);
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    95
	if (group == NULL || group->type != SGT_CALLBACK) return CALLBACK_FAILED;
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    96
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    97
	return group->g.callback.result;
be1775555bbd (svn r9431) [NoAI] -Sync with trunk r9394:9430
truelight
parents:
diff changeset
    98
}
9599
949374e83b78 (svn r9632) [NoAI] -Sync with trunk r9574:9631.
rubidium
parents: 9566
diff changeset
    99
949374e83b78 (svn r9632) [NoAI] -Sync with trunk r9574:9631.
rubidium
parents: 9566
diff changeset
   100
9718
f82a4facea8b (svn r11309) [NoAI] -Sync: with trunk r11145:11308.
truelight
parents: 9694
diff changeset
   101
CargoID GetCargoTranslation(uint8 cargo, const GRFFile *grffile, bool usebit)
9599
949374e83b78 (svn r9632) [NoAI] -Sync with trunk r9574:9631.
rubidium
parents: 9566
diff changeset
   102
{
949374e83b78 (svn r9632) [NoAI] -Sync with trunk r9574:9631.
rubidium
parents: 9566
diff changeset
   103
	/* Pre-version 7 uses the 'climate dependent' ID, i.e. cargo is the cargo ID */
9718
f82a4facea8b (svn r11309) [NoAI] -Sync: with trunk r11145:11308.
truelight
parents: 9694
diff changeset
   104
	if (grffile->grf_version < 7) {
f82a4facea8b (svn r11309) [NoAI] -Sync: with trunk r11145:11308.
truelight
parents: 9694
diff changeset
   105
		if (!usebit) return cargo;
f82a4facea8b (svn r11309) [NoAI] -Sync: with trunk r11145:11308.
truelight
parents: 9694
diff changeset
   106
		/* Else the cargo value is a 'climate independent' 'bitnum' */
f82a4facea8b (svn r11309) [NoAI] -Sync: with trunk r11145:11308.
truelight
parents: 9694
diff changeset
   107
		if (HASBIT(_cargo_mask, cargo)) return GetCargoIDByBitnum(cargo);
f82a4facea8b (svn r11309) [NoAI] -Sync: with trunk r11145:11308.
truelight
parents: 9694
diff changeset
   108
	} else {
f82a4facea8b (svn r11309) [NoAI] -Sync: with trunk r11145:11308.
truelight
parents: 9694
diff changeset
   109
		/* If the GRF contains a translation table (and the cargo is in bounds)
f82a4facea8b (svn r11309) [NoAI] -Sync: with trunk r11145:11308.
truelight
parents: 9694
diff changeset
   110
		 * then get the cargo ID for the label */
f82a4facea8b (svn r11309) [NoAI] -Sync: with trunk r11145:11308.
truelight
parents: 9694
diff changeset
   111
		if (cargo < grffile->cargo_max) return GetCargoIDByLabel(grffile->cargo_list[cargo]);
f82a4facea8b (svn r11309) [NoAI] -Sync: with trunk r11145:11308.
truelight
parents: 9694
diff changeset
   112
	}
f82a4facea8b (svn r11309) [NoAI] -Sync: with trunk r11145:11308.
truelight
parents: 9694
diff changeset
   113
	return CT_INVALID;
9599
949374e83b78 (svn r9632) [NoAI] -Sync with trunk r9574:9631.
rubidium
parents: 9566
diff changeset
   114
}
9641
855e32c08c9b (svn r10533) [NoAI] -Sync with trunk r10460:r10532.
truelight
parents: 9624
diff changeset
   115
855e32c08c9b (svn r10533) [NoAI] -Sync with trunk r10460:r10532.
truelight
parents: 9624
diff changeset
   116
uint8 GetReverseCargoTranslation(CargoID cargo, const GRFFile *grffile)
855e32c08c9b (svn r10533) [NoAI] -Sync with trunk r10460:r10532.
truelight
parents: 9624
diff changeset
   117
{
855e32c08c9b (svn r10533) [NoAI] -Sync with trunk r10460:r10532.
truelight
parents: 9624
diff changeset
   118
	/* Pre-version 7 uses the 'climate dependent' ID, i.e. cargo is the cargo ID */
855e32c08c9b (svn r10533) [NoAI] -Sync with trunk r10460:r10532.
truelight
parents: 9624
diff changeset
   119
	if (grffile->grf_version < 7) return cargo;
855e32c08c9b (svn r10533) [NoAI] -Sync with trunk r10460:r10532.
truelight
parents: 9624
diff changeset
   120
855e32c08c9b (svn r10533) [NoAI] -Sync with trunk r10460:r10532.
truelight
parents: 9624
diff changeset
   121
	const CargoSpec *cs = GetCargo(cargo);
855e32c08c9b (svn r10533) [NoAI] -Sync with trunk r10460:r10532.
truelight
parents: 9624
diff changeset
   122
855e32c08c9b (svn r10533) [NoAI] -Sync with trunk r10460:r10532.
truelight
parents: 9624
diff changeset
   123
	/* If the GRF contains a translation table (and the cargo is in the table)
855e32c08c9b (svn r10533) [NoAI] -Sync with trunk r10460:r10532.
truelight
parents: 9624
diff changeset
   124
	 * then get the cargo ID for the label */
855e32c08c9b (svn r10533) [NoAI] -Sync with trunk r10460:r10532.
truelight
parents: 9624
diff changeset
   125
	for (uint i = 0; i < grffile->cargo_max; i++) {
855e32c08c9b (svn r10533) [NoAI] -Sync with trunk r10460:r10532.
truelight
parents: 9624
diff changeset
   126
		if (cs->label == grffile->cargo_list[i]) return i;
855e32c08c9b (svn r10533) [NoAI] -Sync with trunk r10460:r10532.
truelight
parents: 9624
diff changeset
   127
	}
855e32c08c9b (svn r10533) [NoAI] -Sync with trunk r10460:r10532.
truelight
parents: 9624
diff changeset
   128
855e32c08c9b (svn r10533) [NoAI] -Sync with trunk r10460:r10532.
truelight
parents: 9624
diff changeset
   129
	/* No matching label was found, so we return the 'climate independent' 'bitnum' */
855e32c08c9b (svn r10533) [NoAI] -Sync with trunk r10460:r10532.
truelight
parents: 9624
diff changeset
   130
	return cs->bitnum;;
855e32c08c9b (svn r10533) [NoAI] -Sync with trunk r10460:r10532.
truelight
parents: 9624
diff changeset
   131
}