MWClass::Weapon Class Reference

#include <weapon.hpp>

List of all members.

Public Member Functions
virtual std::string	getId (const MWWorld::Ptr &ptr) const
	Return ID of ptr.
virtual void	insertObjectRendering (const MWWorld::Ptr &ptr, MWRender::RenderingInterface &renderingInterface) const
	Add reference into a cell for rendering.
virtual void	insertObject (const MWWorld::Ptr &ptr, MWWorld::PhysicsSystem &physics) const
	Add reference into a cell for rendering (default implementation: don't render anything).
virtual std::string	getName (const MWWorld::Ptr &ptr) const
virtual boost::shared_ptr < MWWorld::Action >	activate (const MWWorld::Ptr &ptr, const MWWorld::Ptr &actor) const
	Generate action for activation.
virtual bool	hasToolTip (const MWWorld::Ptr &ptr) const
virtual MWGui::ToolTipInfo	getToolTipInfo (const MWWorld::Ptr &ptr) const
virtual bool	hasItemHealth (const MWWorld::Ptr &ptr) const
virtual int	getItemMaxHealth (const MWWorld::Ptr &ptr) const
	Return item max health or throw an exception, if class does not have item health.
virtual std::string	getScript (const MWWorld::Ptr &ptr) const
	Return name of the script attached to ptr.
virtual std::pair< std::vector < int >, bool >	getEquipmentSlots (const MWWorld::Ptr &ptr) const
virtual int	getEquipmentSkill (const MWWorld::Ptr &ptr) const
virtual int	getValue (const MWWorld::Ptr &ptr) const
	Return trade value of the object. Throws an exception, if the object can't be traded.
virtual std::string	getUpSoundId (const MWWorld::Ptr &ptr) const
	Return the pick up sound Id.
virtual std::string	getDownSoundId (const MWWorld::Ptr &ptr) const
	Return the put down sound Id.
virtual std::string	getInventoryIcon (const MWWorld::Ptr &ptr) const
	Return name of inventory icon.
virtual std::string	getEnchantment (const MWWorld::Ptr &ptr) const
virtual void	applyEnchantment (const MWWorld::Ptr &ptr, const std::string &enchId, int enchCharge, const std::string &newName) const
virtual std::pair< int, std::string >	canBeEquipped (const MWWorld::Ptr &ptr, const MWWorld::Ptr &npc) const
virtual boost::shared_ptr < MWWorld::Action >	use (const MWWorld::Ptr &ptr) const
	Generate action for using via inventory menu.
virtual std::string	getModel (const MWWorld::Ptr &ptr) const
virtual bool	canSell (const MWWorld::Ptr &item, int npcServices) const
	Determine whether or not item can be sold to an npc with the given npcServices.
virtual float	getWeight (const MWWorld::Ptr &ptr) const
virtual float	getEnchantmentPoints (const MWWorld::Ptr &ptr) const
Static Public Member Functions
static void	registerSelf ()
Private Member Functions
virtual MWWorld::Ptr	copyToCellImpl (const MWWorld::Ptr &ptr, MWWorld::CellStore &cell) const

---

Member Function Documentation

boost::shared_ptr< MWWorld::Action > MWClass::Weapon::activate	(	const MWWorld::Ptr &	ptr,
		const MWWorld::Ptr &	actor
	)		const [virtual]

Generate action for activation.

Reimplemented from MWWorld::Class.

void MWClass::Weapon::applyEnchantment	(	const MWWorld::Ptr &	ptr,
		const std::string &	enchId,
		int	enchCharge,
		const std::string &	newName
	)		const [virtual]

Reimplemented from MWWorld::Class.

std::pair< int, std::string > MWClass::Weapon::canBeEquipped	(	const MWWorld::Ptr &	ptr,
		const MWWorld::Ptr &	npc
	)		const [virtual]

Return 0 if player cannot equip item. 1 if can equip. 2 if it's twohanded weapon. 3 if twohanded weapon conflicts with that. Second item in the pair specifies the error message

Reimplemented from MWWorld::Class.

bool MWClass::Weapon::canSell	(	const MWWorld::Ptr &	item,
		int	npcServices
	)		const [virtual]

Determine whether or not item can be sold to an npc with the given npcServices.

Reimplemented from MWWorld::Class.

MWWorld::Ptr MWClass::Weapon::copyToCellImpl	(	const MWWorld::Ptr &	ptr,
		MWWorld::CellStore &	cell
	)		const [private, virtual]

Reimplemented from MWWorld::Class.

std::string MWClass::Weapon::getDownSoundId

(

const MWWorld::Ptr &

ptr

)

const [virtual]

Return the put down sound Id.

Reimplemented from MWWorld::Class.

std::string MWClass::Weapon::getEnchantment

(

const MWWorld::Ptr &

ptr

)

const [virtual]

Returns:

the enchantment ID if the object is enchanted, otherwise an empty string

Reimplemented from MWWorld::Class.

float MWClass::Weapon::getEnchantmentPoints

(

const MWWorld::Ptr &

ptr

)

const [virtual]

Returns:

the number of enchantment points available for possible enchanting

Reimplemented from MWWorld::Class.

int MWClass::Weapon::getEquipmentSkill

(

const MWWorld::Ptr &

ptr

)

const [virtual]

Reimplemented from MWWorld::Class.

std::pair< std::vector< int >, bool > MWClass::Weapon::getEquipmentSlots

(

const MWWorld::Ptr &

ptr

)

const [virtual]

Returns:

first: Return IDs of the slot this object can be equipped in; second: can object stay stacked when equipped?

Reimplemented from MWWorld::Class.

std::string MWClass::Weapon::getId

(

const MWWorld::Ptr &

ptr

)

const [virtual]

Return ID of ptr.

Reimplemented from MWWorld::Class.

std::string MWClass::Weapon::getInventoryIcon

(

const MWWorld::Ptr &

ptr

)

const [virtual]

Return name of inventory icon.

Reimplemented from MWWorld::Class.

int MWClass::Weapon::getItemMaxHealth

(

const MWWorld::Ptr &

ptr

)

const [virtual]

Return item max health or throw an exception, if class does not have item health.

Reimplemented from MWWorld::Class.

std::string MWClass::Weapon::getModel

(

const MWWorld::Ptr &

ptr

)

const [virtual]

Reimplemented from MWWorld::Class.

std::string MWClass::Weapon::getName

(

const MWWorld::Ptr &

ptr

)

const [virtual]

Returns:

name (the one that is to be presented to the user; not the internal one); can return an empty string.

Implements MWWorld::Class.

std::string MWClass::Weapon::getScript

(

const MWWorld::Ptr &

ptr

)

const [virtual]

Return name of the script attached to ptr.

Reimplemented from MWWorld::Class.

MWGui::ToolTipInfo MWClass::Weapon::getToolTipInfo

(

const MWWorld::Ptr &

ptr

)

const [virtual]

Returns:

the content of the tool tip to be displayed. raises exception if the object has no tooltip.

Reimplemented from MWWorld::Class.

std::string MWClass::Weapon::getUpSoundId

(

const MWWorld::Ptr &

ptr

)

const [virtual]

Return the pick up sound Id.

Reimplemented from MWWorld::Class.

int MWClass::Weapon::getValue

(

const MWWorld::Ptr &

ptr

)

const [virtual]

Return trade value of the object. Throws an exception, if the object can't be traded.

Return the index of the skill this item corresponds to when equiopped or -1, if there is no such skill.

Reimplemented from MWWorld::Class.

float MWClass::Weapon::getWeight

(

const MWWorld::Ptr &

ptr

)

const [virtual]

Reimplemented from MWWorld::Class.

bool MWClass::Weapon::hasItemHealth

(

const MWWorld::Ptr &

ptr

)

const [virtual]

Returns:

Item health data available?

Reimplemented from MWWorld::Class.

bool MWClass::Weapon::hasToolTip

(

const MWWorld::Ptr &

ptr

)

const [virtual]

Returns:

true if this object has a tooltip when focused (default implementation: false)

Reimplemented from MWWorld::Class.

void MWClass::Weapon::insertObject	(	const MWWorld::Ptr &	ptr,
		MWWorld::PhysicsSystem &	physics
	)		const [virtual]

Add reference into a cell for rendering (default implementation: don't render anything).

Reimplemented from MWWorld::Class.

void MWClass::Weapon::insertObjectRendering	(	const MWWorld::Ptr &	ptr,
		MWRender::RenderingInterface &	renderingInterface
	)		const [virtual]

Add reference into a cell for rendering.

Reimplemented from MWWorld::Class.

void MWClass::Weapon::registerSelf

(

)

[static]

boost::shared_ptr< MWWorld::Action > MWClass::Weapon::use

(

const MWWorld::Ptr &

ptr

)

const [virtual]

Generate action for using via inventory menu.

Reimplemented from MWWorld::Class.

---

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

• apps/openmw/mwclass/weapon.hpp
• apps/openmw/mwclass/weapon.cpp