#include "Prospector.h"

Inheritance diagram for Prospector:

Collaboration diagram for Prospector:

Public Member Functions
virtual	~Prospector ()

virtual Prospector *	GetProspectModule ()

virtual bool	IsProspectModule () const

virtual bool	IsSuccess ()

void	TargetDestroyed ()

Public Member Functions inherited from ActiveModule
virtual	~ActiveModule ()

virtual ActiveModule *	GetActiveModule ()

virtual bool	IsActiveModule () const

virtual void	ApplyDamage ()

virtual uint16	GetReloadTime ()

virtual uint32	GetTargetID ()

SystemEntity *	GetTargetSE ()

	ActiveModule (ModuleItemRef mRef, ShipItemRef sRef)

virtual void	Process ()

virtual void	LoadCharge (InventoryItemRef charge)

virtual void	UnloadCharge ()

virtual void	Overload ()

virtual void	AbortCycle ()

virtual void	DeOverload ()

virtual void	Deactivate (std::string effect="")

virtual void	DeactivateCycle (bool abort=false)

virtual void	RemoveTarget (SystemEntity *pSE)

virtual void	ReprocessCharge ()

void	LaunchProbe ()

void	LaunchMissile ()

void	LaunchSnowBall ()

void	ApplyEffect (int8 state, bool active=false)

void	ShowEffect (bool active=false, bool abort=false)

Public Member Functions inherited from GenericModule
ModuleItemRef	GetSelf ()

ShipItemRef	GetShipRef ()

void	Repair ()

bool	HasAttribute (uint32 attrID)

void	SetAttribute (uint32 attrID, EvilNumber val, bool update=true)

void	ResetAttribute (uint32 attrID)

EvilNumber	GetAttribute (uint32 attrID)

bool	isWarpSafe ()

bool	isTurretFitted ()

bool	isLauncherFitted ()

virtual PassiveModule *	GetPassiveModule ()

virtual MiningLaser *	GetMiningModule ()

virtual TurretModule *	GetTurretModule ()

virtual SuperWeapon *	GetSuperWeapon ()

virtual RigModule *	GetRigModule ()

virtual SubSystemModule *	GetSubSystemModule ()

virtual CynoModule *	GetCynoModule ()

virtual bool	IsGenericModule () const

virtual bool	IsPassiveModule () const

virtual bool	IsMiningLaser () const

virtual bool	IsCynoModule () const

virtual bool	IsRigModule () const

virtual bool	IsSubSystemModule () const

bool	IsLoaded ()

bool	IsTurretModule ()

bool	IsLauncherModule ()

bool	IsOverloaded ()

bool	IsLinked ()

bool	IsMaster ()

bool	IsDamaged ()

bool	IsActive ()

bool	IsLoading ()

bool	isOnline ()

bool	isLowPower ()

bool	isHighPower ()

bool	isMediumPower ()

bool	isRig ()

bool	isSubSystem ()

uint32	itemID ()

uint32	typeID ()

uint32	groupID ()

EVEItemFlags	flag ()

void	SetChargeRef (InventoryItemRef iRef)

void	SetModuleState (int8 state)

void	SetChargeState (int8 state)

void	SetLinked (bool set=false)

void	SetLinkMaster (bool set=false)

int8	GetModuleState ()

int8	GetChargeState ()

InventoryItemRef	GetLoadedChargeRef ()

virtual void	ReloadCharge ()

virtual void	RemoveRig ()

virtual void	DestroyRig ()

	GenericModule (ModuleItemRef mRef, ShipItemRef sRef)

virtual	~GenericModule ()

void	Online ()

void	Offline ()

void	ProcessEffects (int8 state, bool active=false)

void	Repair (EvilNumber amount)

int8	GetModulePowerLevel ()

Protected Attributes
bool	m_success:1

bool	m_firstRun:1

bool	m_salvager:1

bool	m_dataMiner:1

int8	m_accessChance

Protected Attributes inherited from ActiveModule
SystemBubble *	m_bubble

SystemEntity *	m_targetSE

DestinyManager *	m_destinyMgr

SystemManager *	m_sysMgr

TargetManager *	m_targMgr

uint16	m_reloadTime

uint16	m_effectID

uint32	m_targetID

bool	m_Stop:1

bool	m_usesCharge:1

bool	m_needsCharge:1

bool	m_needsTarget:1

Protected Attributes inherited from GenericModule
ModuleItemRef	m_modRef

ShipItemRef	m_shipRef

InventoryItemRef	m_chargeRef

int8	m_ModuleState

int8	m_ChargeState

int16	m_repeat

bool	m_linkMaster:1

bool	m_linked:1

bool	m_isWarpSafe:1

bool	m_hiPower:1

bool	m_medPower:1

bool	m_loPower:1

bool	m_rigSlot:1

bool	m_subSystem:1

bool	m_launcher:1

bool	m_turret:1

bool	m_overLoaded:1

bool	m_chargeLoaded:1

Private Attributes
Character *	pChar

EVEItemFlags	m_holdFlag

Prospector.cpp
prospector module class (salvage, hacking, data mining) : Allan Date : 11 August 2016 -UD/RW 12 April 2017 -UD/RW 10 February 2018
	Prospector (ModuleItemRef mRef, ShipItemRef sRef)

virtual void	Update ()

virtual void	Activate (uint16 effectID, uint32 targetID=0, int16 repeat=0)

uint32	DoCycle ()

virtual bool	CanActivate ()

void	SendFailure ()

void	CheckSuccess ()

void	DropSalvage ()

void	DropItems ()

Additional Inherited Members
Protected Member Functions inherited from ActiveModule
uint32	GetRemainingCycleTimeMS ()

void	StopTimer ()

void	Clear ()

void	ProcessActiveCycle ()

void	UpdateCharge (uint16 attrID, uint16 testAttrID, uint16 srcAttrID, InventoryItemRef iRef)

void	UpdateDamage (uint16 attrID, uint16 srcAttrID, InventoryItemRef iRef)

void	SetSlaveData (ShipSE *pShip)

void	ConsumeCharge ()

void	SetTimer (uint32 time)

Protected Member Functions inherited from GenericModule
const char *	GetModuleStateName (int8 state)

Detailed Description

Definition at line 15 of file Prospector.h.

Constructor & Destructor Documentation

Prospector::Prospector	(	ModuleItemRef	mRef,
		ShipItemRef	sRef
	)

Definition at line 18 of file Prospector.cpp.

References AttrDuration, AttrSalvageHoldCapacity, EVEDB::invGroups::Data_Miner, flagCargoHold, flagSalvageHold, RefPtr< X >::get(), EvilNumber::get_float(), GenericModule::GetAttribute(), Client::GetChar(), ShipItem::GetPilot(), Character::GetSkillLevel(), InventoryItem::groupID(), InventoryItem::HasAttribute(), ShipItem::HasPilot(), m_accessChance, m_dataMiner, m_firstRun, m_holdFlag, GenericModule::m_modRef, m_salvager, GenericModule::m_shipRef, m_success, pChar, EVEDB::invGroups::Salvager, GenericModule::SetAttribute(), and EvESkill::Survey.

 : ActiveModule(mRef, sRef)
 {
     m_success = false;
     m_firstRun = true;
     m_salvager = false;
     m_dataMiner = false;
 
     if (m_modRef->groupID() == EVEDB::invGroups::Salvager) {
         m_salvager = true;
     } else if (m_modRef->groupID() == EVEDB::invGroups::Data_Miner) {
         m_dataMiner = true;
     }
 
     m_accessChance = 0;
 
     m_holdFlag = flagCargoHold;
     if (m_shipRef->HasAttribute(AttrSalvageHoldCapacity))
         m_holdFlag = flagSalvageHold;
 
     if (!m_shipRef->HasPilot())
         return;
 
     pChar = m_shipRef->GetPilot()->GetChar().get();
 
     // increase scan speed by level of survey skill
     float cycleTime = GetAttribute(AttrDuration).get_float();
     cycleTime *= (1 + (0.03f * (pChar->GetSkillLevel(EvESkill::Survey, true))));
     SetAttribute(AttrDuration, cycleTime);
 }

Here is the call graph for this function:

virtual Prospector::~Prospector ( )

inlinevirtual

Definition at line 19 of file Prospector.h.

19 { /* do nothing here */ }

Member Function Documentation

void Prospector::Activate	(	uint16	effectID,
		uint32	targetID = `0`,
		int16	repeat = `0`
	)

virtual

Reimplemented from ActiveModule.

Definition at line 64 of file Prospector.cpp.

References ActiveModule::Activate(), AttrAccessDifficulty, ActiveModule::Deactivate(), EvilNumber::get_int(), InventoryItem::GetAttribute(), SystemEntity::GetSelf(), m_accessChance, m_firstRun, ActiveModule::m_needsTarget, m_success, and ActiveModule::m_targetSE.

 {
     // reset for each activation  MUST reset BEFORE ActiveModule::Activate() is called.....it calls salvage check.
     m_success = false;
     m_firstRun = true;
 
     ActiveModule::Activate(effectID, targetID, repeat);
 
     if (!m_needsTarget or (m_targetSE == nullptr)) {
         ActiveModule::Deactivate();
         return;
     }
     m_accessChance = m_targetSE->GetSelf()->GetAttribute(AttrAccessDifficulty).get_int();
     // are there any modifiers for access here?
     //  are rigs/skills added to module access chance?
 }

Here is the call graph for this function:

bool Prospector::CanActivate ( )

virtual

Reimplemented from ActiveModule.

Definition at line 81 of file Prospector.cpp.

References ActiveModule::CanActivate(), SystemEntity::IsContainerSE(), SystemEntity::IsWreckSE(), m_dataMiner, m_salvager, and ActiveModule::m_targetSE.

 {
     if (m_salvager)
         if (m_targetSE->IsWreckSE())
             return ActiveModule::CanActivate();
     if (m_dataMiner)
         if (m_targetSE->IsContainerSE())
             return ActiveModule::CanActivate();
 
     throw UserError ("DeniedActivateTargetModuleDisallowed");
 }

Here is the call graph for this function:

void Prospector::CheckSuccess ( )

protected

Definition at line 148 of file Prospector.cpp.

References _log, AttrAccessDifficultyBonus, EvilNumber::get_int(), GenericModule::GetAttribute(), m_accessChance, m_success, and MakeRandomInt().

Referenced by DoCycle().

 {
     int8 chance = m_accessChance;
     chance += GetAttribute(AttrAccessDifficultyBonus).get_int();
 
     uint8 roll = MakeRandomInt(0,100);
     if (roll < chance)
         m_success = true;
 
     _log(MODULE__DEBUG, "Prospector::CheckSuccess - chance: %i, roll: %u, success: %s", chance, roll, (m_success ? "true" : "false"));
 }

Here is the call graph for this function:

Here is the caller graph for this function:

uint32 Prospector::DoCycle ( )

virtual

Reimplemented from ActiveModule.

Definition at line 93 of file Prospector.cpp.

References _log, ActiveModule::AbortCycle(), CheckSuccess(), ActiveModule::DoCycle(), DropSalvage(), m_firstRun, m_success, and SendFailure().

 {
     if (m_firstRun) {
         m_firstRun = false;
     } else if (!m_success) {
         SendFailure();
         CheckSuccess();
     } else if (m_success) {
         DropSalvage();
         AbortCycle();
         return 0;
     } else {
         _log(MODULE__ERROR, "Prospector::DoCycle() hit end of conditional.");
     }
 
     return ActiveModule::DoCycle();
 }

Here is the call graph for this function:

void Prospector::DropItems ( )

protected

Definition at line 243 of file Prospector.cpp.

 {
     // this will be for data miners and hacking/archaeology shit.  dunno what all we'll need at this point.
     //  update StaticDataMgr for these items also.
 }

void Prospector::DropSalvage ( )

protected

Definition at line 160 of file Prospector.cpp.

References _log, SystemManager::AddEntity(), FactionData::allianceID, FactionData::corporationID, InventoryItem::customInfo(), SystemEntity::DestinyMgr(), FactionData::factionID, flagNone, RefPtr< X >::get(), SystemEntity::GetAllianceID(), SystemEntity::GetCorporationID(), Inventory::GetInventoryMap(), InventoryItem::GetMyInventory(), ShipItem::GetPilot(), SystemEntity::GetPosition(), SystemEntity::GetSelf(), SystemEntity::GetServices(), SystemEntity::GetWarFactionID(), SystemEntity::GetWreckSE(), Inventory::IsEmpty(), IsEven(), InventoryItem::itemID(), locTemp, m_accessChance, m_holdFlag, GenericModule::m_shipRef, ActiveModule::m_sysMgr, ActiveModule::m_targetSE, MakeRandomInt(), InventoryItem::name(), InventoryItem::ownerID(), FactionData::ownerID, pChar, WreckSE::Salvaged(), sConfig, sDataMgr, DestinyManager::SendJettisonPacket(), Client::SendNotifyMsg(), Stat::shipsSalvaged, sItemFactory, and sStatMgr.

Referenced by DoCycle().

 {
     if (m_targetSE == nullptr)
         return;
 
     std::vector<uint32> list;
     list.clear();
     sDataMgr.GetSalvage(atoi(m_targetSE->GetSelf()->customInfo().c_str()), list);
 
     if (!list.empty()) {
         uint8 drop = 0;
         switch (m_accessChance) {       // drop qty * rate in config
             case  30: drop = 1; break;  //  1 to 3
             case  20: drop = 2; break;  //  2 to 6
             case  10: drop = 3; break;  //  3 to 9
             case   0: drop = 4; break;  //  4 to 12
             case -10: drop = 5; break;  //  5 to 15
             case -20: drop = 6; break;  //  6 to 18
         }
 
         InventoryItemRef iRef(nullptr);
         Inventory* sInv(m_shipRef->GetMyInventory());
         uint32 quantity = 0, minDrop = drop, maxDrop = (drop * sConfig.rates.DropSalvage);
         for (auto cur : list) {
             // each drop has 50/50 chance.  may need to change this later.   base on char's salvage skill?
             if (IsEven(MakeRandomInt(0,10)))
                 continue;
             quantity = (MakeRandomInt(minDrop, maxDrop));
             ItemData iLoot(cur, pChar->itemID(), locTemp, flagNone, quantity);
             iRef = sItemFactory.SpawnItem(iLoot);
             if (iRef.get() == nullptr) // we'll get over it...continue
                 continue;
             if (sInv->HasAvailableSpace(m_holdFlag, iRef)) {
                 //iRef->Move(m_shipRef->itemID(), m_holdFlag, true);
                 iRef->MergeTypesInCargo(m_shipRef.get(), m_holdFlag);
                 _log(MODULE__DEBUG, "Prospector::DropSalvage - dropped %u %s of %u/%u", quantity, iRef->name(), minDrop, maxDrop);
             } else {
                 _log(MODULE__DEBUG, "Prospector::DropSalvage - %s's %s is full.", m_shipRef->name(), sDataMgr.GetFlagName(m_holdFlag));
                 m_shipRef->GetPilot()->SendNotifyMsg("Your %s is full.  Remaining salvage is lost.", sDataMgr.GetFlagName(m_holdFlag));
                 break;
             }
         }
     }
 
     if (!m_targetSE->GetSelf()->GetMyInventory()->IsEmpty()) {
 
         //{'FullPath': u'UI/Messages', 'messageID': 258062, 'label': u'SalvageTooMuchLootBody'}(u'You cannot salvage this wreck because it contains too much loot to fit into a single cargo container. <br>\r\nThe wreck contains <b>{[numeric]volume, useGrouping} m3</b> but can contain no more than <b>{[numeric]maxvolume, useGrouping} m3</b> to be salvageable.', None, {u'{[numeric]maxvolume, useGrouping}': {'conditionalValues': [], 'variableType': 9, 'propertyName': None, 'args': 32, 'kwargs': {}, 'variableName': 'maxvolume'}, u'{[numeric]volume, useGrouping}': {'conditionalValues': [], 'variableType': 9, 'propertyName': None, 'args': 32, 'kwargs': {}, 'variableName': 'volume'}})
 
         // tell wreck it's being salvaged, so do not broadcast slim updates...may no longer need this.  jetcan set to initial location 0
         m_targetSE->GetWreckSE()->Salvaged();
 
         std::map<uint32, InventoryItemRef> shipLoot;
         shipLoot.clear();
         m_targetSE->GetSelf()->GetMyInventory()->GetInventoryMap(shipLoot);
 
         // create new container
         ItemData p_idata(23,   // 23 = cargo container
                         m_targetSE->GetSelf()->ownerID(),
                         locTemp,
                         flagNone,
                         "Jettisoned Loot Container",
                         m_targetSE->GetPosition());
 
         CargoContainerRef jetCanRef = sItemFactory.SpawnCargoContainer(p_idata);
         if (jetCanRef.get() != nullptr) {
             for (auto cur : shipLoot)
                 cur.second->Move(jetCanRef->itemID(),flagNone);
             FactionData data = FactionData();
                 data.allianceID = m_targetSE->GetAllianceID();
                 data.corporationID = m_targetSE->GetCorporationID();
                 data.factionID = m_targetSE->GetWarFactionID();
                 data.ownerID = m_targetSE->GetSelf()->ownerID();
             ContainerSE* cSE = new ContainerSE(jetCanRef, m_targetSE->GetServices(), m_sysMgr, data);
             jetCanRef->SetMySE(cSE);
             m_sysMgr->AddEntity(cSE);
             m_targetSE->DestinyMgr()->SendJettisonPacket();
         }
     }
 
     // add data to StatisticMgr
     sStatMgr.Increment(Stat::shipsSalvaged);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

virtual Prospector* Prospector::GetProspectModule ( )

inlinevirtual

Reimplemented from GenericModule.

Definition at line 21 of file Prospector.h.

21 { return this; }

virtual bool Prospector::IsProspectModule ( ) const

inlinevirtual

Reimplemented from GenericModule.

Definition at line 22 of file Prospector.h.

22 { return true; }

virtual bool Prospector::IsSuccess ( )

inlinevirtual

Reimplemented from GenericModule.

Definition at line 33 of file Prospector.h.

References m_success.

33 { return m_success; }

Prospector::m_success

bool m_success

Definition: Prospector.h:44

void Prospector::SendFailure ( )

protected

Definition at line 129 of file Prospector.cpp.

References ShipItem::GetPilot(), SystemEntity::GetTypeID(), m_dataMiner, m_salvager, GenericModule::m_shipRef, ActiveModule::m_targetSE, Client::QueueDestinyEvent(), PyTuple::SetItem(), and PyDict::SetItemString().

Referenced by DoCycle().

 {
     if (m_salvager) {
         PyTuple* type = new PyTuple(2);
             type->SetItem(0, new PyInt(4));
             type->SetItem(1, new PyInt(m_targetSE->GetTypeID()));
         PyDict* dict = new PyDict;
             dict->SetItemString("type", type);
         PyTuple* tup = new PyTuple(3);
             tup->SetItem(0, new PyString("OnRemoteMessage"));
             tup->SetItem(1, new PyString("SalvagingFailure"));
             tup->SetItem(2, dict);
         m_shipRef->GetPilot()->QueueDestinyEvent(&tup);
     }
     if (m_dataMiner) {
         // not sure what client needs from this
     }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void Prospector::TargetDestroyed ( )

inline

Definition at line 36 of file Prospector.h.

References m_success.

Referenced by ActiveModule::Deactivate(), and TargetManager::Destroyed().

36 { m_success = false; }

Prospector::m_success

bool m_success

Definition: Prospector.h:44

Here is the caller graph for this function:

void Prospector::Update ( )

virtual

Reimplemented from ActiveModule.

Definition at line 49 of file Prospector.cpp.

References AttrDuration, RefPtr< X >::get(), EvilNumber::get_float(), GenericModule::GetAttribute(), Client::GetChar(), ShipItem::GetPilot(), Character::GetSkillLevel(), ShipItem::HasPilot(), GenericModule::m_shipRef, pChar, GenericModule::SetAttribute(), EvESkill::Survey, and ActiveModule::Update().

 {
     if (!m_shipRef->HasPilot())
         return;
 
     pChar = m_shipRef->GetPilot()->GetChar().get();
 
     // increase scan speed by level of survey skill
     float cycleTime = GetAttribute(AttrDuration).get_float();
     cycleTime *= (1 + (0.03f * (pChar->GetSkillLevel(EvESkill::Survey, true))));
     SetAttribute(AttrDuration, cycleTime);
 
     ActiveModule::Update();
 }

Here is the call graph for this function:

Member Data Documentation

int8 Prospector::m_accessChance

protected

Definition at line 49 of file Prospector.h.

Referenced by Activate(), CheckSuccess(), DropSalvage(), and Prospector().

bool Prospector::m_dataMiner

protected

Definition at line 47 of file Prospector.h.

Referenced by CanActivate(), Prospector(), and SendFailure().

bool Prospector::m_firstRun

protected

Definition at line 45 of file Prospector.h.

Referenced by Activate(), DoCycle(), and Prospector().

EVEItemFlags Prospector::m_holdFlag

private

Definition at line 54 of file Prospector.h.

Referenced by DropSalvage(), and Prospector().

bool Prospector::m_salvager

protected

Definition at line 46 of file Prospector.h.

Referenced by CanActivate(), Prospector(), and SendFailure().

bool Prospector::m_success

protected

Definition at line 44 of file Prospector.h.

Referenced by Activate(), CheckSuccess(), DoCycle(), IsSuccess(), Prospector(), and TargetDestroyed().

Character* Prospector::pChar

private

Definition at line 52 of file Prospector.h.

Referenced by DropSalvage(), Prospector(), and Update().

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

/backups/local/src/eve/EvEmu_Crucible/src/eve-server/ship/modules/Prospector.h
/backups/local/src/eve/EvEmu_Crucible/src/eve-server/ship/modules/Prospector.cpp

Public Member Functions

Protected Attributes

Private Attributes

Prospector.cpp

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation