The HealthPickup is a Pickupable that can do (dependent upon the parameters) lots of different things to the health of a Pawn. More...

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

Inheritance diagram for orxonox::HealthPickup:

Public Member Functions
	HealthPickup (Context *context)
	Constructor. More...

virtual	~HealthPickup ()
	Destructor. More...

virtual void	changedUsed (void)
	Is called when the pickup has transited from used to unused or the other way around. More...

float	getHealth (void) const
	Get the health that is transferred to the Pawn upon usage of this pickup. More...

float	getHealthRate (void) const
	Get the rate at which the health is transferred to the Pawn, if this pickup has duration type 'continuous'. More...

PickupHealthType	getHealthType (void) const
	Get the type of HealthPickup, this pickup is. More...

const std::string &	getHealthTypeAsString (void) const
	Get the health type of this pickup. More...

virtual void	tick (float dt)
	Is called every tick. More...

virtual void	XMLPort (Element &xmlelement, orxonox::XMLPort::Mode mode)
	Method for creating a HealthPickup object through XML. More...

Public Member Functions inherited from orxonox::Pickup
	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...

Public Member Functions inherited from orxonox::CollectiblePickup
	CollectiblePickup ()
	Constructor. More...

virtual	~CollectiblePickup ()
	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...

PickupCarrier *	getCarrier (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...

Context *	getContext () 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 void *	getDerivedPointer (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...

Identifier *	getIdentifier () 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...

BaseObject *	getCreator () const

BaseObject *	getEventListener (unsigned int index) const
	Returns an event listener with a given index. More...

BaseObject *	getEventSource (unsigned int index, const std::string &state) const
	Returns an eventsource with a given index. More...

const XMLFile *	getFile () 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...

Gametype *	getGametype () const

Level *	getLevel () 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...

Namespace *	getNamespace () const

const std::string &	getOldName () const
	Returns the old name of the object. More...

Scene *	getScene () const

virtual uint32_t	getSceneID () const

const std::set< Template * > &	getTemplates () const
	Returns the set of all aplied templates. More...

const mbool &	isActive () const
	Returns the state of the objects activity. More...

bool	isInitialized () const
	Returns if the object was initialized (passed the object registration). More...

const mbool &	isVisible () 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 ()

OrxonoxClass &	operator= (const OrxonoxClass &)=default

Protected Member Functions
void	setHealth (float health)
	Sets the health. More...

void	setHealthRate (float speed)
	Set the rate at which health is transferred if the pickup is continuous. More...

void	setHealthType (PickupHealthType type)
	Set the health type of this pickup. More...

void	setHealthTypeAsString (const std::string &type)
	Set the type of the HealthPickup. More...

Protected Member Functions inherited from orxonox::Pickup
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...

EventState *	getEventState (const std::string &name) const
	Returns the event-state with the given name. More...

Protected Member Functions inherited from orxonox::Tickable
	Tickable ()
	Constructor: Registers the object in the Tickable-list. More...

Private Member Functions
Pawn *	carrierToPawnHelper (void)
	Helper to transform the PickupCarrier to a Pawn, and throw an error message if the conversion fails. More...

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

Private Attributes
float	health_
	The health that is transferred to the Pawn. More...

float	healthRate_
	The rate at which the health is transferred. More...

PickupHealthType	healthType_
	The type of the HealthPickup. More...

float	maxHealthOverwrite_
	Helper to remember with which value we overwrote the maxHealh, to detect if someone else changed it as well. More...

float	maxHealthSave_
	Helper to remember what the actual maxHealth of the Pawn was before we changed it. More...

Static Private Attributes
static const std::string	healthTypeLimited_s = "limited"
	Strings for the health types. More...

static const std::string	healthTypePermanent_s = "permanent"

static const std::string	healthTypeTemporary_s = "temporary"

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 HealthPickup is a Pickupable that can do (dependent upon the parameters) lots of different things to the health of a Pawn.

There are 5 parameters that can be chosen:

The activationType It can be chosen to be either immediate or onUse. The activation type essentially (as indicated by the name) defines when the health is transferred, either immediately after being picked up or only after the player uses it. The default is immediate.
The durationType It can be chosen to be either once or continuous. For once the specified health is transferred once to the Pawn, for continuous the set health is transferred over a span of time at a rate defined by the health rate parameter. The default is once.
The health The amount of health that (in a way dependent on the other parameters) is transferred to the Pawn. Default is 0.
The healthType The health type can be chosen to be limited, temporary or permanent. limited means that the health is increased only to the maximum health of the Pawn. 'temporary' means that the maximum health is temporarily elevated but will be set back as soon as the pickup is no longer in use. permanent means that the maximum health of the Pawn is increased such that the health provided by the pickup will fit in and the maximum health stays that way. The default is limited.
The healthRate If set to continuous, the health that is transferred per second is the healthRate. There is health transferred until the health set by health is depleted. The default is 0.

An example of a XML implementation of a HealthPickup would be:

<HealthPickup
    health = 50
    healthType = "limited"
    activationType = "immediate"
    durationType = "once"
/>

Author: Damian 'Mozork' Frick

Constructor & Destructor Documentation

orxonox::HealthPickup::HealthPickup ( Context * context )

Constructor.

Registers the object and initializes the member variables.

orxonox::HealthPickup::~HealthPickup ( )

virtual

Destructor.

Member Function Documentation

Pawn * orxonox::HealthPickup::carrierToPawnHelper ( void )

private

Helper to transform the PickupCarrier to a Pawn, and throw an error message if the conversion fails.

Returns: A pointer to the Pawn, or nullptr if the conversion failed.

void orxonox::HealthPickup::changedUsed ( void )

virtual

Is called when the pickup has transited from used to unused or the other way around.

Reimplemented from orxonox::CollectiblePickup.

float orxonox::HealthPickup::getHealth ( void ) const

inline

Get the health that is transferred to the Pawn upon usage of this pickup.

Returns: Returns the health.

float orxonox::HealthPickup::getHealthRate ( void ) const

inline

Get the rate at which the health is transferred to the Pawn, if this pickup has duration type 'continuous'.

Returns: Returns the rate.

PickupHealthType orxonox::HealthPickup::getHealthType ( void ) const

inline

Get the type of HealthPickup, this pickup is.

Returns: Returns the health type as an enum.

const std::string & orxonox::HealthPickup::getHealthTypeAsString ( void ) const

Get the health type of this pickup.

Returns: Returns the health type as a string.

void orxonox::HealthPickup::initialize ( void )

private

Initializes the member variables.

void orxonox::HealthPickup::setHealth ( float health )

protected

Sets the health.

Parameters

health The health.

void orxonox::HealthPickup::setHealthRate ( float rate )

protected

Set the rate at which health is transferred if the pickup is continuous.

Parameters

rate The rate.

void orxonox::HealthPickup::setHealthType ( PickupHealthType type )

inlineprotected

Set the health type of this pickup.

Parameters

type	The type of this pickup as an enum.

void orxonox::HealthPickup::setHealthTypeAsString ( const std::string & type )

protected

Set the type of the HealthPickup.

Parameters

type	The type as a string.

void orxonox::HealthPickup::tick ( float dt )

virtual

Is called every tick.

Does all the continuous stuff of this HealthPickup.

Parameters

dt	The duration of the last tick.

Reimplemented from orxonox::Tickable.

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

virtual

Method for creating a HealthPickup object through XML.

Reimplemented from orxonox::Pickup.

Member Data Documentation

float orxonox::HealthPickup::health_

private

The health that is transferred to the Pawn.

float orxonox::HealthPickup::healthRate_

private

The rate at which the health is transferred.

PickupHealthType orxonox::HealthPickup::healthType_

private

The type of the HealthPickup.

const std::string orxonox::HealthPickup::healthTypeLimited_s = "limited"

staticprivate

Strings for the health types.

const std::string orxonox::HealthPickup::healthTypePermanent_s = "permanent"

staticprivate

const std::string orxonox::HealthPickup::healthTypeTemporary_s = "temporary"

staticprivate

float orxonox::HealthPickup::maxHealthOverwrite_

private

Helper to remember with which value we overwrote the maxHealh, to detect if someone else changed it as well.

float orxonox::HealthPickup::maxHealthSave_

private

Helper to remember what the actual maxHealth of the Pawn was before we changed it.

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

modules/pickup/items/HealthPickup.h
modules/pickup/items/HealthPickup.cc

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation