Orxonox  0.0.5 Codename: Arcturus
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
orxonox::Pickup Class Reference

The Pickup class offers (useful) base functionality for a wide range of pickups. More...

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/modules/pickup/Pickup.h>

Inheritance diagram for orxonox::Pickup:
orxonox::CollectiblePickup orxonox::BaseObject orxonox::Pickupable orxonox::OrxonoxClass orxonox::OrxonoxInterface orxonox::Rewardable orxonox::Configurable orxonox::Destroyable orxonox::Configurable orxonox::Destroyable orxonox::OrxonoxInterface orxonox::Listable orxonox::Listable orxonox::Configurable orxonox::Destroyable orxonox::Identifiable orxonox::Identifiable orxonox::Listable orxonox::Identifiable orxonox::BoostPickup orxonox::DamageBoostPickup orxonox::DronePickup orxonox::HealthPickup orxonox::InvisiblePickup orxonox::MetaPickup orxonox::MunitionPickup orxonox::ShieldPickup orxonox::ShrinkPickup orxonox::SpeedPickup

Public Member Functions

 Pickup (Context *context)
 Constructor. More...
 
virtual ~Pickup ()
 Destructor. More...
 
virtual void changedPickedUp (void) override
 Should be called when the pickup has transited from picked up to dropped or the other way around. More...
 
PickupActivationType getActivationType (void) const
 Get the activation type of the Pickup. More...
 
const std::string & getActivationTypeAsString (void) const
 Get the activation type of the Pickup. More...
 
PickupDurationType getDurationType (void) const
 Get the duration type of the Pickup. More...
 
const std::string & getDurationTypeAsString (void) const
 Get the duration type of the Pickup. More...
 
virtual const std::string & getRepresentationName () const override
 Returns the representation name which refers to the name of the PickupRepresentation that is used to represent this pickup. More...
 
bool isContinuous (void) const
 Get whether the duration type is 'continuous'. More...
 
bool isImmediate (void) const
 Get whether the activation type is 'immediate'. More...
 
bool isOnce (void) const
 Get whether the duration type is 'once'. More...
 
bool isOnUse (void) const
 Get whether the activation type is 'onUse'. More...
 
virtual void XMLPort (Element &xmlelement, XMLPort::Mode mode) override
 Method for creating a Pickup object through XML. More...
 
- Public Member Functions inherited from orxonox::CollectiblePickup
 CollectiblePickup ()
 Constructor. More...
 
virtual ~CollectiblePickup ()
 Destructor. More...
 
virtual void changedUsed (void) override
 Destructor. More...
 
bool isInCollection (void) const
 Check whether the given CollectiblePickup is par of a PickupCollection. More...
 
- Public Member Functions inherited from orxonox::Pickupable
virtual ~Pickupable ()
 Default destructor. More...
 
bool addTarget (PickupCarrier *target)
 Add a PickupCarrier as target of this Pickupable. More...
 
bool addTarget (Identifier *identifier)
 Add a class, representetd by the input Identifier, as target of this Pickupable. More...
 
virtual void changedCarrier (void)
 Should be called when the Pickupable has changed its PickupCarrier. More...
 
void destroy (void)
 Is called internally within the Pickupable module to destroy pickups. More...
 
bool drop (bool createSpawner=true)
 Can be called to drop a Pickupable. More...
 
PickupCarriergetCarrier (void)
 Get the carrier of the Pickupable. More...
 
bool isEnabled (void) const
 Returns whether the Pickupable is enabled. More...
 
bool isPickedUp (void) const
 Returns whether the Pickupable is currently picked up. More...
 
virtual bool isTarget (const PickupCarrier *carrier) const
 Get whether the given PickupCarrier is a target of this Pickupable. More...
 
bool isTarget (const Identifier *identifier) const
 Get whether a given class, represented by the input Identifier, is a target of this Pickupable. More...
 
bool isUnusable (void) const
 Returns whether the Pickupable can be unused. More...
 
bool isUsable (void) const
 Returns whether the Pickupable can be used. More...
 
bool isUsed (void) const
 Get whether the Pickupable is currently in use or not. More...
 
