MWClass::Book Class Reference

#include <book.hpp>

List of all members.

Public Member Functions
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 std::string	getScript (const MWWorld::Ptr &ptr) const
	Return name of the script attached to ptr.
virtual bool	hasToolTip (const MWWorld::Ptr &ptr) const
virtual MWGui::ToolTipInfo	getToolTipInfo (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 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 float	getEnchantmentPoints (const MWWorld::Ptr &ptr) const
virtual float	getWeight (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.
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::Book::activate	(	const MWWorld::Ptr &	ptr,
		const MWWorld::Ptr &	actor
	)		const [virtual]

Generate action for activation.

Reimplemented from MWWorld::Class.

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

Reimplemented from MWWorld::Class.

bool MWClass::Book::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::Book::copyToCellImpl	(	const MWWorld::Ptr &	ptr,
		MWWorld::CellStore &	cell
	)		const [private, virtual]

Reimplemented from MWWorld::Class.

std::string MWClass::Book::getDownSoundId

(

const MWWorld::Ptr &

ptr

)

const [virtual]

Return the put down sound Id.

Reimplemented from MWWorld::Class.

std::string MWClass::Book::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::Book::getEnchantmentPoints

(

const MWWorld::Ptr &

ptr

)

const [virtual]

Returns:

the number of enchantment points available for possible enchanting

Reimplemented from MWWorld::Class.

std::string MWClass::Book::getInventoryIcon

(

const MWWorld::Ptr &

ptr

)

const [virtual]

Return name of inventory icon.

Reimplemented from MWWorld::Class.

std::string MWClass::Book::getModel

(

const MWWorld::Ptr &

ptr

)

const [virtual]

Reimplemented from MWWorld::Class.

std::string MWClass::Book::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::Book::getScript

(

const MWWorld::Ptr &

ptr

)

const [virtual]

Return name of the script attached to ptr.

Reimplemented from MWWorld::Class.

MWGui::ToolTipInfo MWClass::Book::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::Book::getUpSoundId

(

const MWWorld::Ptr &

ptr

)

const [virtual]

Return the pick up sound Id.

Reimplemented from MWWorld::Class.

int MWClass::Book::getValue

(

const MWWorld::Ptr &

ptr

)

const [virtual]

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

Reimplemented from MWWorld::Class.

float MWClass::Book::getWeight

(

const MWWorld::Ptr &

ptr

)

const [virtual]

Reimplemented from MWWorld::Class.

bool MWClass::Book::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::Book::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::Book::insertObjectRendering	(	const MWWorld::Ptr &	ptr,
		MWRender::RenderingInterface &	renderingInterface
	)		const [virtual]

Add reference into a cell for rendering.

Reimplemented from MWWorld::Class.

void MWClass::Book::registerSelf

(

)

[static]

boost::shared_ptr< MWWorld::Action > MWClass::Book::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/book.hpp
• apps/openmw/mwclass/book.cpp