Emergency 20 Dokumentation  4.2.0
em5::FireReceiverComponent Class Reference

EMERGENCY 5 fire receiver component class. More...

#include <FireReceiverComponent.h>

Inheritance diagram for em5::FireReceiverComponent:
qsf::Component qsf::InheritedObject qsf::WeakPtrTarget qsf::Object em5::ComplexFireComponent em5::FireComponent

Public Member Functions

 FireReceiverComponent (qsf::Prototype *prototype)
 Constructor. More...
 
virtual ~FireReceiverComponent ()
 Destructor. More...
 
virtual void addCoolingEnergySource (uint64 entityId, float extinguishEnergy, float coolingEnergy)
 Adds the entity and its cooling energy. More...
 
virtual void removeCoolingEnergySource (uint64 entityId)
 Removes the entity and its cooling energy. More...
 
virtual bool isBurning () const
 Return true if the fire is active, in this case the fire will charge by themself. More...
 
virtual bool isBurned () const
 Returns true if the total amount of material energy is used; in this case the fire is over. More...
 
float getCoolingEnergy () const
 Returns the amount of cooling energy which is currently applied to this component. More...
 
uint32 getCoolingEnergySourceCount () const
 Returns the amount of cooling energy sources that interact with this component. More...
 
void getCoolingSources (std::vector< uint64 > &coolingSourceIds) const
 
qsf::TransformComponentgetTransformComponent () const
 Returns the owning entity's transform component, in case this component is in simulating state. More...
 
virtual bool canCountedForExtinguishAchievement () const
 Is the current fire component counted for the extinguish fires achievement. More...
 
virtual void setCountedForExtinguishAchievement (bool canCounted)
 Enable or disable counting for the extinguishing fires achievement. More...
 
- Public Member Functions inherited from qsf::Component
virtual ~Component ()
 Destructor. More...
 
PrototypegetPrototype () const
 Return the prototype this component is in. More...
 
EntitygetEntity () const
 Return a reference to the entity this component is in. More...
 
uint32 getId () const
 Return the unique component identifier. More...
 
ComponentManagergetComponentManager () const
 Return the component manager that's responsible for this component instance. More...
 
ComponentCollectiongetComponentCollection () const
 Return the component collection that's responsible for this component instance. More...
 
bool isSimulating () const
 Return whether or not the component is in simulating mode. More...
 
bool isActive () const
 Return whether or not the component is considered to be active. More...
 
void setActive (bool active)
 Set whether or not the component is considered to be active. More...
 
bool isDebug () const
 Return whether or not the component is considered to be in debug mode. More...
 
bool isHidden () const
 Return whether or not the component is hidden. More...
 
void setHidden (bool hidden)
 Set whether or not the component is hidden. More...
 
bool isGloballyHidden () const
 Return whether or not the component is globally hidden. More...
 
void setGloballyHidden (bool globallyHidden)
 Set whether or not the component is globally hidden. More...
 
bool isReallyHidden () const
 Return whether or not the component is really hidden. More...
 
bool startup (bool ownerIsRunning)
 Startup the component. More...
 
bool isRunning () const
 Return whether or not the component is up-and-running. More...
 
void shutdown ()
 Shutdown the component. More...
 
uint64 getPrototypeId () const
 Return the ID of the prototype this component is in. More...
 
uint64 getEntityId () const
 Return the ID of the entity this component is in. More...
 
virtual void onInvalidation ()
 Invalidate the component. More...
 
virtual void setDebug (bool debugMode)
 Set whether or not the component is considered to be in debug mode. More...
 
virtual void serialize (BinarySerializer &serializer)
 Serialize or deserialize the component using a binary serializer. More...
 
- Public Member Functions inherited from qsf::InheritedObject
void copyPropertyOverrideStateFrom (const InheritedObject &object, bool add=false)
 
void setAllPropertyOverrideFlags (bool value)
 
void autoCreatePropertyOverrideState ()
 
virtual camp::Value getPropertyDefaultValue (const StringHash &propertyId) const override
 
virtual PropertyOverrideState getPropertyOverrideState (const StringHash &propertyId) const override
 
virtual bool setPropertyOverrideState (const StringHash &propertyId, PropertyOverrideState overrideState) override
 
- Public Member Functions inherited from qsf::Object
virtual ~Object ()
 Destructor. More...
 
const camp::Class & getCampClass () const
 Return the CAMP class. More...
 