bool pickup (PickupCarrier *carrier)
 Can be called to pick up a Pickupable. More...
 
virtual bool reward (PlayerInfo *player) override
 Method to transcribe a Pickupable as a Rewardable to the player. More...
 
bool setCarrier (PickupCarrier *carrier, bool tell=true)
 Sets the carrier of the Pickupable. More...
 
bool setPickedUp (bool pickedUp)
 Helper method to set the Pickupable to either picked up or not picked up. More...
 
bool setUsed (bool used)
 Sets the Pickupable to used or unused, depending on the input. More...
 
- Public Member Functions inherited from orxonox::OrxonoxInterface
 OrxonoxInterface ()
 
- Public Member Functions inherited from orxonox::Configurable
 Configurable ()
 
void setConfigValues ()
 Function to collect the SetConfigValue-macro calls. More...
 
- Public Member Functions inherited from orxonox::Listable
 Listable ()
 Constructor: Allocates space in the element list. More...
 
 Listable (Context *context)
 Constructor: Allocates space in the element list and assigns the context. More...
 
virtual ~Listable ()
 Destructor: Removes the object from the object-lists. More...
 
ContextgetContext () const
 
void setContext (Context *context)
 Changes the context. More...
 
void unregisterObject ()
 Removes this object from the object-lists. More...
 
- Public Member Functions inherited from orxonox::Identifiable
 Identifiable ()
 Constructor: Sets the default values. More...
 
virtual ~Identifiable ()
 
ORX_FORCEINLINE voidgetDerivedPointer (unsigned int classID)
 Returns a valid pointer of any derived type that is registered in the class hierarchy. More...
 
template<class T >
ORX_FORCEINLINE T * getDerivedPointer (unsigned int classID)
 Version of getDerivedPointer with template. More...
 
template<class T >
ORX_FORCEINLINE const T * getDerivedPointer (unsigned int classID) const
 Const version of getDerivedPointer with template. More...
 
IdentifiergetIdentifier () const
 Returns the Identifier of the object. More...
 
bool isA (const Identifier *identifier)
 Returns true if the object's class is of the given type or a derivative. More...
 
template<class B >
bool isA (const SubclassIdentifier< B > *identifier)
 Returns true if the object's class is of the given type or a derivative. More...
 
bool isA (const Identifiable *object)
 Returns true if the object's class is of the given type or a derivative. More...
 
bool isChildOf (const Identifier *identifier)
 Returns true if the object's class is a child of the given type. More...
 
template<class B >
bool isChildOf (const SubclassIdentifier< B > *identifier)
 Returns true if the object's class is a child of the given type. More...
 
bool isChildOf (const Identifiable *object)
 Returns true if the object's class is a child of the given type. More...
 
bool isDirectChildOf (const Identifier *identifier)
 Returns true if the object's class is a direct child of the given type. More...
 
template<class B >
bool isDirectChildOf (const SubclassIdentifier< B > *identifier)
 Returns true if the object's class is a direct child of the given type. More...
 
bool isDirectChildOf (const Identifiable *object)
 Returns true if the object's class is a direct child of the given type. More...
 
bool isDirectParentOf (const Identifier *identifier)
 Returns true if the object's class is a direct parent of the given type. More...
 
template<class B >
bool isDirectParentOf (const SubclassIdentifier< B > *identifier)
 Returns true if the object's class is a direct parent of the given type. More...
 
bool isDirectParentOf (const Identifiable *object)
 Returns true if the object's class is a direct child of the given type. More...
 
bool isExactlyA (const Identifier *identifier)
 Returns true if the object's class is exactly of the given type. More...
 
template<class B >
bool isExactlyA (const SubclassIdentifier< B > *identifier)
 Returns true if the object's class is exactly of the given type. More...
 
bool isExactlyA (const Identifiable *object)
 Returns true if the object's class is exactly of the given type. More...
 
bool isParentOf (const Identifier *identifier)
 Returns true if the object's class is a parent of the given type. More...
 
template<class B >
bool isParentOf (const SubclassIdentifier< B > *identifier)
 Returns true if the object's class is a parent of the given type. More...
 
bool isParentOf (const Identifiable *object)
 Returns true if the object's class is a parent of the given type. More...
 
