Orxonox: orxonox::Rewardable Class Reference

# orxonox::Rewardable Class Reference

Rewardable is an Interface, that can be implemented by any object to enable it to be given as reward to a player through QuestEffects. (With the AddReward effect.). More...

`#include <src/orxonox/interfaces/Rewardable.h>`

Inheritance diagram for orxonox::Rewardable:

List of all members.

## Public Member Functions

virtual bool | reward (PlayerInfo *player)=0
| Method to transcribe a rewardable object to the player. Must be implemented by every class inheriting from Rewardable.
| Rewardable ()
virtual | ~Rewardable ()

## Detailed Description

Rewardable is an Interface, that can be implemented by any object to enable it to be given as reward to a player through QuestEffects. (With the AddReward effect.).

It just needs to inherit form Rewardable, and implement the reward() method.

Author:
  Damian 'Mozork' Frick

## Constructor & Destructor Documentation

orxonox::Rewardable::Rewardable | ( |  | ) |

References RegisterObject.

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

## Member Function Documentation

virtual bool orxonox::Rewardable::reward | ( | PlayerInfo * | player | ) | `[pure virtual]`

Method to transcribe a rewardable object to the player. Must be implemented by every class inheriting from Rewardable.

Parameters:

  | player | A pointer to the ControllableEntity, do whatever you want with it.

Returns:
  Return true if successful.

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

- src/orxonox/interfaces/Rewardable.h
- src/orxonox/interfaces/InterfaceCompilation.cc