MWWorld::RefData Class Reference

#include <refdata.hpp>

Collaboration diagram for MWWorld::RefData:

Public Member Functions
	RefData ()
	RefData (const ESM::CellRef &cellRef)
	RefData (const ESM::ObjectState &objectState, bool deletedByContentFile)
	RefData (const RefData &refData)
	~RefData ()
void	write (ESM::ObjectState &objectState, const std::string &scriptId="") const
RefData &	operator= (const RefData &refData)
SceneUtil::PositionAttitudeTransform *	getBaseNode ()
	Return base node (can be a null pointer). More...
const SceneUtil::PositionAttitudeTransform *	getBaseNode () const
	Return base node (can be a null pointer). More...
void	setBaseNode (SceneUtil::PositionAttitudeTransform *base)
	Set base node (can be a null pointer). More...
int	getCount () const
void	setLocals (const ESM::Script &script)
void	setCount (int count)
void	setDeletedByContentFile (bool deleted)
bool	isDeleted () const
	Returns true if the object was either deleted by the content file or by gameplay. More...
bool	isDeletedByContentFile () const
	Returns true if the object was deleted by a content file. More...
MWScript::Locals &	getLocals ()
bool	isEnabled () const
void	enable ()
void	disable ()
void	setPosition (const ESM::Position &pos)
const ESM::Position &	getPosition () const
void	setCustomData (CustomData *data)
CustomData *	getCustomData ()
	May return a 0-pointer. The ownership of the return data object is not transferred. More...
const CustomData *	getCustomData () const
bool	activate ()
bool	onActivate ()
bool	activateByScript ()
bool	hasChanged () const
	Has this RefData changed since it was originally loaded? More...
const ESM::AnimationState &	getAnimationState () const
ESM::AnimationState &	getAnimationState ()

Private Member Functions
void	copy (const RefData &refData)
void	cleanup ()

Private Attributes
SceneUtil::PositionAttitudeTransform *	mBaseNode
MWScript::Locals	mLocals
bool	mDeletedByContentFile
bool	mEnabled
int	mCount
	0: deleted More...
ESM::Position	mPosition
ESM::AnimationState	mAnimationState
CustomData *	mCustomData
bool	mChanged
unsigned int	mFlags

Constructor & Destructor Documentation

MWWorld::RefData::RefData

(

)

MWWorld::RefData::RefData

(

const ESM::CellRef &

cellRef

)

Parameters

cellRef

Used to copy constant data such as position into this class where it can be altered without affecting the original data. This makes it possible to reset the position as the original data is still held in the CellRef

MWWorld::RefData::RefData	(	const ESM::ObjectState &	objectState,
		bool	deletedByContentFile
	)

Ignores local variables and custom data (not enough context available here to perform these operations).

MWWorld::RefData::RefData

(

const RefData &

refData

)

Here is the call graph for this function:

MWWorld::RefData::~RefData

(

)

Here is the call graph for this function:

Member Function Documentation

bool MWWorld::RefData::activate

(

)

bool MWWorld::RefData::activateByScript

(

)

Here is the caller graph for this function:

void MWWorld::RefData::cleanup ( )

private

Here is the caller graph for this function:

void MWWorld::RefData::copy ( const RefData &  refData )

private

Here is the call graph for this function:

Here is the caller graph for this function:

void MWWorld::RefData::disable

(

)

Here is the caller graph for this function:

void MWWorld::RefData::enable

(

)

Here is the caller graph for this function:

const ESM::AnimationState & MWWorld::RefData::getAnimationState

(

)

const

Here is the caller graph for this function:

ESM::AnimationState & MWWorld::RefData::getAnimationState

(

)

SceneUtil::PositionAttitudeTransform * MWWorld::RefData::getBaseNode

(

)

Return base node (can be a null pointer).

Here is the caller graph for this function:

const SceneUtil::PositionAttitudeTransform * MWWorld::RefData::getBaseNode

(

)

const

Return base node (can be a null pointer).

int MWWorld::RefData::getCount

(

)

const

Here is the caller graph for this function:

CustomData * MWWorld::RefData::getCustomData

(

)

May return a 0-pointer. The ownership of the return data object is not transferred.

Here is the caller graph for this function:

const CustomData * MWWorld::RefData::getCustomData

(

)

const

MWScript::Locals & MWWorld::RefData::getLocals

(

)

Here is the caller graph for this function:

const ESM::Position & MWWorld::RefData::getPosition

(

)

const

bool MWWorld::RefData::hasChanged

(

)

const

Has this RefData changed since it was originally loaded?

Here is the call graph for this function:

bool MWWorld::RefData::isDeleted

(

)

const

Returns true if the object was either deleted by the content file or by gameplay.

Here is the caller graph for this function:

bool MWWorld::RefData::isDeletedByContentFile

(

)

const

Returns true if the object was deleted by a content file.

Here is the caller graph for this function:

bool MWWorld::RefData::isEnabled

(

)

const

Here is the caller graph for this function:

bool MWWorld::RefData::onActivate

(

)

Here is the caller graph for this function:

RefData & MWWorld::RefData::operator=

(

const RefData &

refData

)

Here is the call graph for this function:

void MWWorld::RefData::setBaseNode

(

SceneUtil::PositionAttitudeTransform *

base

)

Set base node (can be a null pointer).

Here is the caller graph for this function:

void MWWorld::RefData::setCount

(

int

count

)

Set object count (an object pile is a simple object with a count >1).

Warning

Do not call setCount() to add or remove objects from a container or an actor's inventory. Call ContainerStore::add() or ContainerStore::remove() instead.

Here is the call graph for this function:

Here is the caller graph for this function:

void MWWorld::RefData::setCustomData

(

CustomData *

data

)

Set custom data (potentially replacing old custom data). The ownership of data is transferred to this.

Here is the caller graph for this function:

void MWWorld::RefData::setDeletedByContentFile

(

bool

deleted

)

This flag is only used for content stack loading and will not be stored in the savegame. If the object was deleted by gameplay, then use setCount(0) instead.

void MWWorld::RefData::setLocals

(

const ESM::Script &

script

)

Here is the call graph for this function:

Here is the caller graph for this function:

void MWWorld::RefData::setPosition

(

const ESM::Position &

pos

)

Here is the caller graph for this function:

void MWWorld::RefData::write	(	ESM::ObjectState &	objectState,
		const std::string &	scriptId = ""
	)		const

Ignores custom data (not enough context available here to perform this operations).

Here is the call graph for this function:

Member Data Documentation

ESM::AnimationState MWWorld::RefData::mAnimationState

private

SceneUtil::PositionAttitudeTransform* MWWorld::RefData::mBaseNode

private

bool MWWorld::RefData::mChanged

private

int MWWorld::RefData::mCount

private

0: deleted

CustomData* MWWorld::RefData::mCustomData

private

bool MWWorld::RefData::mDeletedByContentFile

private

separate delete flag used for deletion by a content file

Note

not stored in the save game file.

bool MWWorld::RefData::mEnabled

private

unsigned int MWWorld::RefData::mFlags

private

MWScript::Locals MWWorld::RefData::mLocals

private

ESM::Position MWWorld::RefData::mPosition

private

---

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

• /home/travis/build/elsid/openmw/apps/openmw/mwworld/refdata.hpp
• /home/travis/build/elsid/openmw/apps/openmw/mwworld/refdata.cpp