- Public Member Functions inherited from orxonox::Destroyable
 Destroyable ()
 Constructor: Sets the default values. More...
 
virtual ~Destroyable ()
 Destructor: Notifies all DestructionListener (for example weak pointers) that this object is being deleted. More...
 
void destroy ()
 Deletes the object if no strong pointers point to this object. More...
 
void destroyLater ()
 Works like destroy() but doesn't destroy the object until the current tick has ended. More...
 
unsigned int getReferenceCount () const
 Returns the number of strong pointers that point to this object. More...
 
- Public Member Functions inherited from orxonox::Rewardable
 Rewardable ()
 
virtual ~Rewardable ()
 
- Public Member Functions inherited from orxonox::BaseObject
 BaseObject (Context *context)
 Constructor: Registers the object in the BaseObject-list. More...
 
virtual ~BaseObject ()
 Destructor. More...
 
void addEventListener (BaseObject *listener)
 Adds an object which listens to the events of this object. More...
 
void addEventSource (BaseObject *source, const std::string &state)
 Adds a new event source for a specific state. More...
 
void addTemplate (const std::string &name)
 Adds a Template to the object. More...
 
void addTemplate (Template *temp)
 Adds a Template to the object. More...
 
virtual void changedActivity ()
 This function gets called if the activity of the object changes. More...
 
virtual void changedMainStateName ()
 This function gets called if the main state name of the object changes. More...
 
virtual void changedName ()
 This function gets called if the name of the object changes. More...
 
virtual void changedVisibility ()
 This function gets called if the visibility of the object changes. More...
 
void fireEvent (const std::string &name="")
 Fires an event (without a state). More...
 
void fireEvent (bool activate, const std::string &name="")
 Fires an event which activates or deactivates a state. More...
 
void fireEvent (bool activate, BaseObject *originator, const std::string &name="")
 Fires an event which activates or deactivates a state with agiven originator (the object which triggered the event). More...
 
void fireEvent (Event &event)
 Fires an event, using the Event struct. More...
 
BaseObjectgetCreator () const
 
BaseObjectgetEventListener (unsigned int index) const
 Returns an event listener with a given index. More...
 
BaseObjectgetEventSource (unsigned int index, const std::string &state) const
 Returns an eventsource with a given index. More...
 
const XMLFilegetFile () const
 Returns a pointer to the XMLFile that loaded this object. More...
 
const std::string & getFilename () const
 Returns the levelfile that loaded this object. More...
 
GametypegetGametype () const
 
LevelgetLevel () const
 
const std::string & getLoaderIndentation () const
 Returns the indentation of the debug output in the Loader. More...
 
const std::string & getMainStateName () const
 Returns the name of the main state. More...
 
const std::string & getName () const
 Returns the name of the object. More...
 
NamespacegetNamespace () const
 
const std::string & getOldName () const
 Returns the old name of the object. More...
 
ScenegetScene () const
 
virtual uint32_t getSceneID () const
 
const std::set< Template * > & getTemplates () const
 Returns the set of all aplied templates. More...
 
const mboolisActive () const
 Returns the state of the objects activity. More...
 
bool isInitialized () const
 Returns if the object was initialized (passed the object registration). More...
 
const mboolisVisible () const
 Returns the state of the objects visibility. More...
 
virtual void processEvent (Event &event)
 Processing an event by calling the right main state. More...
 
