Orxonox: orxonox::UsableItem Class Reference

# orxonox::UsableItem Class Reference

Base class for all usable items (not usable yet). More...

`#include <src/orxonox/objects/pickup/UsableItem.h>`

Inheritance diagram for orxonox::UsableItem:

List of all members.

## Public Member Functions

| UsableItem (BaseObject *creator)
| Constructor. Registers the UsableItem.
virtual void | used (Pawn *pawn)
| Method invoked when the item is being used.
virtual | ~UsableItem ()

## Detailed Description

Base class for all usable items (not usable yet).

Author:
  Daniel 'Huty' Haggenmueller

## Constructor & Destructor Documentation

orxonox::UsableItem::UsableItem | ( | BaseObject * | creator | ) |

Constructor. Registers the UsableItem.

Parameters:

  | creator | Pointer to the object which created this item.

References RegisterObject.

virtual orxonox::UsableItem::~UsableItem | ( |  | ) | `[inline, virtual]`

## Member Function Documentation

virtual void orxonox::UsableItem::used | ( | Pawn * | pawn | ) | `[inline, virtual]`

Method invoked when the item is being used.

Parameters:

  | pawn | Pawn which is using the item.

Reimplemented in orxonox::HealthUsable, and orxonox::Jump.

Referenced by orxonox::PickupCollection::useItem().

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

- src/orxonox/objects/pickup/UsableItem.h
- src/orxonox/objects/pickup/UsableItem.cc