OpenTTD Source: ObjectResolverObject Struct Reference

OpenTTD Source 12.0-beta1

Public Member Functions | Data Fields | Private Member Functions
ObjectResolverObject Struct Reference

A resolver object to be used with feature 0F spritegroups. More...

`#include <newgrf_object.h>`

Inheritance diagram for ObjectResolverObject:

## Public Member Functions
| ObjectResolverObject (const ObjectSpec *spec, Object *o, TileIndex tile, uint8 view=0, CallbackID callback=CBID_NO_CALLBACK, uint32 param1=0, uint32 param2=0)
| Constructor of the object resolver. More...
ScopeResolver * | GetScope (VarSpriteGroupScope scope=VSG_SCOPE_SELF, byte relative=0) override
| Get a resolver for the scope. 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...
virtual const SpriteGroup * | ResolveReal (const RealSpriteGroup *group) const
| Get the real sprites of the grf. 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
ObjectScopeResolver | object_scope
| The object scope resolver.
TownScopeResolver * | town_scope
| The town scope resolver (created on the first call).
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.

## Private Member Functions
TownScopeResolver * | GetTown ()
| Get the town resolver scope that belongs to this object resolver. More...

## Detailed Description

A resolver object to be used with feature 0F spritegroups.

Definition at line 123 of file newgrf_object.h.

## Constructor & Destructor Documentation

## ◆ ObjectResolverObject()

ObjectResolverObject::ObjectResolverObject | ( | const ObjectSpec * | spec,
|  | Object * | obj,
|  | TileIndex | tile,
|  | uint8 | view = `0`,
|  | CallbackID | callback = `CBID_NO_CALLBACK`,
|  | uint32 | param1 = `0`,
|  | uint32 | param2 = `0`
| ) |  |

Constructor of the object resolver.

Parameters

  obj | Object being resolved.
  tile | Tile of the object.
  view | View of the object.
  callback | Callback ID.
  param1 | First parameter (var 10) of the callback.
  param2 | Second parameter (var 18) of the callback.

Definition at line 353 of file newgrf_object.cpp.

References CT_PURCHASE_OBJECT, ObjectSpec::grf_prop, ResolverObject::root_spritegroup, GRFFilePropsBase< Tcnt >::spritegroup, and town_scope.

## Member Function Documentation

## ◆ GetDebugID()

uint32 ObjectResolverObject::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 392 of file newgrf_object.cpp.

References ObjectSpec::grf_prop, GRFFilePropsBase< Tcnt >::local_id, object_scope, and ObjectScopeResolver::spec.

## ◆ GetFeature()

GrfSpecFeature ObjectResolverObject::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 387 of file newgrf_object.cpp.

## ◆ GetScope()

ScopeResolver* ObjectResolverObject::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 131 of file newgrf_object.h.

References ResolverObject::GetScope(), GetTown(), object_scope, VSG_SCOPE_PARENT, and VSG_SCOPE_SELF.

Referenced by NIHObject::Resolve().

## ◆ GetTown()

TownScopeResolver * ObjectResolverObject::GetTown | ( |  | ) |
| private

Get the town resolver scope that belongs to this object resolver.

On the first call, the town scope is created (if possible).

Returns
  Town scope, if available.

Definition at line 372 of file newgrf_object.cpp.

References ClosestTownFromTile(), ObjectScopeResolver::obj, object_scope, ObjectScopeResolver::tile, Object::town, and town_scope.

Referenced by GetScope().

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

- src/newgrf_object.h
- src/newgrf_object.cpp