void removeEventSource (BaseObject *source)
 Removes an eventsource (but doesn't unregister itself at the source). More...
 
void setActive (bool bActive)
 Sets the state of the objects activity. More...
 
void setCreator (BaseObject *creator)
 
void setFile (const XMLFile *file)
 Sets a pointer to the xml file that loaded this object. More...
 
void setGametype (const StrongOrWeakPtr< Gametype > &gametype)
 
void setLevel (const StrongOrWeakPtr< Level > &level)
 
void setLoaderIndentation (const std::string &indentation)
 Sets the indentation of the debug output in the Loader. More...
 
void setMainState (bool state)
 Sets the main state of the object to a given boolean value. More...
 
void setMainStateName (const std::string &name)
 Sets the name of the main state (used for event reactions). More...
 
void setName (const std::string &name)
 Sets the name of the object. More...
 
void setNamespace (const StrongOrWeakPtr< Namespace > &ns)
 
void setScene (const StrongOrWeakPtr< Scene > &scene, uint32_t sceneID)
 
void setVisible (bool bVisible)
 Sets the state of the objects visibility. More...
 
virtual void XMLEventPort (Element &xmlelement, XMLPort::Mode mode)
 Defines the possible event states of this object and parses eventsources from an XML file. More...
 
- Public Member Functions inherited from orxonox::OrxonoxClass
 OrxonoxClass ()
 
OrxonoxClassoperator= (const OrxonoxClass &)=default
 

Protected Member Functions

virtual bool createSpawner (void) override
 Facilitates the creation of a PickupSpawner upon dropping of the Pickupable. More...
 
void setActivationType (PickupActivationType type)
 Set the activation type of the Pickup. More...
 
void setActivationTypeAsString (const std::string &type)
 Set the activation type of the Pickup. More...
 
void setDurationType (PickupDurationType type)
 Set the duration type of the Pickup. More...
 
void setDurationTypeAsString (const std::string &type)
 Set the duration type of the Pickup. More...
 
void setRepresentationName (const std::string &name)
 Sets the representation name which refers to the name of the PickupRepresentation that is used to represent this pickup. More...
 
- Protected Member Functions inherited from orxonox::Pickupable
 Pickupable ()
 Default constructor. More...
 
virtual void carrierDestroyed (void)
 Is called by the PickupCarrier when it is being destroyed. More...
 
virtual void destroyPickup (void)
 Destroys a Pickupable. More...
 
bool isBeingDestroyed (void)
 Check whether the Pickupable is in the process of being destroyed. More...
 
virtual void preDestroy (void) override
 A method that is called by Destroyable::destroy() before the object is actually destroyed. More...
 
void setDisabled (void)
 Sets the Pickuapble to disabled. More...
 
- Protected Member Functions inherited from orxonox::BaseObject
void addEventState (const std::string &name, EventState *container)
 Adds a new event-state to the object. More...
 
EventStategetEventState (const std::string &name) const
 Returns the event-state with the given name. More...
 

Private Member Functions

void initialize (void)
 Initializes the member variables. More...
 

Private Attributes

PickupActivationType activationType_
 The activation type of the Pickup. More...
 
PickupDurationType durationType_
 The duration type of the Pickup. More...
 
std::string representationName_
 The name of the associated PickupRepresentation. More...
 

Static Private Attributes

static const std::string activationTypeImmediate_s = "immediate"
 Strings for the activation and duration types. More...
 
static const std::string activationTypeOnUse_s = "onUse"
 
static const std::string durationTypeContinuous_s = "continuous"
 
static const std::string durationTypeOnce_s = "once"
 

Additional Inherited Members

- Static Public Member Functions inherited from orxonox::BaseObject
static void loadAllEventStates (Element &xmlelement, XMLPort::Mode mode, BaseObject *object, Identifier *identifier)
 Manually loads all event states, even if the class doesn't officially support them. More...
 
- Protected Attributes inherited from orxonox::BaseObject
mbool bActive_
 True = the object is active. More...
 
mbool bVisible_
 True = the object is visible. More...
 
FunctorPtr mainStateFunctor_
 
std::string mainStateName_
 
std::string name_
 The name of the object. More...
 
std::set< std::string > networkTemplateNames_
 
std::string oldName_
 The old name of the object. More...
 

Detailed Description

The Pickup class offers (useful) base functionality for a wide range of pickups.

Pickups inheriting from this class can choose an activation type and a duration type.

If it were not an abstract class it could for example be used as follows in XML.

<Pickup activationType="onUse" durationType="continuous" />

In reality you can (naturally) use the parameters activation type and duration type in any pickup inheriting from Pickup, unless the pickup already specifies one (or both) of the parameters.

Author
Damian 'Mozork' Frick

Constructor & Destructor Documentation

orxonox::Pickup::Pickup ( Context context)

Constructor.

Registers and initializes the object.

orxonox::Pickup::~Pickup ( )
virtual

Destructor.

Member Function Documentation

void orxonox::Pickup::changedPickedUp ( void  )
overridevirtual

Should be called when the pickup has transited from picked up to dropped or the other way around.

Any Class overwriting this method must call its SUPER function by adding SUPER(Classname, changedPickedUp); to their changedPickedUp method.

Reimplemented from orxonox::CollectiblePickup.

Reimplemented in orxonox::ShrinkPickup.

bool orxonox::Pickup::createSpawner ( void  )
overrideprotectedvirtual

Facilitates the creation of a PickupSpawner upon dropping of the Pickupable.

Returns
Returns true if a spawner was created, false if not.

Implements orxonox::Pickupable.

PickupActivationType orxonox::Pickup::getActivationType ( void  ) const
inline

Get the activation type of the Pickup.

Returns
Returns the activation type of the Pickup.
const std::string & orxonox::Pickup::getActivationTypeAsString ( void  ) const

Get the activation type of the Pickup.

Get the activation type of the pickup.

Returns
Returns a string containing the activation type.
PickupDurationType orxonox::Pickup::getDurationType ( void  ) const
inline

Get the duration type of the Pickup.

Returns
Returns the duration type of the Pickup.
const std::string & orxonox::Pickup::getDurationTypeAsString ( void  ) const

Get the duration type of the Pickup.

Get the duration type of the pickup.

Returns
Returns a string containing the duration type.
virtual const std::string& orxonox::Pickup::getRepresentationName ( ) const
inlineoverridevirtual

Returns the representation name which refers to the name of the PickupRepresentation that is used to represent this pickup.

Implements orxonox::Pickupable.

void orxonox::Pickup::initialize ( void  )
private

Initializes the member variables.

bool orxonox::Pickup::isContinuous ( void  ) const
inline

Get whether the duration type is 'continuous'.

Returns
Returns true if the duration type is 'continuous'.
bool orxonox::Pickup::isImmediate ( void  ) const
inline

Get whether the activation type is 'immediate'.

Returns
Returns true if the activation type is 'immediate'.
bool orxonox::Pickup::isOnce ( void  ) const
inline

Get whether the duration type is 'once'.

Returns
Returns true if the duration type is 'once'.
bool orxonox::Pickup::isOnUse ( void  ) const
inline

Get whether the activation type is 'onUse'.

Returns
Returns true if the activation type is 'onUse'.
void orxonox::Pickup::setActivationType ( PickupActivationType  type)
inlineprotected

Set the activation type of the Pickup.

Parameters
typeThe activation type of the Pickup.
void orxonox::Pickup::setActivationTypeAsString ( const std::string &  type)
protected

Set the activation type of the Pickup.

Parameters
typeThe activation type of the Pickup as a string.
void orxonox::Pickup::setDurationType ( PickupDurationType  type)
inlineprotected

Set the duration type of the Pickup.

Parameters
typeThe duration type of the Pickup.
void orxonox::Pickup::setDurationTypeAsString ( const std::string &  type)
protected

Set the duration type of the Pickup.

Parameters
typeThe duration type of the Pickup as a string.
void orxonox::Pickup::setRepresentationName ( const std::string &  name)
inlineprotected

Sets the representation name which refers to the name of the PickupRepresentation that is used to represent this pickup.

void orxonox::Pickup::XMLPort ( Element &  xmlelement,
XMLPort::Mode  mode 
)
overridevirtual

Member Data Documentation

PickupActivationType orxonox::Pickup::activationType_
private

The activation type of the Pickup.

const std::string orxonox::Pickup::activationTypeImmediate_s = "immediate"
staticprivate

Strings for the activation and duration types.

Initializing the static strings.

const std::string orxonox::Pickup::activationTypeOnUse_s = "onUse"
staticprivate
PickupDurationType orxonox::Pickup::durationType_
private

The duration type of the Pickup.

const std::string orxonox::Pickup::durationTypeContinuous_s = "continuous"
staticprivate
const std::string orxonox::Pickup::durationTypeOnce_s = "once"
staticprivate
std::string orxonox::Pickup::representationName_
private

The name of the associated PickupRepresentation.


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