#include <light.hpp>

Inheritance diagram for MWClass::Light:

Collaboration diagram for MWClass::Light:

Public Member Functions
virtual void	insertObjectRendering (const MWWorld::Ptr &ptr, const std::string &model, MWRender::RenderingInterface &renderingInterface) const
	Add reference into a cell for rendering. More...

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 std::string	getName (const MWWorld::ConstPtr &ptr) const

virtual bool	hasToolTip (const MWWorld::ConstPtr &ptr) const

virtual MWGui::ToolTipInfo	getToolTipInfo (const MWWorld::ConstPtr &ptr, int count) const

virtual bool	showsInInventory (const MWWorld::ConstPtr &ptr) const

virtual boost::shared_ptr < MWWorld::Action >	activate (const MWWorld::Ptr &ptr, const MWWorld::Ptr &actor) const
	Generate action for activation. More...

virtual std::string	getScript (const MWWorld::ConstPtr &ptr) const
	Return name of the script attached to ptr. More...

virtual std::pair< std::vector < int >, bool >	getEquipmentSlots (const MWWorld::ConstPtr &ptr) const

virtual int	getValue (const MWWorld::ConstPtr &ptr) const
	Return trade value of the object. Throws an exception, if the object can't be traded. More...

virtual std::string	getUpSoundId (const MWWorld::ConstPtr &ptr) const
	Return the pick up sound Id. More...

virtual std::string	getDownSoundId (const MWWorld::ConstPtr &ptr) const
	Return the put down sound Id. More...

virtual std::string	getInventoryIcon (const MWWorld::ConstPtr &ptr) const
	Return name of inventory icon. More...

virtual boost::shared_ptr < MWWorld::Action >	use (const MWWorld::Ptr &ptr) const
	Generate action for using via inventory menu. More...

virtual void	setRemainingUsageTime (const MWWorld::Ptr &ptr, float duration) const
	Sets the remaining duration of the object. More...

virtual float	getRemainingUsageTime (const MWWorld::ConstPtr &ptr) const
	Returns the remaining duration of the object. More...

virtual std::string	getModel (const MWWorld::ConstPtr &ptr) const

virtual float	getWeight (const MWWorld::ConstPtr &ptr) 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...

std::pair< int, std::string >	canBeEquipped (const MWWorld::ConstPtr &ptr, const MWWorld::Ptr &npc) const

virtual std::string	getSound (const MWWorld::ConstPtr &ptr) const
	Returns sound id. More...

Public Member Functions inherited from MWWorld::Class
virtual	~Class ()

const std::string &	getTypeName () const

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

