In order to assign attached entities to a ShipPart, a ShipPart with the same name as the corresponding entity needs to be created in the <parts> tag.

More...

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/orxonox/items/PartDestructionEvent.h>

Inheritance diagram for orxonox::PartDestructionEvent:

Public Types
enum	TargetParam { TargetParam::shieldhealth, TargetParam::maxshieldhealth, TargetParam::shieldabsorption, TargetParam::shieldrechargerate, TargetParam::boostpower, TargetParam::boostpowerrate, TargetParam::rotationthrust, TargetParam::boostfactor, TargetParam::speedfront, TargetParam::accelerationfront, TargetParam::null }
	List of all allowed parameters. More...

Public Member Functions
	PartDestructionEvent (Context *context)

virtual	~PartDestructionEvent ()

void	execute ()
	Executes this event. More...

float	getEventValue ()

std::string	getMessage ()

std::string	getOperation ()

ShipPart *	getParent ()

std::string	getTargetName ()

std::string	getTargetParam ()

std::string	getTargetType ()

bool	isValid ()

float	operate (float input)
	Apply the configured operation and value to an input. More...

void	setEventValue (float value)
	Sets the value applied with the chosen operation. More...

void	setMessage (std::string msg)
	Set the message to be shown upon execution of the vent. More...

void	setOperation (std::string operation)
	Set the operation to be applied. More...

void	setParent (ShipPart *parent)

void	setTargetName (std::string name)

void	setTargetParam (std::string param)
	Set the operation to be applied. More...

void	setTargetType (std::string type)
	Set type of the target. More...

void	setValid (bool valid)

virtual void	XMLPort (Element &xmlelement, XMLPort::Mode mode) override
	XML loading and saving. More...

Public Member Functions inherited from orxonox::Item
	Item (Context *context)

virtual	~Item ()

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

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::Synchronisable
virtual	~Synchronisable ()
	Destructor: Delete all callback objects and remove objectID_ from the objectMap_. More...

uint32_t	getClassID () const

unsigned int	getContextID () const

uint32_t	getNrOfVariables ()

uint32_t	getObjectID () const

unsigned int	getPriority () const

uint8_t	getSyncMode () const

uint32_t	getVarSize (VariableID ID)

template<>
_NetworkExport void	registerVariable (std::string &variable, uint8_t mode, NetworkCallbackBase *cb, bool bidirectional)

template<>
void	registerVariable (std::string &variable, uint8_t mode, NetworkCallbackBase *cb, bool bidirectional)

void	setSyncMode (uint8_t mode)
	This function sets the synchronisation mode of the object If set to 0x0 variables will not be synchronised at all If set to 0x1 variables will only be synchronised to the client If set to 0x2 variables will only be synchronised to the server If set to 0x3 variables will be synchronised bidirectionally (only if set so in registerVar) More...

template<>
_NetworkExport void	unregisterVariable (std::string &variable)

template<>
void	unregisterVariable (std::string &variable)

Public Member Functions inherited from orxonox::OrxonoxInterface
	OrxonoxInterface ()

Private Attributes
std::string	message_
	The message which is shown in chat when the event is executed. More...

std::string	operation_
	The operation to be applied. More...

ShipPart *	parent_
	Pointer to the ShipPart this event belongs to. More...

std::string	targetName_
	The name of the target. More...

TargetParam	targetParam_
	The parameter to be modified. More...

std::string	targetType_
	The type of the target. (ship weapon engine) More...

bool	valid_
	Whether this event is valid or not. More...

float	value_
	The value used to do the operation. More...

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...

Static Public Member Functions inherited from orxonox::Synchronisable
static bool	deleteObject (uint32_t objectID_)
	Finds and deletes the Synchronisable with the appropriate objectID_. More...

static Synchronisable *	fabricate (uint8_t *&mem, uint8_t mode=0x0)
	This function fabricated a new synchrnisable (and children of it), sets calls updateData and create After calling this function the mem pointer will be increased by the size of the needed data. More...

static unsigned int	getNumberOfDeletedObject ()

static Synchronisable *	getSynchronisable (uint32_t objectID_)
	This function looks up the objectID_ in the objectMap_ and returns a pointer to the right Synchronisable. More...

static uint32_t	popDeletedObject ()

static void	setClient (bool b)
	This function sets the internal mode for synchronisation. 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::Destroyable
virtual void	preDestroy ()
	This virtual function is called if destroy() is called and no StrongPtr points to this object. More...

Protected Member Functions inherited from orxonox::Synchronisable
	Synchronisable (Context *context)
	Constructor: Initializes all Variables and sets the right objectID_. More...

uint32_t	findContextID (Context *context)
	Returns the id of the context. More...

template<class T >
void	registerVariable (T &variable, uint8_t mode=0x1, NetworkCallbackBase *cb=nullptr, bool bidirectional=false)

