ObjectSpec Struct Reference

Allow incrementing of ObjectClassID variables. More...

#include <newgrf_object.h>

Public Member Functions

Money GetBuildCost () const
 Get the cost for building a structure of this type.
Money GetClearCost () const
 Get the cost for clearing a structure of this type.
bool IsAvailable () const
 Check whether the object is available at this time.
uint Index () const
 Gets the index of this spec.

Static Public Member Functions

static const ObjectSpecGet (ObjectType index)
 Get the specification associated with a specific ObjectType.
static const ObjectSpecGetByTile (TileIndex tile)
 Get the specification associated with a tile.

Data Fields

GRFFilePropsBase< 2 > grf_prop
 Properties related the the grf file.
ObjectClassID cls_id
 The class to which this spec belongs.
StringID name
 The name for this object.
uint8 climate
 In which climates is this object available?
uint8 size
 The size of this objects; low nibble for X, high nibble for Y.
uint8 build_cost_multiplier
 Build cost multiplier per tile.
uint8 clear_cost_multiplier
 Clear cost multiplier per tile.
Date introduction_date
 From when can this object be built.
Date end_of_life_date
 When can't this object be built anymore.
ObjectFlags flags
 Flags/settings related to the object.
AnimationInfo animation
 Information about the animation.
uint16 callback_mask
 Bitmask of requested/allowed callbacks.
uint8 height
 The height of this structure, in heightlevels; max MAX_TILE_HEIGHT.
uint8 views
 The number of views.
bool enabled
 Is this spec enabled?

Detailed Description

Allow incrementing of ObjectClassID variables.

An object that isn't use for transport, industries or houses.

Definition at line 54 of file newgrf_object.h.


Member Function Documentation

const ObjectSpec * ObjectSpec::Get ( ObjectType  index  )  [static]

Get the specification associated with a specific ObjectType.

Parameters:
index The object type to fetch.
Returns:
The specification.

Definition at line 42 of file newgrf_object.cpp.

References NUM_OBJECTS.

Referenced by BuildObject(), CmdBuildObject(), GetByTile(), and BuildObjectWindow::UpdateWidgetSize().

Money ObjectSpec::GetBuildCost (  )  const [inline]

Get the cost for building a structure of this type.

Returns:
The cost for building.

Definition at line 77 of file newgrf_object.h.

const ObjectSpec * ObjectSpec::GetByTile ( TileIndex  tile  )  [static]

Get the specification associated with a tile.

Parameters:
tile The tile to fetch the data for.
Returns:
The specification.

Definition at line 53 of file newgrf_object.cpp.

References Get(), and GetObjectType().

Referenced by AnimateNewObjectTile(), CmdBuildBridge(), GetObjectIDAtOffset(), GetObjectResolver(), NIHObject::GetSpec(), NIHObject::IsInspectable(), and UpdateObjectColours().

Money ObjectSpec::GetClearCost (  )  const [inline]

Get the cost for clearing a structure of this type.

Returns:
The cost for clearing.

Definition at line 83 of file newgrf_object.h.

uint ObjectSpec::Index (  )  const

Gets the index of this spec.

Returns:
The index.

Definition at line 74 of file newgrf_object.cpp.

bool ObjectSpec::IsAvailable (  )  const

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

Generated on Fri Feb 4 20:54:44 2011 for OpenTTD by  doxygen 1.6.1