1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
/*
* This program 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; either version 2 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
#ifndef GENERATE_H
#define GENERATE_H
typedef struct GenerateFunctions GenerateFunctions;
#include "types.h"
#include "planets.h"
#include "libs/compiler.h"
#if defined(__cplusplus)
extern "C" {
#endif
/*
* To do (for further cleanups):
* - split off generateOrbital in a calculation and an activation
* (graphics and music) part.
* - make generateOrbital return a meaningful value, specifically, whether
* or not the player is going into orbit
* - for GenerateNameFunction, set the name in an argument, instead
* of in GLOBAL_SYS(PlanetName)
* - make generateName work for moons
* - add parameters to initNcs, reinitNpcs, and uninitNpcs, so that
* globals don't have to be used.
* - Add a reference from each world to the solar system, so that most
* of these functions can do with one less argument.
* - (maybe) don't directly call the generate functions via
* solarSys->genFuncs->..., but use a function for this, which first
* checks for solar system dependent handlers, and if this does not exist,
* or returns false, calls the default function.
*/
// Any of these functions returning true means that the action has been
// handled, and that the default function should not be called.
typedef bool (*InitNpcsFunction)(SOLARSYS_STATE *solarSys);
typedef bool (*ReinitNpcsFunction)(SOLARSYS_STATE *solarSys);
typedef bool (*UninitNpcsFunction)(SOLARSYS_STATE *solarSys);
typedef bool (*GeneratePlanetsFunction)(SOLARSYS_STATE *solarSys);
typedef bool (*GenerateMoonsFunction)(SOLARSYS_STATE *solarSys,
PLANET_DESC *planet);
typedef bool (*GenerateOrbitalFunction)(SOLARSYS_STATE *solarSys,
PLANET_DESC *world);
typedef bool (*GenerateNameFunction)(const SOLARSYS_STATE *,
const PLANET_DESC *world);
// The following functions return the number of objects being generated
// (or the index of the current object in some cases)
typedef COUNT (*GenerateMineralsFunction)(const SOLARSYS_STATE *,
const PLANET_DESC *world, COUNT whichNode, NODE_INFO *);
typedef COUNT (*GenerateEnergyFunction)(const SOLARSYS_STATE *,
const PLANET_DESC *world, COUNT whichNode, NODE_INFO *);
typedef COUNT (*GenerateLifeFunction)(const SOLARSYS_STATE *,
const PLANET_DESC *world, COUNT whichNode, NODE_INFO *);
// The following functions return true if the node should be removed
// from the surface, i.e. picked up.
typedef bool (*PickupMineralsFunction)(SOLARSYS_STATE *solarSys,
PLANET_DESC *world, COUNT whichNode);
typedef bool (*PickupEnergyFunction)(SOLARSYS_STATE *solarSys,
PLANET_DESC *world, COUNT whichNode);
typedef bool (*PickupLifeFunction)(SOLARSYS_STATE *solarSys,
PLANET_DESC *world, COUNT whichNode);
struct GenerateFunctions {
InitNpcsFunction initNpcs;
// Ships in the solar system, the first time it is accessed.
ReinitNpcsFunction reinitNpcs;
// Ships in the solar system, every next time it is accessed.
UninitNpcsFunction uninitNpcs;
// When leaving the solar system.
GeneratePlanetsFunction generatePlanets;
// Layout of planets within a solar system.
GenerateMoonsFunction generateMoons;
// Layout of moons around a planet.
GenerateNameFunction generateName;
// Name of a planet.
GenerateOrbitalFunction generateOrbital;
// Characteristics of words (planets and moons).
GenerateMineralsFunction generateMinerals;
// Minerals on the planet surface.
GenerateEnergyFunction generateEnergy;
// Energy sources on the planet surface.
GenerateLifeFunction generateLife;
// Bio on the planet surface.
PickupMineralsFunction pickupMinerals;
PickupEnergyFunction pickupEnergy;
PickupLifeFunction pickupLife;
};
#if defined(__cplusplus)
}
#endif
#endif /* GENERATE_H */
|