int getPropertyIndexById (const StringHash &propertyId) const
 Return the CAMP property index by using the unique class property ID. More...
 
uint32 getPropertyIdByIndex (int index) const
 Return the unique class property ID with the given index. More...
 
std::string getPropertyNameById (const StringHash &propertyId) const
 Return the CAMP property name by using the unique class property ID. More...
 
const camp::Property * getCampPropertyById (const StringHash &propertyId) const
 Return the CAMP property by using the unique class property ID. More...
 
void setPropertyValuesByString (const std::string &values)
 Set CAMP reflection property values by using a given string. More...
 
void setPropertiesToDefaultValues ()
 Set all CAMP reflection system properties to their default values. More...
 
void serializeToBoostPTree (boost::property_tree::ptree &pTree, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL) const
 
void serializeToBoostPTree (boost::property_tree::ptree &pTree, const camp::Class &campClass, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL) const
 
bool deserializeFromBoostPTree (const boost::property_tree::ptree &pTree, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL)
 
bool deserializeFromBoostPTree (const boost::property_tree::ptree &pTree, const camp::Class &campClass, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL)
 
void serializeToBinarySerializer (BinarySerializer &serializer, SerializationMode mode=MODE_MINIMAL, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL) const
 
void deserializeFromBinarySerializer (BinarySerializer &serializer, SerializationMode mode=MODE_MINIMAL, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL, bool setOverrideState=true)
 
virtual void onPreDeserialize ()
 Called right before the object is deserialized using any of the above methods. Default implementation is empty. More...
 
virtual void onPostDeserialize ()
 Called right after the object was deserialized using any of the above methods. Default implementation is empty. More...
 
virtual ScriptgetAssociatedScript () const
 Return the script instance associated with this object instance. More...
 

Static Public Attributes

static const uint32 COMPONENT_ID
 "em5::FireReceiverComponent" unique component ID More...
 
- Static Public Attributes inherited from qsf::Component
static const uint32 COMPONENT_ID
 "qsf::Component" unique component ID More...
 

Protected Member Functions

void internalActive (bool simulating, bool active)
 Updates the registration at the fire system for getting simulation updates and taking part at the fire spread calculation. More...
 
virtual bool checkFireReceiver (qsf::Component *sender)
 Return "true" if the fire receiver is a valid target for the sender, ask the health component for dead state by default. More...
 
virtual void receiveFireEnergy (float fireEnergy, const qsf::Time &timePassed, qsf::Component *sender)
 Handle the received energy and gives it to the special receiver. More...
 
virtual void updateSimulation (const qsf::Time &timePassed)
 Update the simulation state of this component. More...
 
virtual void onSetSimulating (bool simulating) override
 Set whether or not the component is in simulating mode. More...
 
virtual void onSetActive (bool active) override
 Set whether or not the component is considered to be active. More...
 
virtual void onComponentTransformChange (const qsf::Transform &transform, TransformChangeFlags flags) override
 Called in case a component transformation value was changed. More...
 
- Protected Member Functions inherited from qsf::Component
 Component (Prototype *prototype)
 Constructor. More...
 
void promotePropertyChange (uint32 propertyId)
 A component property value was changed. More...
 
template<typename T , typename S >
bool assignAndPromoteChange (T &variable, const S &newValue, uint32 propertyId)
 Comfort function for updating an exported member variable and promoting any change that happened. More...
 
void setRegisterForSimulationTransformChanges (bool enable)
 Register or unregister this component as simulation transform listener. More...
 
void setRegisterForAnimationTransformChanges (bool enable)
 Register or unregister this component as animation transform listener. More...
 
virtual const ObjectgetPropertyDefaultsProvider () const override
 
virtual bool ignoreOwnerRunningState () const
 Return whether or not the component will only startup if the owner is in running state. More...
 
virtual bool implementsOnComponentPropertyChange () const
 Signal whether this component needs the "onComponentPropertyChange" callback at all. More...
 
virtual void onComponentPropertyChange (const Component &component, uint32 propertyId)
 Called in case a component property value was changed. More...
 
virtual void onSetDebug (bool debug)
 Set whether or not the component is considered to be in debug mode. More...
 
virtual void onSetHidden (bool hidden)
 Set whether or not the component is considered to be hidden. More...
 
virtual bool onStartup ()
 Startup the component. More...
 
virtual void onShutdown ()
 Shutdown the component. More...
 
- Protected Member Functions inherited from qsf::InheritedObject
 InheritedObject ()
 Default constructor. More...
 
- Protected Member Functions inherited from qsf::Object
 Object ()
 Default constructor. More...
 
- Protected Member Functions inherited from qsf::WeakPtrTarget
 WeakPtrTarget ()
 Default constructor. More...
 
 WeakPtrTarget (const WeakPtrTarget &other)
 Copy constructor. More...
 
 WeakPtrTarget (WeakPtrTarget &&)=delete
 Delete the move constructor, as WeakPtrTarget would need a proper move constructor-implementation that ensures that its pointer gets updated in the WeakPtrBase as well. More...
 
 ~WeakPtrTarget ()
 Destructor. More...
 
void invalidateAllWeakPtr ()
 Invalidate all weak pointers to this object. More...
 
void operator= (const WeakPtrTarget &other)
 Copy operator. More...
 

Protected Attributes

qsf::WeakPtr< qsf::TransformComponentmTransformComponent
 
qsf::WeakPtr< HealthComponentmHealthComponent
 
qsf::WeakPtr< DamageComponentmDamageComponent
 
- Protected Attributes inherited from qsf::InheritedObject
std::bitset< 128 > mPropertyOverrideFlags
 One bit for each property; if set, the property is overridden. More...
 

Friends

class FireSystem
 

Additional Inherited Members

- Public Types inherited from qsf::Component
enum  TransformChangeFlag {
  TRANSFORM_CHANGE_POSITION = 0x01, TRANSFORM_CHANGE_ROTATION = 0x02, TRANSFORM_CHANGE_SCALE = 0x04, TRANSFORM_CHANGE_TRANSFORM = 0x07,
  TRANSFORM_CHANGE_FOR_SIMULATION = 0x08, TRANSFORM_CHANGE_FOR_ANIMATION = 0x10
}
 
typedef BitFlagSet< uint8, TransformChangeFlagTransformChangeFlags
 
- Public Types inherited from qsf::Object
enum  PropertyOverrideState { PROPERTY_INVALID, PROPERTY_DEFAULT, PROPERTY_OVERRIDE, PROPERTY_REMOVED }
 
enum  SerializationMethod { SERIALIZE_FLAT, SERIALIZE_COMPLETE, SERIALIZE_DIFFERENTIAL, SERIALIZE_IGNORE_UNKNOWN }
 
enum  SerializationMode { MODE_MINIMAL, MODE_COMPATIBLE }
 

Detailed Description

EMERGENCY 5 fire receiver component class.

Remarks
A fire receiver is a simplified version of the fire component. Humans for e.g. receive energy via fire, but they handle it themself in there health component.

Constructor & Destructor Documentation

em5::FireReceiverComponent::FireReceiverComponent ( qsf::Prototype prototype)
explicit

Constructor.

Parameters
[in]prototypeThe prototype this component is in, no null pointer allowed
virtual em5::FireReceiverComponent::~FireReceiverComponent ( )
virtual

Destructor.

Member Function Documentation

virtual void em5::FireReceiverComponent::addCoolingEnergySource ( uint64  entityId,
float  extinguishEnergy,
float  coolingEnergy 
)
virtual

Adds the entity and its cooling energy.

Parameters
[in]entityIdId of the entity which applies cooling energy to the fire receiver component
[in]extinguishEnergyThe amount of extinguish energy applied (as positive value)
[in]coolingEnergyThe amount of cooling energy applied (as positive value)

Reimplemented in em5::ComplexFireComponent.

virtual bool em5::FireReceiverComponent::canCountedForExtinguishAchievement ( ) const
virtual

Is the current fire component counted for the extinguish fires achievement.

Reimplemented in em5::FireComponent, and em5::ComplexFireComponent.

virtual bool em5::FireReceiverComponent::checkFireReceiver ( qsf::Component sender)
protectedvirtual

Return "true" if the fire receiver is a valid target for the sender, ask the health component for dead state by default.

Reimplemented in em5::FireComponent, and em5::ComplexFireComponent.

float em5::FireReceiverComponent::getCoolingEnergy ( ) const

Returns the amount of cooling energy which is currently applied to this component.

Note
  • This value is usually negative
uint32 em5::FireReceiverComponent::getCoolingEnergySourceCount ( ) const

Returns the amount of cooling energy sources that interact with this component.

void em5::FireReceiverComponent::getCoolingSources ( std::vector< uint64 > &  coolingSourceIds) const
qsf::TransformComponent* em5::FireReceiverComponent::getTransformComponent ( ) const

Returns the owning entity's transform component, in case this component is in simulating state.

void em5::FireReceiverComponent::internalActive ( bool  simulating,
bool  active 
)
protected

Updates the registration at the fire system for getting simulation updates and taking part at the fire spread calculation.

bool em5::FireReceiverComponent::isBurned ( ) const
inlinevirtual

Returns true if the total amount of material energy is used; in this case the fire is over.

Reimplemented in em5::FireComponent, and em5::ComplexFireComponent.

bool em5::FireReceiverComponent::isBurning ( ) const
inlinevirtual

Return true if the fire is active, in this case the fire will charge by themself.

Reimplemented in em5::FireComponent, and em5::ComplexFireComponent.

virtual void em5::FireReceiverComponent::onComponentTransformChange ( const qsf::Transform transform,
TransformChangeFlags  flags 
)
overrideprotectedvirtual

Called in case a component transformation value was changed.

Parameters
[in]transformThe changed transformation
[in]flagsFlags describing the change
Note
  • The default implementation is empty
  • In order for this to get called at all in simulating mode, an entity has to register itself as listener for simulation and/or animation transform changes, see e.g. "qsf::Component::setRegisterForSimulationTransformChanges".

Reimplemented from qsf::Component.

virtual void em5::FireReceiverComponent::onSetActive ( bool  active)
overrideprotectedvirtual

Set whether or not the component is considered to be active.

Parameters
[in]active"true" if the component is considered to be active, else "false"
Note
  • The default implementation is empty
  • This method is only called in case there's a real state change
  • This method is also called in case the component is currently not running
See also
  • "qsf::Component::setActive()"

Reimplemented from qsf::Component.

Reimplemented in em5::FireComponent, and em5::ComplexFireComponent.

virtual void em5::FireReceiverComponent::onSetSimulating ( bool  simulating)
overrideprotectedvirtual

Set whether or not the component is in simulating mode.

Parameters
[in]active"true" if the component is in simulating mode, else "false"
Note
  • The default implementation is empty
  • This method is only called in case there's a real state change
  • In contrast to internal flags (e.g. Active, Debug), the simulating mode state can only be changed globally for a whole map
  • On component shutdown and simulating enabled, "onSetSimulating()" is automatically called with "false" before calling "onShutdown()"

Reimplemented from qsf::Component.

Reimplemented in em5::FireComponent, and em5::ComplexFireComponent.

virtual void em5::FireReceiverComponent::receiveFireEnergy ( float  fireEnergy,
const qsf::Time timePassed,
qsf::Component sender 
)
protectedvirtual

Handle the received energy and gives it to the special receiver.

Parameters
[in]fireEnergyAmount of energy which gets received
[in]timePassedTime passed since last call
[in]senderPointer to the sender of the energy, can be nullptr

Reimplemented in em5::FireComponent, and em5::ComplexFireComponent.

virtual void em5::FireReceiverComponent::removeCoolingEnergySource ( uint64  entityId)
virtual

Removes the entity and its cooling energy.

Parameters
[in]entityIdId of the entity which stopped applying cooling energy to the fire component

Reimplemented in em5::ComplexFireComponent.

virtual void em5::FireReceiverComponent::setCountedForExtinguishAchievement ( bool  canCounted)
virtual

Enable or disable counting for the extinguishing fires achievement.

Reimplemented in em5::FireComponent, and em5::ComplexFireComponent.

virtual void em5::FireReceiverComponent::updateSimulation ( const qsf::Time timePassed)
protectedvirtual

Update the simulation state of this component.

Parameters
[in]timePassedTime passed since last call

Reimplemented in em5::FireComponent, and em5::ComplexFireComponent.

Friends And Related Function Documentation

friend class FireSystem
friend

Member Data Documentation

const uint32 em5::FireReceiverComponent::COMPONENT_ID
static

"em5::FireReceiverComponent" unique component ID

qsf::WeakPtr<DamageComponent> em5::FireReceiverComponent::mDamageComponent
protected
qsf::WeakPtr<HealthComponent> em5::FireReceiverComponent::mHealthComponent
protected
qsf::WeakPtr<qsf::TransformComponent> em5::FireReceiverComponent::mTransformComponent
protected

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