StructureItem Class Reference

#include "Structure.h"

Inheritance diagram for StructureItem:

Collaboration diagram for StructureItem:

Public Member Functions
const ItemType &	type () const
void	SetMySE (SystemEntity *pSE)
SystemEntity *	GetMySE ()
Public Member Functions inherited from InventoryItem
	InventoryItem (uint32 _itemID, const ItemType &_type, const ItemData &_data)
	InventoryItem (const InventoryItem &oth)
	InventoryItem (InventoryItem &&oth) noexcept
InventoryItem &	operator= (const InventoryItem &oth)=delete
InventoryItem &	operator= (InventoryItem &&oth)=delete
virtual	~InventoryItem () noexcept
virtual ShipItem *	GetShipItem ()
virtual ModuleItem *	GetModuleItem ()
virtual bool	IsShipItem ()
virtual bool	IsModuleItem ()
Inventory *	GetMyInventory ()
bool	contraband () const
bool	isSingleton () const
int32	quantity () const
uint32	itemID () const
uint32	ownerID () const
uint32	locationID () const
EVEItemFlags	flag () const
const GPoint &	position () const
const ItemType &	type () const
const std::string &	itemName () const
const std::string &	customInfo () const
const char *	name ()
uint16	typeID () const
uint16	groupID () const
double	radius () const
uint8	categoryID () const
bool	isGlobal () const
bool	IsOnline ()
void	SetPosition (const GPoint &pos)
void	SetCustomInfo (const char *ci)
void	ChangeOwner (uint32 new_owner, bool notify=false)
void	Move (uint32 new_location=locTemp, EVEItemFlags flag=flagNone, bool notify=false)
void	Donate (uint32 new_owner=ownerSystem, uint32 new_location=locTemp, EVEItemFlags new_flag=flagNone, bool notify=true)
void	SendItemChange (uint32 toID, std::map< int32, PyRep * > &changes)
void	MergeTypesInCargo (ShipItem *pShip, EVEItemFlags flag=flagNone)
bool	ChangeSingleton (bool singleton, bool notify=false)
bool	AlterQuantity (int32 qty, bool notify=false)
bool	SetQuantity (int32 qty, bool notify=false, bool deleteOnZero=true)
bool	SetFlag (EVEItemFlags flag, bool notify=false)
void	SetOwner (uint32 ownerID)
void	SaveItem ()
void	UpdateLocation ()
void	UpdateLocation (uint32 locID)
virtual InventoryItemRef	Split (int32 qty=0, bool notify=true, bool silent=false)
virtual bool	Merge (InventoryItemRef to_merge, int32 qty=0, bool notify=true)
virtual void	Relocate (uint32 locID=0, EVEItemFlags flag=flagNone)
double	GetPackagedVolume ()
virtual void	SetPlayer (Client *pClient)
virtual bool	HasPilot ()
virtual Client *	GetPilot ()
void	ToVirtual (uint32 locationID)
PyRep *	GetItem () const
void	GetItemRow (PyPackedRow *into) const
void	GetItemStatusRow (PyPackedRow *into) const
void	GetChargeStatusRow (uint32 shipID, PyPackedRow *into) const
bool	Populate (Rsp_CommonGetInfo_Entry &into)
PyList *	GetItemInfo () const
PyObject *	ItemGetInfo ()
PyPackedRow *	GetItemRow () const
PyPackedRow *	GetItemStatusRow () const
PyPackedRow *	GetChargeStatusRow (uint32 shipID) const
bool	SkillCheck (InventoryItemRef refItem)
void	ClearModifiers ()
void	AddModifier (fxData &data)
void	RemoveModifier (fxData &data)
void	ResetAttributes ()
bool	HasReqSkill (const uint16 skillID)
AttributeMap *	GetAttributeMap ()
int64	GetTimeStamp ()
void	SetAttribute (uint16 attrID, int num, bool notify=true)
void	SetAttribute (uint16 attrID, uint32 num, bool notify=true)
void	SetAttribute (uint16 attrID, int64 num, bool notify=true)
void	SetAttribute (uint16 attrID, float num, bool notify=true)
void	SetAttribute (uint16 attrID, double num, bool notify=true)
void	SetAttribute (uint16 attrID, EvilNumber num, bool notify=true)
void	MultiplyAttribute (uint16 attrID, EvilNumber num, bool notify=false)
bool	HasAttribute (const uint16 attrID) const
bool	HasAttribute (const uint16 attrID, EvilNumber &value) const
bool	SaveAttributes ()
void	ResetAttribute (uint16 attrID, bool notify=false)
void	DeleteAttribute (uint16 attrID)
EvilNumber	GetAttribute (const uint16 attrID) const
EvilNumber	GetDefaultAttribute (const uint16 attrID) const
Public Member Functions inherited from RefObject
	RefObject (size_t initRefCount)
	Initializes reference count. More...
