NIHTown Class Reference

Inheritance diagram for NIHTown:
NIHelper

Private Member Functions

bool IsInspectable (uint index) const
 Is the item with the given index inspectable?
uint GetParent (uint index) const
 Get the parent "window_number" of a given instance.
const void * GetInstance (uint index) const
 Get the instance given an index.
const void * GetSpec (uint index) const
 Get (NewGRF) specs given an index.
void SetStringParameters (uint index) const
 Set the string parameters to write the right data for a STRINGn.
uint Resolve (uint index, uint var, uint param, bool *avail) const
 Resolve (action2) variable for a given index.

Detailed Description

Definition at line 438 of file newgrf_debug_data.h.


Member Function Documentation

const void* NIHTown::GetInstance ( uint  index  )  const [inline, private, virtual]

Get the instance given an index.

Parameters:
index the index to get the instance for.
Returns:
the instance.

Implements NIHelper.

Definition at line 441 of file newgrf_debug_data.h.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tcache, Tzero >::PoolItem<&_town_pool >::Get().

uint NIHTown::GetParent ( uint  index  )  const [inline, private, virtual]

Get the parent "window_number" of a given instance.

Parameters:
index the instance to get the parent for.
Returns:
the parent's window_number or UINT32_MAX if there is none.

Implements NIHelper.

Definition at line 440 of file newgrf_debug_data.h.

const void* NIHTown::GetSpec ( uint  index  )  const [inline, private, virtual]

Get (NewGRF) specs given an index.

Parameters:
index the index to get the specs for for.
Returns:
the specs.

Implements NIHelper.

Definition at line 442 of file newgrf_debug_data.h.

bool NIHTown::IsInspectable ( uint  index  )  const [inline, private, virtual]

Is the item with the given index inspectable?

Parameters:
index the index to check.
Returns:
true iff the index is inspectable.

Implements NIHelper.

Definition at line 439 of file newgrf_debug_data.h.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tcache, Tzero >::PoolItem<&_town_pool >::IsValidID().

uint NIHTown::Resolve ( uint  index,
uint  var,
uint  param,
bool *  avail 
) const [inline, private, virtual]

Resolve (action2) variable for a given index.

Parameters:
index The (instance) index to resolve the variable for.
var The variable to actually resolve.
param The varaction2 0x60+x parameter to pass.
avail Return whether the variable is available.
Returns:
The resolved variable's value.

Reimplemented from NIHelper.

Definition at line 444 of file newgrf_debug_data.h.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tcache, Tzero >::PoolItem<&_town_pool >::Get(), and TownGetVariable().

void NIHTown::SetStringParameters ( uint  index  )  const [inline, private, virtual]

Set the string parameters to write the right data for a STRINGn.

Parameters:
index the index to get the string parameters for.

Implements NIHelper.

Definition at line 443 of file newgrf_debug_data.h.

References NIHelper::SetSimpleStringParameters().


The documentation for this class was generated from the following file:

Generated on Fri Dec 31 17:16:40 2010 for OpenTTD by  doxygen 1.6.1