virtual MWMechanics::CreatureStats &	getCreatureStats (const Ptr &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 void	block (const Ptr &ptr) const

virtual bool	canBeActivated (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 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 osg::Vec3f	getRotationVector (const Ptr &ptr) const
	Return desired rotations, as euler angles. More...

virtual int	getEquipmentSkill (const ConstPtr &ptr) const

virtual float	getCapacity (const MWWorld::Ptr &ptr) const

virtual float	getEncumbrance (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	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	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 int	getServices (const MWWorld::ConstPtr &actor) 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 bool	isPersistent (const MWWorld::ConstPtr &ptr) const

virtual bool	isKey (const MWWorld::ConstPtr &ptr) const

virtual bool	isGold (const MWWorld::ConstPtr &ptr) const

virtual bool	allowTelekinesis (const MWWorld::ConstPtr &ptr) const
	Return whether this class of object can be activated with telekinesis. More...

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	isActor () 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 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...

Static Public Member Functions
static void	registerSelf ()

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)

Private Member Functions
virtual MWWorld::Ptr	copyToCellImpl (const MWWorld::ConstPtr &ptr, MWWorld::CellStore &cell) const

Additional Inherited Members
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...

Member Function Documentation

boost::shared_ptr< MWWorld::Action > MWClass::Light::activate	(	const MWWorld::Ptr &	ptr,
		const MWWorld::Ptr &	actor
	)		const

virtual

Generate action for activation.

Reimplemented from MWWorld::Class.

Here is the call graph for this function:

std::pair< int, std::string > MWClass::Light::canBeEquipped	(	const MWWorld::ConstPtr &	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

Todo:: the 2h check is repeated many times; put it in a function

Reimplemented from MWWorld::Class.

Here is the call graph for this function:

bool MWClass::Light::canSell	(	const MWWorld::ConstPtr &	item,
		int	npcServices
	)		const

virtual

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

Parameters

rendering Indicates if the scale to adjust is for the rendering mesh, or for the collision mesh

Reimplemented from MWWorld::Class.

MWWorld::Ptr MWClass::Light::copyToCellImpl	(	const MWWorld::ConstPtr &	ptr,
		MWWorld::CellStore &	cell
	)		const

privatevirtual

Reimplemented from MWWorld::Class.

Here is the call graph for this function:

std::string MWClass::Light::getDownSoundId ( const MWWorld::ConstPtr & ptr ) const

virtual

Return the put down sound Id.

Reimplemented from MWWorld::Class.

std::pair< std::vector< int >, bool > MWClass::Light::getEquipmentSlots ( const MWWorld::ConstPtr & 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.

Here is the call graph for this function:

std::string MWClass::Light::getInventoryIcon ( const MWWorld::ConstPtr & ptr ) const

virtual

Return name of inventory icon.

Reimplemented from MWWorld::Class.

Here is the call graph for this function:

std::string MWClass::Light::getModel ( const MWWorld::ConstPtr & ptr ) const

virtual

Reimplemented from MWWorld::Class.

Here is the call graph for this function:

std::string MWClass::Light::getName ( const MWWorld::ConstPtr & 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.

Here is the call graph for this function:

float MWClass::Light::getRemainingUsageTime ( const MWWorld::ConstPtr & ptr ) const

virtual

Returns the remaining duration of the object.

Reimplemented from MWWorld::Class.

Here is the call graph for this function:

std::string MWClass::Light::getScript ( const MWWorld::ConstPtr & ptr ) const

virtual

Return name of the script attached to ptr.

Reimplemented from MWWorld::Class.

Here is the call graph for this function:

std::string MWClass::Light::getSound ( const MWWorld::ConstPtr & ptr ) const

virtual

Returns sound id.

Reimplemented from MWWorld::Class.

Here is the call graph for this function:

MWGui::ToolTipInfo MWClass::Light::getToolTipInfo	(	const MWWorld::ConstPtr &	ptr,
		int	count
	)		const

virtual

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

Reimplemented from MWWorld::Class.

Here is the call graph for this function:

std::string MWClass::Light::getUpSoundId ( const MWWorld::ConstPtr & ptr ) const

virtual

Return the pick up sound Id.

Reimplemented from MWWorld::Class.

Here is the caller graph for this function:

int MWClass::Light::getValue ( const MWWorld::ConstPtr & ptr ) const

virtual

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

Reimplemented from MWWorld::Class.

Here is the call graph for this function:

float MWClass::Light::getWeight ( const MWWorld::ConstPtr & ptr ) const

virtual

Reimplemented from MWWorld::Class.

Here is the call graph for this function:

bool MWClass::Light::hasToolTip ( const MWWorld::ConstPtr & ptr ) const

virtual

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

Reimplemented from MWWorld::Class.

Here is the call graph for this function:

void MWClass::Light::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:

void MWClass::Light::insertObjectRendering	(	const MWWorld::Ptr &	ptr,
		const std::string &	model,
		MWRender::RenderingInterface &	renderingInterface
	)		const

virtual

Add reference into a cell for rendering.

Reimplemented from MWWorld::Class.

Here is the call graph for this function:

void MWClass::Light::registerSelf ( )

static

Here is the call graph for this function:

Here is the caller graph for this function:

void MWClass::Light::setRemainingUsageTime	(	const MWWorld::Ptr &	ptr,
		float	duration
	)		const

virtual

Sets the remaining duration of the object.

Reimplemented from MWWorld::Class.

Here is the call graph for this function:

bool MWClass::Light::showsInInventory ( const MWWorld::ConstPtr & ptr ) const

virtual

Return whether ptr shows in inventory views. Hidden items are not displayed and cannot be (re)moved by the user.

Returns: True if shown, false if hidden.

Reimplemented from MWWorld::Class.

Here is the call graph for this function:

boost::shared_ptr< MWWorld::Action > MWClass::Light::use ( const MWWorld::Ptr & ptr ) const

virtual

Generate action for using via inventory menu.

Reimplemented from MWWorld::Class.

Here is the call graph for this function:

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

/home/travis/build/OpenMW/openmw/apps/openmw/mwclass/light.hpp
/home/travis/build/OpenMW/openmw/apps/openmw/mwclass/light.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Additional Inherited Members

Member Function Documentation