virtual	~RefObject ()
	Destructor; must be virtual. More...
size_t	GetCount ()

Static Protected Member Functions
template<class _Ty >
static RefPtr< _Ty >	_LoadItem (uint32 structureID, const ItemType &type, const ItemData &data)
Static Protected Member Functions inherited from InventoryItem
template<class _Ty >
static RefPtr< _Ty >	Load (uint32 itemID)
template<class _Ty >
static RefPtr< _Ty >	_Load (uint32 itemID)
template<class _Ty >
static RefPtr< _Ty >	_LoadItem (uint32 itemID, const ItemType &type, const ItemData &data)

Private Attributes
SystemEntity *	mySE

Friends
class	InventoryItem

Structure.cpp
Generic Base Class for POS items and entities. : Allan Date : unknown Updates: James
static StructureItemRef	Load (uint32 structureID)
static StructureItemRef	Spawn (ItemData &data)
virtual void	Delete ()
virtual void	Rename (std::string name)
virtual void	AddItem (InventoryItemRef iRef)
virtual void	RemoveItem (InventoryItemRef iRef)
PyObject *	StructureGetInfo ()
	StructureItem (uint32 _structureID, const ItemType &_itemType, const ItemData &_data)
virtual	~StructureItem ()
virtual bool	_Load ()

Additional Inherited Members
Static Public Member Functions inherited from InventoryItem
static uint32	CreateItemID (ItemData &data)
static uint32	CreateTempItemID (ItemData &data)
static InventoryItemRef	Load (uint32 itemID)
static InventoryItemRef	SpawnItem (uint32 itemID, const ItemData &data)
static InventoryItemRef	Spawn (ItemData &data)
static InventoryItemRef	SpawnTemp (ItemData &data)
Public Attributes inherited from InventoryItem
std::multimap< int8, fxData >	m_modifiers
Protected Member Functions inherited from RefObject
void	IncRef () const
	Increments reference count of object by one. More...
void	DecRef () const
	Decrements reference count of object by one. More...
Protected Attributes inherited from InventoryItem
Inventory *	pInventory
uint32	m_itemID
AttributeMap *	pAttributeMap
Protected Attributes inherited from RefObject
size_t	mRefCount
	Reference count of instance. More...
bool	mDeleted

Detailed Description

InventoryItem which represents Structure.

Definition at line 30 of file Structure.h.

Constructor & Destructor Documentation

StructureItem::StructureItem ( uint32  _structureID, const ItemType &  _itemType, const ItemData &  _data  )

protected

Definition at line 45 of file Structure.cpp.

References _log, InventoryItem::itemID(), InventoryItem::name(), and InventoryItem::pInventory.

Referenced by _LoadItem().

    : InventoryItem(_structureID, _itemType, _data)
{
    pInventory = new Inventory(InventoryItemRef(this));
    _log(ITEM__TRACE, "Created StructureItem for %s (%u).", name(), itemID());
    _log(POS__TRACE, "Created StructureItem for %s (%u).", name(), itemID());
}

Here is the call graph for this function:

Here is the caller graph for this function:

StructureItem::~StructureItem ( )

protectedvirtual

Definition at line 53 of file Structure.cpp.

References InventoryItem::pInventory, and SafeDelete().

{
    SafeDelete(pInventory);
}

Here is the call graph for this function:

Member Function Documentation

bool StructureItem::_Load ( )

protectedvirtual

Reimplemented from InventoryItem.

Definition at line 63 of file Structure.cpp.

References InventoryItem::_Load(), Inventory::LoadContents(), and InventoryItem::pInventory.

{
    if (!pInventory->LoadContents())
        return false;

    return InventoryItem::_Load();
}

Here is the call graph for this function:

template<class _Ty >

static RefPtr<_Ty> StructureItem::_LoadItem ( uint32  structureID, const ItemType &  type, const ItemData &  data  )

inlinestaticprotected

Definition at line 63 of file Structure.h.

References _log, ItemType::categoryID(), EVEDB::invCategories::Orbitals, sConfig, sDataMgr, EVEDB::invCategories::SovereigntyStructure, EVEDB::invCategories::Structure, StructureItem(), EVEDB::invCategories::StructureUpgrade, and EvE::traceStack().

    {
        if ((type.categoryID() != EVEDB::invCategories::Structure)
        and (type.categoryID() != EVEDB::invCategories::Orbitals)
        and (type.categoryID() != EVEDB::invCategories::SovereigntyStructure)
        and (type.categoryID() != EVEDB::invCategories::StructureUpgrade)) {
            _log(ITEM__ERROR, "Trying to load %s as Structure.", sDataMgr.GetCategoryName(type.categoryID()));
            if (sConfig.debug.StackTrace)
                EvE::traceStack();
            return RefPtr<_Ty>();
        }

        return StructureItemRef( new StructureItem(structureID, type, data ) );
    }