template<class T >
void	registerVariable (std::set< T > &variable, uint8_t mode=0x1, NetworkCallbackBase *cb=nullptr, bool bidirectional=false)

void	setPriority (unsigned int freq)

template<class T >
void	unregisterVariable (T &var)

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

In order to assign attached entities to a ShipPart, a ShipPart with the same name as the corresponding entity needs to be created in the <parts> tag.

Here is a (primitive) example of a ModularSpaceShip with ShipParts and PartDestructionEvents defined in XML:

<ModularSpaceShip
    ...
    >
        <attached>
            <StaticEntity name="generator"  . . .  />
            <StaticEntity name="tail" . . . />
        </attached>
        <parts>
            <ShipPart name="generator" . . . >
                <destructionevents>
                    <PartDestructionEvent targetType="ship" targetParam="boostpowerrate" operation="-" value="0.5" message="Your boost-regeneration is reduced!" />
                </destructionevents>
            </ShipPart>
            <ShipPart name="tail" . . . >
                <destructionevents>
                    <PartDestructionEvent ... />
                </destructionevents>
            </ShipPart>
        </parts>
        <engines>
            <Engine />
            <Engine />
        </engines>
    </ModularSpaceShip>

Author: Fabian 'x3n' Landau, Noe Pedrazzini

Member Enumeration Documentation

enum orxonox::PartDestructionEvent::TargetParam

strong

List of all allowed parameters.

Enumerator
shieldhealth
maxshieldhealth
shieldabsorption
shieldrechargerate
boostpower
boostpowerrate
rotationthrust
boostfactor
speedfront
accelerationfront
null

Constructor & Destructor Documentation

orxonox::PartDestructionEvent::PartDestructionEvent ( Context * context )

orxonox::PartDestructionEvent::~PartDestructionEvent ( )

virtual

Member Function Documentation

void orxonox::PartDestructionEvent::execute ( void )

Executes this event.

float orxonox::PartDestructionEvent::getEventValue ( )

inline

std::string orxonox::PartDestructionEvent::getMessage ( )

inline

std::string orxonox::PartDestructionEvent::getOperation ( )

inline

ShipPart* orxonox::PartDestructionEvent::getParent ( )

inline

std::string orxonox::PartDestructionEvent::getTargetName ( )

inline

std::string orxonox::PartDestructionEvent::getTargetParam ( )

inline

std::string orxonox::PartDestructionEvent::getTargetType ( )

inline

bool orxonox::PartDestructionEvent::isValid ( )

inline

float orxonox::PartDestructionEvent::operate ( float input )

Apply the configured operation and value to an input.

Parameters

input The value which should be modified

Returns: Returns the product / sum / difference of input and configured value, the configured value if the operation is "set", or 0 if the operation is "destroy"

void orxonox::PartDestructionEvent::setEventValue ( float value )

Sets the value applied with the chosen operation.

Parameters

value The value as float.

void orxonox::PartDestructionEvent::setMessage ( std::string msg )

Set the message to be shown upon execution of the vent.

Parameters

msg	The desired message as string.

void orxonox::PartDestructionEvent::setOperation ( std::string operation )

Set the operation to be applied.

Parameters

operation The desired operator as string. Valid operators: * + - destroy

void orxonox::PartDestructionEvent::setParent ( ShipPart * parent )

void orxonox::PartDestructionEvent::setTargetName ( std::string name )

void orxonox::PartDestructionEvent::setTargetParam ( std::string param )

Set the operation to be applied.

Parameters

param The desired parameter as string. Valid parameters: c.f. TargetParam

void orxonox::PartDestructionEvent::setTargetType ( std::string type )

Set type of the target.

Parameters

type	The desired target-type as string. Valid target-types: ship engine weapon

void orxonox::PartDestructionEvent::setValid ( bool valid )

inline

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

overridevirtual

XML loading and saving.

Parameters

xmlelement	The XML-element
mode	The mode defines the operation that is being executed: loading or saving the object (from or to XML respectively)

Reimplemented from orxonox::BaseObject.

Member Data Documentation

std::string orxonox::PartDestructionEvent::message_

private

The message which is shown in chat when the event is executed.

std::string orxonox::PartDestructionEvent::operation_

private

The operation to be applied.

ShipPart* orxonox::PartDestructionEvent::parent_

private

Pointer to the ShipPart this event belongs to.

std::string orxonox::PartDestructionEvent::targetName_

private

The name of the target.

TargetParam orxonox::PartDestructionEvent::targetParam_

private

The parameter to be modified.

std::string orxonox::PartDestructionEvent::targetType_

private

The type of the target. (ship weapon engine)

bool orxonox::PartDestructionEvent::valid_

private

Whether this event is valid or not.

float orxonox::PartDestructionEvent::value_

private

The value used to do the operation.

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

orxonox/items/PartDestructionEvent.h
orxonox/items/PartDestructionEvent.cc

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation