MWClass::Actor Class Reference

Class holding functionality common to Creature and NPC. More...

#include <actor.hpp>

Inheritance diagram for MWClass::Actor:

Collaboration diagram for MWClass::Actor:

Public Member Functions
virtual	~Actor ()
virtual void	adjustPosition (const MWWorld::Ptr &ptr, bool force) const
virtual void	insertObject (const MWWorld::Ptr &ptr, const std::string &model, MWPhysics::PhysicsSystem &physics) const
	Add reference into a cell for rendering (default implementation: don't render anything). More...
virtual void	block (const MWWorld::Ptr &ptr) const
virtual osg::Vec3f	getRotationVector (const MWWorld::Ptr &ptr) const
	Return desired rotations, as euler angles. More...
virtual float	getEncumbrance (const MWWorld::Ptr &ptr) const
virtual bool	allowTelekinesis (const MWWorld::ConstPtr &ptr) const
	Return whether this class of object can be activated with telekinesis. More...
virtual bool	isActor () const
virtual bool	canBeActivated (const MWWorld::Ptr &ptr) const
	Actor (const Actor &)
Actor &	operator= (const Actor &)
Public Member Functions inherited from MWWorld::Class
virtual	~Class ()
const std::string &	getTypeName () const
virtual void	insertObjectRendering (const Ptr &ptr, const std::string &mesh, MWRender::RenderingInterface &renderingInterface) const
virtual std::string	getName (const ConstPtr &ptr) const =0
virtual MWMechanics::CreatureStats &	getCreatureStats (const Ptr &ptr) const
virtual bool	hasToolTip (const ConstPtr &ptr) const
virtual MWGui::ToolTipInfo	getToolTipInfo (const ConstPtr &ptr, int count) const
virtual bool	showsInInventory (const ConstPtr &ptr) const
virtual MWMechanics::NpcStats &	getNpcStats (const Ptr &ptr) const
virtual bool	hasItemHealth (const ConstPtr &ptr) const
virtual int	getItemHealth (const ConstPtr &ptr) const
	Return current item health or throw an exception if class does not have item health. More...
virtual int	getItemMaxHealth (const ConstPtr &ptr) const
virtual void	hit (const Ptr &ptr, float attackStrength, int type=-1) const
virtual void	onHit (const MWWorld::Ptr &ptr, float damage, bool ishealth, const MWWorld::Ptr &object, const MWWorld::Ptr &attacker, const osg::Vec3f &hitPosition, bool successful) const
virtual boost::shared_ptr< Action >	activate (const Ptr &ptr, const Ptr &actor) const
	Generate action for activation (default implementation: return a null action). More...
virtual boost::shared_ptr< Action >	use (const Ptr &ptr) const
virtual ContainerStore &	getContainerStore (const Ptr &ptr) const
virtual InventoryStore &	getInventoryStore (const Ptr &ptr) const
virtual bool	hasInventoryStore (const Ptr &ptr) const
	Does this object have an inventory store, i.e. equipment slots? (default implementation: false) More...
virtual void	lock (const Ptr &ptr, int lockLevel) const
	Lock object (default implementation: throw an exception) More...
virtual void	unlock (const Ptr &ptr) const
	Unlock object (default implementation: throw an exception) More...
virtual bool	canLock (const ConstPtr &ptr) const
virtual void	setRemainingUsageTime (const Ptr &ptr, float duration) const
virtual float	getRemainingUsageTime (const ConstPtr &ptr) const
virtual std::string	getScript (const ConstPtr &ptr) const
virtual float	getSpeed (const Ptr &ptr) const
	Return movement speed. More...
virtual float	getJump (const MWWorld::Ptr &ptr) const
	Return jump velocity (not accounting for movement) More...
virtual MWMechanics::Movement &	getMovementSettings (const Ptr &ptr) const
	Return desired movement. More...
virtual std::pair< std::vector < int >, bool >	getEquipmentSlots (const ConstPtr &ptr) const
virtual int	getEquipmentSkill (const ConstPtr &ptr) const
virtual int	getValue (const ConstPtr &ptr) const
virtual float	getCapacity (const MWWorld::Ptr &ptr) const
virtual float	getNormalizedEncumbrance (const MWWorld::Ptr &ptr) const
	Returns encumbrance re-scaled to capacity. More...
virtual bool	apply (const MWWorld::Ptr &ptr, const std::string &id, const MWWorld::Ptr &actor) const
virtual void	skillUsageSucceeded (const MWWorld::Ptr &ptr, int skill, int usageType, float extraFactor=1.f) const
virtual bool	isEssential (const MWWorld::ConstPtr &ptr) const
virtual std::string	getUpSoundId (const ConstPtr &ptr) const
virtual std::string	getDownSoundId (const ConstPtr &ptr) const
virtual std::string	getSoundIdFromSndGen (const Ptr &ptr, const std::string &type) const
	Returns the sound ID for ptr of the given soundgen type. More...
virtual float	getArmorRating (const MWWorld::Ptr &ptr) const
virtual std::string	getInventoryIcon (const MWWorld::ConstPtr &ptr) const
	Return name of inventory icon. More...
virtual std::string	getEnchantment (const MWWorld::ConstPtr &ptr) const
virtual int	getEnchantmentPoints (const MWWorld::ConstPtr &ptr) const
virtual void	adjustScale (const MWWorld::ConstPtr &ptr, osg::Vec3f &scale, bool rendering) const
virtual bool	canSell (const MWWorld::ConstPtr &item, int npcServices) const
	Determine whether or not item can be sold to an npc with the given npcServices. More...
virtual int	getServices (const MWWorld::ConstPtr &actor) const
virtual std::string	getModel (const MWWorld::ConstPtr &ptr) const
virtual void	getModelsToPreload (const MWWorld::Ptr &ptr, std::vector< std::string > &models) const
	Get a list of models to preload that this object may use (directly or indirectly). default implementation: list getModel(). More...
virtual std::string	applyEnchantment (const MWWorld::ConstPtr &ptr, const std::string &enchId, int enchCharge, const std::string &newName) const
	Creates a new record using ptr as template, with the given name and the given enchantment applied to it. More...
virtual std::pair< int, std::string >	canBeEquipped (const MWWorld::ConstPtr &ptr, const MWWorld::Ptr &npc) const
virtual float	getWeight (const MWWorld::ConstPtr &ptr) const
virtual bool	isPersistent (const MWWorld::ConstPtr &ptr) const
virtual bool	isKey (const MWWorld::ConstPtr &ptr) const
virtual bool	isGold (const MWWorld::ConstPtr &ptr) const
virtual int	getBloodTexture (const MWWorld::ConstPtr &ptr) const
	Get a blood texture suitable for ptr (see Blood Texture 0-2 in Morrowind.ini) More...
virtual Ptr	copyToCell (const ConstPtr &ptr, CellStore &cell, int count) const
virtual Ptr	copyToCell (const ConstPtr &ptr, CellStore &cell, const ESM::Position &pos, int count) const
virtual bool	isNpc () const
virtual bool	isBipedal (const MWWorld::ConstPtr &ptr) const
virtual bool	canFly (const MWWorld::ConstPtr &ptr) const
virtual bool	canSwim (const MWWorld::ConstPtr &ptr) const
virtual bool	canWalk (const MWWorld::ConstPtr &ptr) const
bool	isPureWaterCreature (const MWWorld::Ptr &ptr) const
bool	isPureFlyingCreature (const MWWorld::Ptr &ptr) const
bool	isPureLandCreature (const MWWorld::Ptr &ptr) const
bool	isMobile (const MWWorld::Ptr &ptr) const
virtual int	getSkill (const MWWorld::Ptr &ptr, int skill) const
virtual void	readAdditionalState (const MWWorld::Ptr &ptr, const ESM::ObjectState &state) const
	Read additional state from state into ptr. More...
virtual void	writeAdditionalState (const MWWorld::ConstPtr &ptr, ESM::ObjectState &state) const
	Write additional state from ptr into state. More...
virtual int	getBaseGold (const MWWorld::ConstPtr &ptr) const
virtual bool	isClass (const MWWorld::ConstPtr &ptr, const std::string &className) const
virtual int	getDoorState (const MWWorld::ConstPtr &ptr) const
	0 = nothing, 1 = opening, 2 = closing More...
virtual void	setDoorState (const MWWorld::Ptr &ptr, int state) const
	This does not actually cause the door to move. Use World::activateDoor instead. More...
virtual void	respawn (const MWWorld::Ptr &ptr) const
virtual void	restock (const MWWorld::Ptr &ptr) const
virtual std::string	getSound (const MWWorld::ConstPtr &ptr) const
	Returns sound id. More...
virtual int	getBaseFightRating (const MWWorld::ConstPtr &ptr) const
virtual std::string	getPrimaryFaction (const MWWorld::ConstPtr &ptr) const
virtual int	getPrimaryFactionRank (const MWWorld::ConstPtr &ptr) const
virtual int	getEffectiveArmorRating (const MWWorld::ConstPtr &armor, const MWWorld::Ptr &actor) const
	Get the effective armor rating, factoring in the actor's skills, for the given armor. More...

Protected Member Functions
	Actor ()
Protected Member Functions inherited from MWWorld::Class
	Class ()
boost::shared_ptr< Action >	defaultItemActivate (const Ptr &ptr, const Ptr &actor) const
	Generate default action for activating inventory items. More...
virtual Ptr	copyToCellImpl (const ConstPtr &ptr, CellStore &cell) const

Additional Inherited Members
Static Public Member Functions inherited from MWWorld::Class
static const Class &	get (const std::string &key)
	If there is no class for this key, an exception is thrown. More...
static void	registerClass (const std::string &key, boost::shared_ptr< Class > instance)

Detailed Description

Class holding functionality common to Creature and NPC.

Constructor & Destructor Documentation

MWClass::Actor::Actor ( )

protected

MWClass::Actor::~Actor ( )

virtual

MWClass::Actor::Actor

(

const Actor &

)

Member Function Documentation

void MWClass::Actor::adjustPosition ( const MWWorld::Ptr &  ptr, bool  force  ) const

virtual

Adjust position to stand on ground. Must be called post model load

Parameters

force

do this even if the ptr is flying

Reimplemented from MWWorld::Class.

Here is the call graph for this function:

bool MWClass::Actor::allowTelekinesis ( const MWWorld::ConstPtr &  ptr ) const

virtual

Return whether this class of object can be activated with telekinesis.

Reimplemented from MWWorld::Class.

void MWClass::Actor::block ( const MWWorld::Ptr &  ptr ) const

virtual

Play the appropriate sound for a blocked attack, depending on the currently equipped shield (default implementation: throw an exception)

Reimplemented from MWWorld::Class.

Here is the call graph for this function:

bool MWClass::Actor::canBeActivated ( const MWWorld::Ptr &  ptr ) const

virtual

Returns

Can the player activate this object? (default implementation: true if object's user-readable name is not empty, false otherwise)

Reimplemented from MWWorld::Class.

Here is the call graph for this function:

float MWClass::Actor::getEncumbrance ( const MWWorld::Ptr &  ptr ) const

virtual

Returns total weight of objects inside this object (including modifications from magic effects). Throws an exception, if the object can't hold other objects.

Reimplemented from MWWorld::Class.

Reimplemented in MWClass::Npc.

Here is the call graph for this function:

Here is the caller graph for this function:

osg::Vec3f MWClass::Actor::getRotationVector ( const MWWorld::Ptr &  ptr ) const

virtual

Return desired rotations, as euler angles.

Reimplemented from MWWorld::Class.

Here is the call graph for this function:

void MWClass::Actor::insertObject ( const MWWorld::Ptr &  ptr, const std::string &  mesh, MWPhysics::PhysicsSystem &  physics  ) const

virtual

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

Reimplemented from MWWorld::Class.

Here is the call graph for this function:

bool MWClass::Actor::isActor ( ) const

virtual

Reimplemented from MWWorld::Class.

Actor& MWClass::Actor::operator=

(

const Actor &

)

---

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

• /home/travis/build/OpenMW/openmw/apps/openmw/mwclass/actor.hpp
• /home/travis/build/OpenMW/openmw/apps/openmw/mwclass/actor.cpp