Here is the call graph for this function:

void StructureItem::AddItem ( InventoryItemRef  iRef )

virtual

Reimplemented from InventoryItem.

Definition at line 158 of file Structure.cpp.

References InventoryItem::AddItem(), RefPtr< X >::get(), SystemEntity::GetCOSE(), SystemEntity::IsCOSE(), mySE, and CustomsSE::VerifyAddItem().

{
    if (iRef.get() == nullptr)
        return;

    // test for item types and verify flags here...

    InventoryItem::AddItem(iRef);

    if (mySE->IsCOSE())
        mySE->GetCOSE()->VerifyAddItem(iRef);
}

Here is the call graph for this function:

void StructureItem::Delete ( )

virtual

Reimplemented from InventoryItem.

Definition at line 131 of file Structure.cpp.

References InventoryItem::Delete(), Inventory::DeleteContents(), and InventoryItem::pInventory.

{
    // delete contents first
    pInventory->DeleteContents();

    InventoryItem::Delete();
}

Here is the call graph for this function:

SystemEntity* StructureItem::GetMySE ( )

inline

Definition at line 52 of file Structure.h.

References mySE.

{ return mySE; }

StructureItemRef StructureItem::Load ( uint32  structureID )

static

Definition at line 58 of file Structure.cpp.

Referenced by Spawn().

{
    return InventoryItem::Load<StructureItem>(structureID);
}

Here is the caller graph for this function:

void StructureItem::RemoveItem ( InventoryItemRef  iRef )

virtual

Reimplemented from InventoryItem.

Definition at line 171 of file Structure.cpp.

References RefPtr< X >::get(), and InventoryItem::RemoveItem().

{
    if (iRef.get() == nullptr)
        return;

    InventoryItem::RemoveItem(iRef);
}

Here is the call graph for this function:

void StructureItem::Rename ( std::string  name )

virtual

Reimplemented from InventoryItem.

Definition at line 179 of file Structure.cpp.

References SystemEntity::GetPOSSE(), StructureSE::GetState(), mySE, InventoryItem::Rename(), StructureSE::SendSlimUpdate(), and EVEPOS::EntityState::Unanchored.

{
    if (mySE->GetPOSSE()->GetState() > EVEPOS::EntityState::Unanchored)
    {
        InventoryItem::Rename(name);
        mySE->GetPOSSE()->SendSlimUpdate();
    }
    else
    {
        throw UserError ("SetNameObjectMustBeAnchoredInSpace");
    }
    // {'FullPath': u'UI/Messages', 'messageID': 258480, 'label': u'SetNameObjectMustBeAnchoredInSpaceBody'}(u'You can only rename this type of object if it is anchored in space (and you have a right to do so).', None, None)
}

Here is the call graph for this function:

void StructureItem::SetMySE ( SystemEntity *  pSE )

inline

Definition at line 51 of file Structure.h.

References mySE.

{ mySE = pSE; }

StructureItemRef StructureItem::Spawn ( ItemData &  data )

static

Definition at line 71 of file Structure.cpp.

References AttrArmorDamage, AttrArmorEmDamageResonance, AttrArmorExplosiveDamageResonance, AttrArmorKineticDamageResonance, AttrArmorMaxDamageResonance, AttrArmorThermalDamageResonance, AttrCapacity, AttrDamage, AttrEmDamageResonance, AttrExplosiveDamageResonance, AttrIsGlobal, AttrKineticDamageResonance, AttrMass, AttrRadius, AttrShieldCapacity, AttrShieldCharge, AttrShieldEmDamageResonance, AttrShieldExplosiveDamageResonance, AttrShieldKineticDamageResonance, AttrShieldMaxDamageResonance, AttrShieldThermalDamageResonance, AttrThermalDamageResonance, AttrVolume, InventoryItem::CreateItemID(), EvilOne, EvilZero, EVEDB::invTypes::InterbusCustomsOffice, Load(), EVEDB::invTypes::PlanetaryCustomsOffice, and ItemData::typeID.

Referenced by InventoryItem::Spawn(), and ItemFactory::SpawnStructure().

{
    uint32 structureID = InventoryItem::CreateItemID(data);
    if (structureID < 1)
        return StructureItemRef(nullptr);
    StructureItemRef sRef = StructureItem::Load(structureID);
    // check for customs offices and set global flag
    if ((data.typeID == EVEDB::invTypes::InterbusCustomsOffice) or (data.typeID == EVEDB::invTypes::PlanetaryCustomsOffice))
    {
        sRef->SetAttribute(AttrIsGlobal, EvilOne);
    }
    // Create default dynamic attributes in the AttributeMap:
    sRef->SetAttribute(AttrMass, sRef->type().mass(), false);
    sRef->SetAttribute(AttrRadius, sRef->type().radius(), false);
    sRef->SetAttribute(AttrVolume, sRef->type().volume(), false);
    sRef->SetAttribute(AttrCapacity, sRef->type().capacity(), false);
    sRef->SetAttribute(AttrShieldCharge, sRef->GetAttribute(AttrShieldCapacity), false);

    // Check for existence of some attributes that may or may not have already been loaded and set them
    // to default values:
    if (!sRef->HasAttribute(AttrDamage))
        sRef->SetAttribute(AttrDamage, EvilZero, false);
    if (!sRef->HasAttribute(AttrArmorDamage))
        sRef->SetAttribute(AttrArmorDamage, EvilZero, false);
    if (!sRef->HasAttribute(AttrArmorMaxDamageResonance))
        sRef->SetAttribute(AttrArmorMaxDamageResonance, EvilOne, false);
    if (!sRef->HasAttribute(AttrShieldMaxDamageResonance))
        sRef->SetAttribute(AttrShieldMaxDamageResonance, EvilOne, false);

    // Shield Resonance
    if (!sRef->HasAttribute(AttrShieldEmDamageResonance))
        sRef->SetAttribute(AttrShieldEmDamageResonance, EvilOne, false);
    if (!sRef->HasAttribute(AttrShieldExplosiveDamageResonance))
        sRef->SetAttribute(AttrShieldExplosiveDamageResonance, EvilOne, false);
    if (!sRef->HasAttribute(AttrShieldKineticDamageResonance))
        sRef->SetAttribute(AttrShieldKineticDamageResonance, EvilOne, false);
    if (!sRef->HasAttribute(AttrShieldThermalDamageResonance))
        sRef->SetAttribute(AttrShieldThermalDamageResonance, EvilOne, false);
    // Armor Resonance
    if (!sRef->HasAttribute(AttrArmorEmDamageResonance))
        sRef->SetAttribute(AttrArmorEmDamageResonance, EvilOne, false);
    if (!sRef->HasAttribute(AttrArmorExplosiveDamageResonance))
        sRef->SetAttribute(AttrArmorExplosiveDamageResonance, EvilOne, false);
    if (!sRef->HasAttribute(AttrArmorKineticDamageResonance))
        sRef->SetAttribute(AttrArmorKineticDamageResonance, EvilOne, false);
    if (!sRef->HasAttribute(AttrArmorThermalDamageResonance))
        sRef->SetAttribute(AttrArmorThermalDamageResonance, EvilOne, false);
    // Hull Resonance
    if (!sRef->HasAttribute(AttrEmDamageResonance))
        sRef->SetAttribute(AttrEmDamageResonance, EvilOne, false);
    if (!sRef->HasAttribute(AttrExplosiveDamageResonance))
        sRef->SetAttribute(AttrExplosiveDamageResonance, EvilOne, false);
    if (!sRef->HasAttribute(AttrKineticDamageResonance))
        sRef->SetAttribute(AttrKineticDamageResonance, EvilOne, false);
    if (!sRef->HasAttribute(AttrThermalDamageResonance))
        sRef->SetAttribute(AttrThermalDamageResonance, EvilOne, false);

    return sRef;
}

Here is the call graph for this function:

Here is the caller graph for this function:

PyObject * StructureItem::StructureGetInfo

(

)

Definition at line 139 of file Structure.cpp.

References codelog, Inventory::LoadContents(), InventoryItem::m_itemID, InventoryItem::name(), InventoryItem::pInventory, and InventoryItem::Populate().

{
    if (!pInventory->LoadContents()) {
        codelog(ITEM__ERROR, "%s (%u): Failed to load contents for Structure", name(), m_itemID);
        return nullptr;
    }

    Rsp_CommonGetInfo result;
    Rsp_CommonGetInfo_Entry entry;

    //first populate the Structure.
    if (!Populate(entry))
        return nullptr;

    result.items[m_itemID] = entry.Encode();

    return result.Encode();
}

Here is the call graph for this function:

const ItemType& StructureItem::type ( ) const

inline

Todo:

(Allan) will probably need to rewrite all these, too. Public fields:

Definition at line 47 of file Structure.h.

References InventoryItem::type().

{ return InventoryItem::type(); }

Here is the call graph for this function:

Friends And Related Function Documentation

friend class InventoryItem

friend

Definition at line 33 of file Structure.h.

Member Data Documentation

SystemEntity* StructureItem::mySE

private

Definition at line 79 of file Structure.h.

Referenced by AddItem(), GetMySE(), Rename(), and SetMySE().

---

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

• /backups/local/src/eve/EvEmu_Crucible/src/eve-server/pos/Structure.h
• /backups/local/src/eve/EvEmu_Crucible/src/eve-server/pos/Structure.cpp