MWMechanics::Alchemy Class Reference

Potion creation via alchemy skill. More...

#include <alchemy.hpp>

List of all members.

Public Types
enum	Result {   Result_Success, Result_NoMortarAndPestle, Result_LessThanTwoIngredients, Result_NoName,   Result_NoEffects, Result_RandomFailure }
typedef std::vector< MWWorld::Ptr >	TToolsContainer
typedef TToolsContainer::const_iterator	TToolsIterator
typedef std::vector< MWWorld::Ptr >	TIngredientsContainer
typedef TIngredientsContainer::const_iterator	TIngredientsIterator
typedef std::vector < ESM::ENAMstruct >	TEffectsContainer
typedef TEffectsContainer::const_iterator	TEffectsIterator
Public Member Functions
void	setAlchemist (const MWWorld::Ptr &npc)
TToolsIterator	beginTools () const
TToolsIterator	endTools () const
TIngredientsIterator	beginIngredients () const
TIngredientsIterator	endIngredients () const
void	clear ()
	Remove alchemist, tools and ingredients.
int	addIngredient (const MWWorld::Ptr &ingredient)
void	removeIngredient (int index)
	Remove ingredient from slot (calling this function on an empty slot is a no-op).
TEffectsIterator	beginEffects () const
TEffectsIterator	endEffects () const
std::string	getPotionName () const
Result	create (const std::string &name)
Private Member Functions
std::set< EffectKey >	listEffects () const
	List all effects shared by at least two ingredients.
void	applyTools (int flags, float &value) const
void	updateEffects ()
const ESM::Potion *	getRecord () const
	Return existing recrod for created potion (may return 0)
void	removeIngredients ()
void	addPotion (const std::string &name)
	Add a potion to the alchemist's inventory.
void	increaseSkill ()
	Increase alchemist's skill.
float	getChance () const
	Return chance of success.
int	countIngredients () const
Private Attributes
MWWorld::Ptr	mAlchemist
TToolsContainer	mTools
TIngredientsContainer	mIngredients
TEffectsContainer	mEffects
int	mValue

---

Detailed Description

Potion creation via alchemy skill.

---

Member Typedef Documentation

typedef std::vector<ESM::ENAMstruct> MWMechanics::Alchemy::TEffectsContainer

typedef TEffectsContainer::const_iterator MWMechanics::Alchemy::TEffectsIterator

typedef std::vector<MWWorld::Ptr> MWMechanics::Alchemy::TIngredientsContainer

typedef TIngredientsContainer::const_iterator MWMechanics::Alchemy::TIngredientsIterator

typedef std::vector<MWWorld::Ptr> MWMechanics::Alchemy::TToolsContainer

typedef TToolsContainer::const_iterator MWMechanics::Alchemy::TToolsIterator

---

Member Enumeration Documentation

enum MWMechanics::Alchemy::Result

Enumerator:

Result_Success
Result_NoMortarAndPestle
Result_LessThanTwoIngredients
Result_NoName
Result_NoEffects
Result_RandomFailure

---

Member Function Documentation

int MWMechanics::Alchemy::addIngredient

(

const MWWorld::Ptr &

ingredient

)

Add ingredient into the next free slot.

Returns:

Slot index or -1, if adding failed because of no free slot or the ingredient type being listed already.

void MWMechanics::Alchemy::addPotion

(

const std::string &

name

)

[private]

Add a potion to the alchemist's inventory.

void MWMechanics::Alchemy::applyTools	(	int	flags,
		float &	value
	)		const [private]

MWMechanics::Alchemy::TEffectsIterator MWMechanics::Alchemy::beginEffects

(

)

const

MWMechanics::Alchemy::TIngredientsIterator MWMechanics::Alchemy::beginIngredients

(

)

const

Attention:

Iterates over ingredient slots, not over ingredients. Some of the slots may be empty.

MWMechanics::Alchemy::TToolsIterator MWMechanics::Alchemy::beginTools

(

)

const

Attention:

Iterates over tool slots, not over tools. Some of the slots may be empty.

void MWMechanics::Alchemy::clear

(

)

Remove alchemist, tools and ingredients.

int MWMechanics::Alchemy::countIngredients

(

)

const [private]

MWMechanics::Alchemy::Result MWMechanics::Alchemy::create

(

const std::string &

name

)

Try to create a potion from the ingredients, place it in the inventory of the alchemist and adjust the skills of the alchemist accordingly.

Parameters:

name	must not be an empty string, unless there is already a potion record ( getPotionName() does not return an empty string).

MWMechanics::Alchemy::TEffectsIterator MWMechanics::Alchemy::endEffects

(

)

const

MWMechanics::Alchemy::TIngredientsIterator MWMechanics::Alchemy::endIngredients

(

)

const

MWMechanics::Alchemy::TToolsIterator MWMechanics::Alchemy::endTools

(

)

const

float MWMechanics::Alchemy::getChance

(

)

const [private]

Return chance of success.

std::string MWMechanics::Alchemy::getPotionName

(

)

const

Return the name of the potion that would be created when calling create (if a record for such a potion already exists) or return an empty string.

const ESM::Potion * MWMechanics::Alchemy::getRecord

(

)

const [private]

Return existing recrod for created potion (may return 0)

void MWMechanics::Alchemy::increaseSkill

(

)

[private]

Increase alchemist's skill.

std::set< MWMechanics::EffectKey > MWMechanics::Alchemy::listEffects

(

)

const [private]

List all effects shared by at least two ingredients.

void MWMechanics::Alchemy::removeIngredient

(

int

index

)

Remove ingredient from slot (calling this function on an empty slot is a no-op).

void MWMechanics::Alchemy::removeIngredients

(

)

[private]

Remove selected ingredients from alchemist's inventory, cleanup selected ingredients and update effect list accordingly.

void MWMechanics::Alchemy::setAlchemist

(

const MWWorld::Ptr &

npc

)

Set alchemist and configure alchemy setup accordingly. npc may be empty to indicate that there is no alchemist (alchemy session has ended).

void MWMechanics::Alchemy::updateEffects

(

)

[private]

---

Member Data Documentation

MWWorld::Ptr MWMechanics::Alchemy::mAlchemist [private]

TEffectsContainer MWMechanics::Alchemy::mEffects [private]

TIngredientsContainer MWMechanics::Alchemy::mIngredients [private]

TToolsContainer MWMechanics::Alchemy::mTools [private]

int MWMechanics::Alchemy::mValue [private]

---

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

• apps/openmw/mwmechanics/alchemy.hpp
• apps/openmw/mwmechanics/alchemy.cpp