(svn r24693) -Doc: Add some doxymentation into the newgrf code.

This commit is contained in:
alberth
2012-11-10 20:46:39 +00:00
parent 4c9bea2a71
commit 33ff55a8f1
24 changed files with 276 additions and 49 deletions

View File

@@ -22,12 +22,13 @@
#include "newgrf_spritegroup.h"
#include "newgrf_town.h"
/** Scope resolver for stations. */
struct StationScopeResolver : public ScopeResolver {
TileIndex tile;
struct BaseStation *st;
const struct StationSpec *statspec;
CargoID cargo_type;
Axis axis; ///< Station axis, used only for the slope check callback.
TileIndex tile; ///< %Tile of the station.
struct BaseStation *st; ///< Instance of the station.
const struct StationSpec *statspec; ///< Station (type) specification.
CargoID cargo_type; ///< Type of cargo of the station.
Axis axis; ///< Station axis, used only for the slope check callback.
StationScopeResolver(ResolverObject *ro, const StationSpec *statspec, BaseStation *st, TileIndex tile);
@@ -38,9 +39,10 @@ struct StationScopeResolver : public ScopeResolver {
/* virtual */ uint32 GetVariable(byte variable, uint32 parameter, bool *available) const;
};
/** Station resolver. */
struct StationResolverObject : public ResolverObject {
StationScopeResolver station_scope;
TownScopeResolver *town_scope;
StationScopeResolver station_scope; ///< The station scope resolver.
TownScopeResolver *town_scope; ///< The town scope resolver (created on the first call).
StationResolverObject(const StationSpec *statspec, BaseStation *st, TileIndex tile,
CallbackID callback = CBID_NO_CALLBACK, uint32 callback_param1 = 0, uint32 callback_param2 = 0);