OpenTTD Source: RoadTypeResolverObject Struct Reference

OpenTTD Source 1.11.0-RC1

Public Member Functions | Data Fields
RoadTypeResolverObject Struct Reference

Resolver object for road types. More...

`#include <newgrf_roadtype.h>`

Inheritance diagram for RoadTypeResolverObject:

## Public Member Functions
| RoadTypeResolverObject (const RoadTypeInfo *rti, TileIndex tile, TileContext context, RoadTypeSpriteGroup rtsg, uint32 param1=0, uint32 param2=0)
| Resolver object for road types. More...
ScopeResolver * | GetScope (VarSpriteGroupScope scope=VSG_SCOPE_SELF, byte relative=0) override
| Get a resolver for the scope. More...
const SpriteGroup * | ResolveReal (const RealSpriteGroup *group) const override
| Get the real sprites of the grf. More...
GrfSpecFeature | GetFeature () const override
| Get the feature number being resolved for. More...
uint32 | GetDebugID () const override
| Get an identifier for the item being resolved. More...
Public Member Functions inherited from ResolverObject
| ResolverObject (const GRFFile *grffile, CallbackID callback=CBID_NO_CALLBACK, uint32 callback_param1=0, uint32 callback_param2=0)
| Resolver constructor. More...
const SpriteGroup * | Resolve ()
| Resolve SpriteGroup. More...
uint16 | ResolveCallback ()
| Resolve callback. More...
uint32 | GetRemainingTriggers () const
| Returns the waiting triggers that did not trigger any rerandomisation.
uint32 | GetReseedSum () const
| Returns the OR-sum of all bits that need reseeding independent of the scope they were accessed with. More...
void | ResetState ()
| Resets the dynamic state of the resolver object. More...

## Data Fields
RoadTypeScopeResolver | roadtype_scope
| Resolver for the roadtype scope.
Data Fields inherited from ResolverObject
ScopeResolver | default_scope
| Default implementation of the grf scope.
CallbackID | callback
| Callback being resolved.
uint32 | callback_param1
| First parameter (var 10) of the callback.
uint32 | callback_param2
| Second parameter (var 18) of the callback.
uint32 | last_value
| Result of most recent DeterministicSpriteGroup (including procedure calls)
uint32 | waiting_triggers
| Waiting triggers to be used by any rerandomisation. (scope independent)
uint32 | used_triggers
| Subset of cur_triggers, which actually triggered some rerandomisation. (scope independent)
uint32 | reseed [VSG_END]
| Collects bits to rerandomise while triggering triggers.
const GRFFile * | grffile
| GRFFile the resolved SpriteGroup belongs to.
const SpriteGroup * | root_spritegroup
| Root SpriteGroup to use for resolving.

## Detailed Description

Resolver object for road types.

Definition at line 30 of file newgrf_roadtype.h.

## Constructor & Destructor Documentation

## ◆ RoadTypeResolverObject()

RoadTypeResolverObject::RoadTypeResolverObject | ( | const RoadTypeInfo * | rti,
|  | TileIndex | tile,
|  | TileContext | context,
|  | RoadTypeSpriteGroup | rtsg,
|  | uint32 | param1 = `0`,
|  | uint32 | param2 = `0`
| ) |  |

Resolver object for road types.

Parameters

  rti | Roadtype. nullptr in NewGRF Inspect window.
  tile | Tile containing the track. For track on a bridge this is the southern bridgehead.
  context | Are we resolving sprites for the upper halftile, or on a bridge?
  rtsg | Roadpart of interest
  param1 | Extra parameter (first parameter of the callback, except roadtypes do not have callbacks).
  param2 | Extra parameter (second parameter of the callback, except roadtypes do not have callbacks).

Definition at line 105 of file newgrf_roadtype.cpp.

References RoadTypeInfo::group, and ResolverObject::root_spritegroup.

## Member Function Documentation

## ◆ GetDebugID()

uint32 RoadTypeResolverObject::GetDebugID | ( |  | ) | const
| overridevirtual

Get an identifier for the item being resolved.

This function is mainly intended for the callback profiling feature, and should return an identifier recognisable by the NewGRF developer.

Reimplemented from ResolverObject.

Definition at line 78 of file newgrf_roadtype.cpp.

References RoadTypeInfo::label, and roadtype_scope.

## ◆ GetFeature()

GrfSpecFeature RoadTypeResolverObject::GetFeature | ( |  | ) | const
| overridevirtual

Get the feature number being resolved for.

This function is mainly intended for the callback profiling feature.

Reimplemented from ResolverObject.

Definition at line 68 of file newgrf_roadtype.cpp.

References GetRoadTypeByLabel(), RoadTypeInfo::label, and roadtype_scope.

## ◆ GetScope()

ScopeResolver* RoadTypeResolverObject::GetScope | ( | VarSpriteGroupScope | scope = `VSG_SCOPE_SELF`,
|  | byte | relative = `0`
| ) |  |
| inlineoverridevirtual

Get a resolver for the scope.

Parameters

  scope | Scope to return.
  relative | Additional parameter for VSG_SCOPE_RELATIVE.

Returns
  The resolver for the requested scope.

Reimplemented from ResolverObject.

Definition at line 35 of file newgrf_roadtype.h.

References ResolverObject::GetScope(), roadtype_scope, and VSG_SCOPE_SELF.

## ◆ ResolveReal()

const SpriteGroup * RoadTypeResolverObject::ResolveReal | ( | const RealSpriteGroup * | group | ) | const
| overridevirtual

Get the real sprites of the grf.

Parameters

  group | Group to get.

Returns
  The available sprite group.

Reimplemented from ResolverObject.

Definition at line 61 of file newgrf_roadtype.cpp.

References RealSpriteGroup::loaded, RealSpriteGroup::loading, RealSpriteGroup::num_loaded, and RealSpriteGroup::num_loading.

The documentation for this struct was generated from the following files:

- src/newgrf_roadtype.h
- src/newgrf_roadtype.cpp