diff options
author | alberth <alberth@openttd.org> | 2012-11-10 20:46:39 +0000 |
---|---|---|
committer | alberth <alberth@openttd.org> | 2012-11-10 20:46:39 +0000 |
commit | 33ff55a8f1287643986621e7130e8acddf42b221 (patch) | |
tree | 04af02a5ad82e979ec200570b38628dccc860cdf /src/newgrf_engine.cpp | |
parent | 4c9bea2a714da675217522c39113ba2c2c5bbee4 (diff) | |
download | openttd-33ff55a8f1287643986621e7130e8acddf42b221.tar.xz |
(svn r24693) -Doc: Add some doxymentation into the newgrf code.
Diffstat (limited to 'src/newgrf_engine.cpp')
-rw-r--r-- | src/newgrf_engine.cpp | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/src/newgrf_engine.cpp b/src/newgrf_engine.cpp index 6a286f81e..05300c22b 100644 --- a/src/newgrf_engine.cpp +++ b/src/newgrf_engine.cpp @@ -928,6 +928,13 @@ static uint32 VehicleGetVariable(Vehicle *v, const VehicleScopeResolver *object, return in_motion ? group->loaded[set] : group->loading[set]; } +/** + * Scope resolver of a single vehicle. + * @param ro Surrounding resolver. + * @param engine_type Engine type + * @param v %Vehicle being resolved. + * @param info_view Indicates if the item is being drawn in an info window. + */ VehicleScopeResolver::VehicleScopeResolver(ResolverObject *ro, EngineID engine_type, const Vehicle *v, bool info_view) : ScopeResolver(ro) { @@ -947,6 +954,15 @@ static const GRFFile *GetEngineGrfFile(EngineID engine_type) return (e != NULL) ? e->GetGRF() : NULL; } +/** + * Resolver of a vehicle (chain). + * @param engine_type Engine type + * @param v %Vehicle being resolved. + * @param info_view Indicates if the item is being drawn in an info window. + * @param callback Callback ID. + * @param callback_param1 First parameter (var 10) of the callback. + * @param callback_param2 Second parameter (var 18) of the callback. + */ VehicleResolverObject::VehicleResolverObject(EngineID engine_type, const Vehicle *v, bool info_view, CallbackID callback, uint32 callback_param1, uint32 callback_param2) : ResolverObject(GetEngineGrfFile(engine_type), callback, callback_param1, callback_param2), |