MWBase::World Class Reference

Interface for the World (implemented in MWWorld) More...

#include <world.hpp>

List of all members.

Classes
struct	DoorMarker
Public Types
enum	RenderMode { Render_CollisionDebug, Render_Wireframe, Render_Pathgrid, Render_BoundingBoxes }
enum	DetectionType { Detect_Enchantment, Detect_Key, Detect_Creature }
Public Member Functions
	World ()
virtual	~World ()
virtual void	startNewGame ()=0
virtual OEngine::Render::Fader *	getFader ()=0
	\ŧodo remove this function. Rendering details should not be exposed.
virtual MWWorld::CellStore *	getExterior (int x, int y)=0
virtual MWWorld::CellStore *	getInterior (const std::string &name)=0
virtual void	setWaterHeight (const float height)=0
virtual void	toggleWater ()=0
virtual void	adjustSky ()=0
virtual void	getTriangleBatchCount (unsigned int &triangles, unsigned int &batches)=0
virtual const MWWorld::Fallback *	getFallback () const =0
virtual MWWorld::Player &	getPlayer ()=0
virtual const MWWorld::ESMStore &	getStore () const =0
virtual std::vector < ESM::ESMReader > &	getEsmReader ()=0
virtual MWWorld::LocalScripts &	getLocalScripts ()=0
virtual bool	hasCellChanged () const =0
	Has the player moved to a different cell, since the last frame?
virtual bool	isCellExterior () const =0
virtual bool	isCellQuasiExterior () const =0
virtual Ogre::Vector2	getNorthVector (MWWorld::CellStore *cell)=0
	get north vector (OGRE coordinates) for given interior cell
virtual void	getDoorMarkers (MWWorld::CellStore *cell, std::vector< DoorMarker > &out)=0
	get a list of teleport door markers for a given cell, to be displayed on the local map
virtual void	getInteriorMapPosition (Ogre::Vector2 position, float &nX, float &nY, int &x, int &y)=0
	see MWRender::LocalMap::getInteriorMapPosition
virtual bool	isPositionExplored (float nX, float nY, int x, int y, bool interior)=0
	see MWRender::LocalMap::isPositionExplored
virtual MWWorld::Globals::Data &	getGlobalVariable (const std::string &name)=0
virtual MWWorld::Globals::Data	getGlobalVariable (const std::string &name) const =0
virtual char	getGlobalVariableType (const std::string &name) const =0
	Return ' ', if there is no global variable with this name.
virtual std::vector< std::string >	getGlobals () const =0
virtual std::string	getCurrentCellName () const =0
virtual void	removeRefScript (MWWorld::RefData *ref)=0
virtual MWWorld::Ptr	getPtr (const std::string &name, bool activeOnly)=0
virtual MWWorld::Ptr	getPtrViaHandle (const std::string &handle)=0
	Return a pointer to a liveCellRef with the given Ogre handle.
virtual MWWorld::Ptr	searchPtrViaHandle (const std::string &handle)=0
	Return a pointer to a liveCellRef with the given Ogre handle or Ptr() if not found.
virtual void	enable (const MWWorld::Ptr &ptr)=0
virtual void	disable (const MWWorld::Ptr &ptr)=0
virtual void	advanceTime (double hours)=0
	Advance in-game time.
virtual void	setHour (double hour)=0
	Set in-game time hour.
virtual void	setMonth (int month)=0
	Set in-game time month.
virtual void	setDay (int day)=0
	Set in-game time day.
virtual int	getDay ()=0
virtual int	getMonth ()=0
virtual MWWorld::TimeStamp	getTimeStamp () const =0
	Return current in-game time stamp.
virtual bool	toggleSky ()=0
virtual void	changeWeather (const std::string &region, unsigned int id)=0
virtual int	getCurrentWeather () const =0
virtual int	getMasserPhase () const =0
virtual int	getSecundaPhase () const =0
virtual void	setMoonColour (bool red)=0
virtual void	modRegion (const std::string &regionid, const std::vector< char > &chances)=0
virtual float	getTimeScaleFactor () const =0
virtual void	changeToInteriorCell (const std::string &cellName, const ESM::Position &position)=0
	Move to interior cell.
virtual void	changeToExteriorCell (const ESM::Position &position)=0
	Move to exterior cell.
virtual const ESM::Cell *	getExterior (const std::string &cellName) const =0
	Return a cell matching the given name or a 0-pointer, if there is no such cell.
virtual void	markCellAsUnchanged ()=0
virtual MWWorld::Ptr	getFacedObject ()=0
	Return pointer to the object the player is looking at, if it is within activation range.
virtual std::pair < MWWorld::Ptr, Ogre::Vector3 >	getHitContact (const MWWorld::Ptr &ptr, float distance)=0
virtual void	adjustPosition (const MWWorld::Ptr &ptr)=0
	Adjust position after load to be on ground. Must be called after model load.
virtual void	deleteObject (const MWWorld::Ptr &ptr)=0
virtual void	moveObject (const MWWorld::Ptr &ptr, float x, float y, float z)=0
virtual void	moveObject (const MWWorld::Ptr &ptr, MWWorld::CellStore &newCell, float x, float y, float z)=0
virtual void	scaleObject (const MWWorld::Ptr &ptr, float scale)=0
virtual void	rotateObject (const MWWorld::Ptr &ptr, float x, float y, float z, bool adjust=false)=0
virtual void	localRotateObject (const MWWorld::Ptr &ptr, float x, float y, float z)=0
virtual MWWorld::Ptr	safePlaceObject (const MWWorld::Ptr &ptr, MWWorld::CellStore &Cell, ESM::Position pos)=0
	place an object in a "safe" location (ie not in the void, etc).
virtual void	indexToPosition (int cellX, int cellY, float &x, float &y, bool centre=false) const =0
	Convert cell numbers to position.
virtual void	positionToIndex (float x, float y, int &cellX, int &cellY) const =0
	Convert position to cell numbers.
virtual void	queueMovement (const MWWorld::Ptr &ptr, const Ogre::Vector3 &velocity)=0
virtual bool	castRay (float x1, float y1, float z1, float x2, float y2, float z2)=0
	cast a Ray and return true if there is an object in the ray path.
virtual bool	toggleCollisionMode ()=0
virtual bool	toggleRenderMode (RenderMode mode)=0
virtual const ESM::Potion *	createRecord (const ESM::Potion &record)=0
virtual const ESM::Spell *	createRecord (const ESM::Spell &record)=0
virtual const ESM::Class *	createRecord (const ESM::Class &record)=0
virtual const ESM::Cell *	createRecord (const ESM::Cell &record)=0
virtual const ESM::NPC *	createRecord (const ESM::NPC &record)=0
virtual const ESM::Armor *	createRecord (const ESM::Armor &record)=0
virtual const ESM::Weapon *	createRecord (const ESM::Weapon &record)=0
virtual const ESM::Clothing *	createRecord (const ESM::Clothing &record)=0
virtual const ESM::Enchantment *	createRecord (const ESM::Enchantment &record)=0
virtual const ESM::Book *	createRecord (const ESM::Book &record)=0
virtual void	update (float duration, bool paused)=0
virtual bool	placeObject (const MWWorld::Ptr &object, float cursorX, float cursorY, int amount)=0
virtual void	dropObjectOnGround (const MWWorld::Ptr &actor, const MWWorld::Ptr &object, int amount)=0
virtual bool	canPlaceObject (float cursorX, float cursorY)=0
virtual void	processChangedSettings (const Settings::CategorySettingVector &settings)=0
virtual bool	isFlying (const MWWorld::Ptr &ptr) const =0
virtual bool	isSlowFalling (const MWWorld::Ptr &ptr) const =0
virtual bool	isSwimming (const MWWorld::Ptr &object) const =0
virtual bool	isSubmerged (const MWWorld::Ptr &object) const =0
	Is the head of the creature underwater?
virtual bool	isUnderwater (const MWWorld::Ptr::CellStore *cell, const Ogre::Vector3 &pos) const =0
virtual bool	isOnGround (const MWWorld::Ptr &ptr) const =0
virtual void	togglePOV ()=0
virtual void	togglePreviewMode (bool enable)=0
virtual bool	toggleVanityMode (bool enable)=0
virtual void	allowVanityMode (bool allow)=0
virtual void	togglePlayerLooking (bool enable)=0
virtual void	changeVanityModeScale (float factor)=0
virtual bool	vanityRotateCamera (float *rot)=0
virtual void	setCameraDistance (float dist, bool adjust=false, bool override=true)=0
virtual void	setupPlayer ()=0
virtual void	renderPlayer ()=0
virtual bool	getOpenOrCloseDoor (const MWWorld::Ptr &door)=0
	if activated, should this door be opened or closed?
virtual void	activateDoor (const MWWorld::Ptr &door)=0
	activate (open or close) an non-teleport door
virtual bool	getPlayerStandingOn (const MWWorld::Ptr &object)=0
virtual bool	getActorStandingOn (const MWWorld::Ptr &object)=0
virtual float	getWindSpeed ()=0
virtual void	getContainersOwnedBy (const MWWorld::Ptr &npc, std::vector< MWWorld::Ptr > &out)=0
	get all containers in active cells owned by this Npc
virtual void	getItemsOwnedBy (const MWWorld::Ptr &npc, std::vector< MWWorld::Ptr > &out)=0
	get all items in active cells owned by this Npc
virtual bool	getLOS (const MWWorld::Ptr &npc, const MWWorld::Ptr &targetNpc)=0
	get Line of Sight (morrowind stupid implementation)
virtual void	enableActorCollision (const MWWorld::Ptr &actor, bool enable)=0
virtual void	setupExternalRendering (MWRender::ExternalRendering &rendering)=0
virtual int	canRest ()=0
virtual MWRender::Animation *	getAnimation (const MWWorld::Ptr &ptr)=0
virtual void	playVideo (const std::string &name, bool allowSkipping)=0
virtual void	stopVideo ()=0
virtual void	frameStarted (float dt, bool paused)=0
virtual bool	findExteriorPosition (const std::string &name, ESM::Position &pos)=0
virtual bool	findInteriorPosition (const std::string &name, ESM::Position &pos)=0
virtual void	enableTeleporting (bool enable)=0
	Enables or disables use of teleport spell effects (recall, intervention, etc).
virtual bool	isTeleportingEnabled () const =0
	Returns true if teleport spell effects are allowed.
virtual void	enableLevitation (bool enable)=0
	Enables or disables use of levitation spell effect.
virtual bool	isLevitationEnabled () const =0
	Returns true if levitation spell effect is allowed.
virtual void	setWerewolf (const MWWorld::Ptr &actor, bool werewolf)=0
	Turn actor into werewolf or normal form.
virtual void	applyWerewolfAcrobatics (const MWWorld::Ptr &actor)=0
virtual bool	getGodModeState ()=0
virtual bool	toggleGodMode ()=0
virtual bool	startSpellCast (const MWWorld::Ptr &actor)=0
	startSpellCast attempt to start casting a spell. Might fail immediately if conditions are not met.
virtual void	castSpell (const MWWorld::Ptr &actor)=0
virtual void	launchProjectile (const std::string &id, bool stack, const ESM::EffectList &effects, const MWWorld::Ptr &actor, const std::string &sourceName)=0
virtual void	breakInvisibility (const MWWorld::Ptr &actor)=0
virtual bool	isDark () const =0
virtual bool	findInteriorPositionInWorldSpace (MWWorld::CellStore *cell, Ogre::Vector3 &result)=0
virtual void	teleportToClosestMarker (const MWWorld::Ptr &ptr, const std::string &id, Ogre::Vector3 worldPos)=0
virtual void	listDetectedReferences (const MWWorld::Ptr &ptr, std::vector< MWWorld::Ptr > &out, DetectionType type)=0
Private Member Functions
	World (const World &)
	not implemented
World &	operator= (const World &)
	not implemented

---

Detailed Description

Interface for the World (implemented in MWWorld)

---

Member Enumeration Documentation

enum MWBase::World::DetectionType

Enumerator:

Detect_Enchantment
Detect_Key
Detect_Creature

enum MWBase::World::RenderMode

Enumerator:

Render_CollisionDebug
Render_Wireframe
Render_Pathgrid
Render_BoundingBoxes

---

Constructor & Destructor Documentation

MWBase::World::World

(

const World &

)

[private]

not implemented

MWBase::World::World

(

)

[inline]

virtual MWBase::World::~World

(

)

[inline, virtual]

Reimplemented in MWWorld::World.

---

Member Function Documentation

virtual void MWBase::World::activateDoor

(

const MWWorld::Ptr &

door

)

[pure virtual]

activate (open or close) an non-teleport door

Implemented in MWWorld::World.

virtual void MWBase::World::adjustPosition

(

const MWWorld::Ptr &

ptr

)

[pure virtual]

Adjust position after load to be on ground. Must be called after model load.

Implemented in MWWorld::World.

virtual void MWBase::World::adjustSky

(

)

[pure virtual]

Implemented in MWWorld::World.

virtual void MWBase::World::advanceTime

(

double

hours

)

[pure virtual]

Advance in-game time.

Implemented in MWWorld::World.

virtual void MWBase::World::allowVanityMode

(

bool

allow

)

[pure virtual]

Implemented in MWWorld::World.

virtual void MWBase::World::applyWerewolfAcrobatics

(

const MWWorld::Ptr &

actor

)

[pure virtual]

Sets the NPC's Acrobatics skill to match the fWerewolfAcrobatics GMST. It only applies to the current form the NPC is in.

Implemented in MWWorld::World.

virtual void MWBase::World::breakInvisibility

(

const MWWorld::Ptr &

actor

)

[pure virtual]

Implemented in MWWorld::World.

virtual bool MWBase::World::canPlaceObject	(	float	cursorX,
		float	cursorY
	)		[pure virtual]

Returns:

true if it is possible to place on object at specified cursor location

Implemented in MWWorld::World.

virtual int MWBase::World::canRest

(

)

[pure virtual]

check if the player is allowed to rest
0 - yes
1 - only waiting
2 - player is underwater
3 - enemies are nearby (not implemented)

Implemented in MWWorld::World.

virtual bool MWBase::World::castRay	(	float	x1,
		float	y1,
		float	z1,
		float	x2,
		float	y2,
		float	z2
	)		[pure virtual]

cast a Ray and return true if there is an object in the ray path.

Implemented in MWWorld::World.

virtual void MWBase::World::castSpell

(

const MWWorld::Ptr &

actor

)

[pure virtual]

Implemented in MWWorld::World.

virtual void MWBase::World::changeToExteriorCell

(

const ESM::Position &

position

)

[pure virtual]

Move to exterior cell.

Implemented in MWWorld::World.

virtual void MWBase::World::changeToInteriorCell	(	const std::string &	cellName,
		const ESM::Position &	position
	)		[pure virtual]

Move to interior cell.

Implemented in MWWorld::World.

virtual void MWBase::World::changeVanityModeScale

(

float

factor

)

[pure virtual]

Implemented in MWWorld::World.

virtual void MWBase::World::changeWeather	(	const std::string &	region,
		unsigned int	id
	)		[pure virtual]

Implemented in MWWorld::World.

virtual const ESM::Potion* MWBase::World::createRecord

(

const ESM::Potion &

record

)

[pure virtual]

Create a new record (of type potion) in the ESM store.

Returns:

pointer to created record

Implemented in MWWorld::World.

virtual const ESM::Spell* MWBase::World::createRecord

(

const ESM::Spell &

record

)

[pure virtual]

Create a new record (of type spell) in the ESM store.

Returns:

pointer to created record

Implemented in MWWorld::World.

virtual const ESM::Class* MWBase::World::createRecord

(

const ESM::Class &

record

)

[pure virtual]

Create a new record (of type class) in the ESM store.

Returns:

pointer to created record

Implemented in MWWorld::World.

virtual const ESM::Cell* MWBase::World::createRecord

(

const ESM::Cell &

record

)

[pure virtual]

Create a new record (of type cell) in the ESM store.

Returns:

pointer to created record

Implemented in MWWorld::World.

virtual const ESM::NPC* MWBase::World::createRecord

(

const ESM::NPC &

record

)

[pure virtual]

Create a new record (of type npc) in the ESM store.

Returns:

pointer to created record

Implemented in MWWorld::World.

virtual const ESM::Armor* MWBase::World::createRecord

(

const ESM::Armor &

record

)

[pure virtual]

Create a new record (of type armor) in the ESM store.

Returns:

pointer to created record

Implemented in MWWorld::World.

virtual const ESM::Weapon* MWBase::World::createRecord

(

const ESM::Weapon &

record

)

[pure virtual]

Create a new record (of type weapon) in the ESM store.

Returns:

pointer to created record

Implemented in MWWorld::World.

virtual const ESM::Clothing* MWBase::World::createRecord

(

const ESM::Clothing &

record

)

[pure virtual]

Create a new record (of type clothing) in the ESM store.

Returns:

pointer to created record

Implemented in MWWorld::World.

virtual const ESM::Enchantment* MWBase::World::createRecord

(

const ESM::Enchantment &

record

)

[pure virtual]

Create a new record (of type enchantment) in the ESM store.

Returns:

pointer to created record

Implemented in MWWorld::World.

virtual const ESM::Book* MWBase::World::createRecord

(

const ESM::Book &

record

)

[pure virtual]

Create a new record (of type book) in the ESM store.

Returns:

pointer to created record

Implemented in MWWorld::World.

virtual void MWBase::World::deleteObject

(

const MWWorld::Ptr &

ptr

)

[pure virtual]

Implemented in MWWorld::World.

virtual void MWBase::World::disable

(

const MWWorld::Ptr &

ptr

)

[pure virtual]

Todo:

disable reference in the OGRE scene

Implemented in MWWorld::World.

virtual void MWBase::World::dropObjectOnGround	(	const MWWorld::Ptr &	actor,
		const MWWorld::Ptr &	object,
		int	amount
	)		[pure virtual]

copy and place an object into the gameworld at the given actor's position

Parameters:

actor	giving the dropped object position
object
number	of objects to place

Implemented in MWWorld::World.

virtual void MWBase::World::enable

(

const MWWorld::Ptr &

ptr

)

[pure virtual]

Todo:

enable reference in the OGRE scene

Implemented in MWWorld::World.

virtual void MWBase::World::enableActorCollision	(	const MWWorld::Ptr &	actor,
		bool	enable
	)		[pure virtual]

Implemented in MWWorld::World.

virtual void MWBase::World::enableLevitation

(

bool

enable

)

[pure virtual]

Enables or disables use of levitation spell effect.

Implemented in MWWorld::World.

virtual void MWBase::World::enableTeleporting

(

bool

enable

)

[pure virtual]

Enables or disables use of teleport spell effects (recall, intervention, etc).

Implemented in MWWorld::World.

virtual bool MWBase::World::findExteriorPosition	(	const std::string &	name,
		ESM::Position &	pos
	)		[pure virtual]

Find default position inside exterior cell specified by name

Returns:

false if exterior with given name not exists, true otherwise

Implemented in MWWorld::World.

virtual bool MWBase::World::findInteriorPosition	(	const std::string &	name,
		ESM::Position &	pos
	)		[pure virtual]

Find default position inside interior cell specified by name

Returns:

false if interior with given name not exists, true otherwise

Implemented in MWWorld::World.

virtual bool MWBase::World::findInteriorPositionInWorldSpace	(	MWWorld::CellStore *	cell,
		Ogre::Vector3 &	result
	)		[pure virtual]

Implemented in MWWorld::World.

virtual void MWBase::World::frameStarted	(	float	dt,
		bool	paused
	)		[pure virtual]

Implemented in MWWorld::World.

virtual bool MWBase::World::getActorStandingOn

(

const MWWorld::Ptr &

object

)

[pure virtual]

Returns:

true if any actor is standing on object

Implemented in MWWorld::World.

virtual MWRender::Animation* MWBase::World::getAnimation

(

const MWWorld::Ptr &

ptr

)

[pure virtual]

Todo:

Probably shouldn't be here

Implemented in MWWorld::World.

virtual void MWBase::World::getContainersOwnedBy	(	const MWWorld::Ptr &	npc,
		std::vector< MWWorld::Ptr > &	out
	)		[pure virtual]

get all containers in active cells owned by this Npc

virtual std::string MWBase::World::getCurrentCellName

(

)

const [pure virtual]

Implemented in MWWorld::World.

virtual int MWBase::World::getCurrentWeather

(

)

const [pure virtual]

Implemented in MWWorld::World.

virtual int MWBase::World::getDay

(

)

[pure virtual]

Implemented in MWWorld::World.

virtual void MWBase::World::getDoorMarkers	(	MWWorld::CellStore *	cell,
		std::vector< DoorMarker > &	out
	)		[pure virtual]

get a list of teleport door markers for a given cell, to be displayed on the local map

Implemented in MWWorld::World.

virtual std::vector<ESM::ESMReader>& MWBase::World::getEsmReader

(

)

[pure virtual]

Implemented in MWWorld::World.

virtual MWWorld::CellStore* MWBase::World::getExterior	(	int	x,
		int	y
	)		[pure virtual]

Implemented in MWWorld::World.

virtual const ESM::Cell* MWBase::World::getExterior

(

const std::string &

cellName

)

const [pure virtual]

Return a cell matching the given name or a 0-pointer, if there is no such cell.

Implemented in MWWorld::World.

virtual MWWorld::Ptr MWBase::World::getFacedObject

(

)

[pure virtual]

Return pointer to the object the player is looking at, if it is within activation range.

Implemented in MWWorld::World.

virtual OEngine::Render::Fader* MWBase::World::getFader

(

)

[pure virtual]

\ŧodo remove this function. Rendering details should not be exposed.

Implemented in MWWorld::World.

virtual const MWWorld::Fallback* MWBase::World::getFallback

(

)

const [pure virtual]

Implemented in MWWorld::World.

virtual std::vector<std::string> MWBase::World::getGlobals

(

)

const [pure virtual]

Implemented in MWWorld::World.

virtual MWWorld::Globals::Data& MWBase::World::getGlobalVariable

(

const std::string &

name

)

[pure virtual]

Implemented in MWWorld::World.

virtual MWWorld::Globals::Data MWBase::World::getGlobalVariable

(

const std::string &

name

)

const [pure virtual]

Implemented in MWWorld::World.

virtual char MWBase::World::getGlobalVariableType

(

const std::string &

name

)

const [pure virtual]

Return ' ', if there is no global variable with this name.

Implemented in MWWorld::World.

virtual bool MWBase::World::getGodModeState

(

)

[pure virtual]

Implemented in MWWorld::World.

virtual std::pair<MWWorld::Ptr,Ogre::Vector3> MWBase::World::getHitContact	(	const MWWorld::Ptr &	ptr,
		float	distance
	)		[pure virtual]

Returns a pointer to the object the provided object would hit (if within the specified distance), and the point where the hit occurs. This will attempt to use the "Head" node as a basis.

Implemented in MWWorld::World.

virtual MWWorld::CellStore* MWBase::World::getInterior

(

const std::string &

name

)

[pure virtual]

Implemented in MWWorld::World.

virtual void MWBase::World::getInteriorMapPosition	(	Ogre::Vector2	position,
		float &	nX,
		float &	nY,
		int &	x,
		int &	y
	)		[pure virtual]

see MWRender::LocalMap::getInteriorMapPosition

Implemented in MWWorld::World.

virtual void MWBase::World::getItemsOwnedBy	(	const MWWorld::Ptr &	npc,
		std::vector< MWWorld::Ptr > &	out
	)		[pure virtual]

get all items in active cells owned by this Npc

virtual MWWorld::LocalScripts& MWBase::World::getLocalScripts

(

)

[pure virtual]

Implemented in MWWorld::World.

virtual bool MWBase::World::getLOS	(	const MWWorld::Ptr &	npc,
		const MWWorld::Ptr &	targetNpc
	)		[pure virtual]

get Line of Sight (morrowind stupid implementation)

Implemented in MWWorld::World.

virtual int MWBase::World::getMasserPhase

(

)

const [pure virtual]

Implemented in MWWorld::World.

virtual int MWBase::World::getMonth

(

)

[pure virtual]

Implemented in MWWorld::World.

virtual Ogre::Vector2 MWBase::World::getNorthVector

(

MWWorld::CellStore *

cell

)

[pure virtual]

get north vector (OGRE coordinates) for given interior cell

Implemented in MWWorld::World.

virtual bool MWBase::World::getOpenOrCloseDoor

(

const MWWorld::Ptr &

door

)

[pure virtual]

if activated, should this door be opened or closed?

Implemented in MWWorld::World.

virtual MWWorld::Player& MWBase::World::getPlayer

(

)

[pure virtual]

Implemented in MWWorld::World.

virtual bool MWBase::World::getPlayerStandingOn

(

const MWWorld::Ptr &

object

)

[pure virtual]

Returns:

true if the player is standing on object

Implemented in MWWorld::World.

virtual MWWorld::Ptr MWBase::World::getPtr	(	const std::string &	name,
		bool	activeOnly
	)		[pure virtual]

Return a pointer to a liveCellRef with the given name.

Parameters:

activeOnly

do non search inactive cells.

Implemented in MWWorld::World.

virtual MWWorld::Ptr MWBase::World::getPtrViaHandle

(

const std::string &

handle

)

[pure virtual]

Return a pointer to a liveCellRef with the given Ogre handle.

Implemented in MWWorld::World.

virtual int MWBase::World::getSecundaPhase

(

)

const [pure virtual]

Implemented in MWWorld::World.

virtual const MWWorld::ESMStore& MWBase::World::getStore

(

)

const [pure virtual]

Implemented in MWWorld::World.

virtual float MWBase::World::getTimeScaleFactor

(

)

const [pure virtual]

Implemented in MWWorld::World.

virtual MWWorld::TimeStamp MWBase::World::getTimeStamp

(

)

const [pure virtual]

Return current in-game time stamp.

Implemented in MWWorld::World.

virtual void MWBase::World::getTriangleBatchCount	(	unsigned int &	triangles,
		unsigned int &	batches
	)		[pure virtual]

Implemented in MWWorld::World.

virtual float MWBase::World::getWindSpeed

(

)

[pure virtual]

Implemented in MWWorld::World.

virtual bool MWBase::World::hasCellChanged

(

)

const [pure virtual]

Has the player moved to a different cell, since the last frame?

Implemented in MWWorld::World.

virtual void MWBase::World::indexToPosition	(	int	cellX,
		int	cellY,
		float &	x,
		float &	y,
		bool	centre = false
	)		const [pure virtual]

Convert cell numbers to position.

Implemented in MWWorld::World.

virtual bool MWBase::World::isCellExterior

(

)

const [pure virtual]

Implemented in MWWorld::World.

virtual bool MWBase::World::isCellQuasiExterior

(

)

const [pure virtual]

Implemented in MWWorld::World.

virtual bool MWBase::World::isDark

(

)

const [pure virtual]

Implemented in MWWorld::World.

virtual bool MWBase::World::isFlying

(

const MWWorld::Ptr &

ptr

)

const [pure virtual]

Implemented in MWWorld::World.

virtual bool MWBase::World::isLevitationEnabled

(

)

const [pure virtual]

Returns true if levitation spell effect is allowed.

Implemented in MWWorld::World.

virtual bool MWBase::World::isOnGround

(

const MWWorld::Ptr &

ptr

)

const [pure virtual]

Implemented in MWWorld::World.

virtual bool MWBase::World::isPositionExplored	(	float	nX,
		float	nY,
		int	x,
		int	y,
		bool	interior
	)		[pure virtual]

see MWRender::LocalMap::isPositionExplored

Implemented in MWWorld::World.

virtual bool MWBase::World::isSlowFalling

(

const MWWorld::Ptr &

ptr

)

const [pure virtual]

Implemented in MWWorld::World.

virtual bool MWBase::World::isSubmerged

(

const MWWorld::Ptr &

object

)

const [pure virtual]

Is the head of the creature underwater?

Implemented in MWWorld::World.

virtual bool MWBase::World::isSwimming

(

const MWWorld::Ptr &

object

)

const [pure virtual]

Implemented in MWWorld::World.

virtual bool MWBase::World::isTeleportingEnabled

(

)

const [pure virtual]

Returns true if teleport spell effects are allowed.

Implemented in MWWorld::World.

virtual bool MWBase::World::isUnderwater	(	const MWWorld::Ptr::CellStore *	cell,
		const Ogre::Vector3 &	pos
	)		const [pure virtual]

Implemented in MWWorld::World.

virtual void MWBase::World::launchProjectile	(	const std::string &	id,
		bool	stack,
		const ESM::EffectList &	effects,
		const MWWorld::Ptr &	actor,
		const std::string &	sourceName
	)		[pure virtual]

Implemented in MWWorld::World.

virtual void MWBase::World::listDetectedReferences	(	const MWWorld::Ptr &	ptr,
		std::vector< MWWorld::Ptr > &	out,
		DetectionType	type
	)		[pure virtual]

List all references (filtered by type) detected by ptr. The range is determined by the current magnitude of the "Detect X" magic effect belonging to type.

Note:

This also works for references in containers.

virtual void MWBase::World::localRotateObject	(	const MWWorld::Ptr &	ptr,
		float	x,
		float	y,
		float	z
	)		[pure virtual]

Implemented in MWWorld::World.

virtual void MWBase::World::markCellAsUnchanged

(

)

[pure virtual]

Implemented in MWWorld::World.

virtual void MWBase::World::modRegion	(	const std::string &	regionid,
		const std::vector< char > &	chances
	)		[pure virtual]

Implemented in MWWorld::World.

virtual void MWBase::World::moveObject	(	const MWWorld::Ptr &	ptr,
		float	x,
		float	y,
		float	z
	)		[pure virtual]

Implemented in MWWorld::World.

virtual void MWBase::World::moveObject	(	const MWWorld::Ptr &	ptr,
		MWWorld::CellStore &	newCell,
		float	x,
		float	y,
		float	z
	)		[pure virtual]

Implemented in MWWorld::World.

World& MWBase::World::operator=

(

const World &

)

[private]

not implemented

virtual bool MWBase::World::placeObject	(	const MWWorld::Ptr &	object,
		float	cursorX,
		float	cursorY,
		int	amount
	)		[pure virtual]

copy and place an object into the gameworld at the specified cursor position

Parameters:

object
cursor	X (relative 0-1)
cursor	Y (relative 0-1)
number	of objects to place

Returns:

true if the object was placed, or false if it was rejected because the position is too far away

Implemented in MWWorld::World.

virtual void MWBase::World::playVideo	(	const std::string &	name,
		bool	allowSkipping
	)		[pure virtual]

Todo:

this does not belong here

Implemented in MWWorld::World.

virtual void MWBase::World::positionToIndex	(	float	x,
		float	y,
		int &	cellX,
		int &	cellY
	)		const [pure virtual]

Convert position to cell numbers.

Implemented in MWWorld::World.

virtual void MWBase::World::processChangedSettings

(

const Settings::CategorySettingVector &

settings

)

[pure virtual]

Implemented in MWWorld::World.

virtual void MWBase::World::queueMovement	(	const MWWorld::Ptr &	ptr,
		const Ogre::Vector3 &	velocity
	)		[pure virtual]

Queues movement for ptr (in local space), to be applied in the next call to doPhysics.

Implemented in MWWorld::World.

virtual void MWBase::World::removeRefScript

(

MWWorld::RefData *

ref

)

[pure virtual]

Implemented in MWWorld::World.

virtual void MWBase::World::renderPlayer

(

)

[pure virtual]

Implemented in MWWorld::World.

virtual void MWBase::World::rotateObject	(	const MWWorld::Ptr &	ptr,
		float	x,
		float	y,
		float	z,
		bool	adjust = false
	)		[pure virtual]

Implemented in MWWorld::World.

virtual MWWorld::Ptr MWBase::World::safePlaceObject	(	const MWWorld::Ptr &	ptr,
		MWWorld::CellStore &	Cell,
		ESM::Position	pos
	)		[pure virtual]

place an object in a "safe" location (ie not in the void, etc).

Implemented in MWWorld::World.

virtual void MWBase::World::scaleObject	(	const MWWorld::Ptr &	ptr,
		float	scale
	)		[pure virtual]

Implemented in MWWorld::World.

virtual MWWorld::Ptr MWBase::World::searchPtrViaHandle

(

const std::string &

handle

)

[pure virtual]

Return a pointer to a liveCellRef with the given Ogre handle or Ptr() if not found.

Implemented in MWWorld::World.

virtual void MWBase::World::setCameraDistance	(	float	dist,
		bool	adjust = false,
		bool	override = true
	)		[pure virtual]

Implemented in MWWorld::World.

virtual void MWBase::World::setDay

(

int

day

)

[pure virtual]

Set in-game time day.

Implemented in MWWorld::World.

virtual void MWBase::World::setHour

(

double

hour

)

[pure virtual]

Set in-game time hour.

Implemented in MWWorld::World.

virtual void MWBase::World::setMonth

(

int

month

)

[pure virtual]

Set in-game time month.

Implemented in MWWorld::World.

virtual void MWBase::World::setMoonColour

(

bool

red

)

[pure virtual]

Implemented in MWWorld::World.

virtual void MWBase::World::setupExternalRendering

(

MWRender::ExternalRendering &

rendering

)

[pure virtual]

Implemented in MWWorld::World.

virtual void MWBase::World::setupPlayer

(

)

[pure virtual]

Implemented in MWWorld::World.

virtual void MWBase::World::setWaterHeight

(

const float

height

)

[pure virtual]

Implemented in MWWorld::World.

virtual void MWBase::World::setWerewolf	(	const MWWorld::Ptr &	actor,
		bool	werewolf
	)		[pure virtual]

Turn actor into werewolf or normal form.

Implemented in MWWorld::World.

virtual void MWBase::World::startNewGame

(

)

[pure virtual]

Implemented in MWWorld::World.

virtual bool MWBase::World::startSpellCast

(

const MWWorld::Ptr &

actor

)

[pure virtual]

startSpellCast attempt to start casting a spell. Might fail immediately if conditions are not met.

Parameters:

actor

Returns:

true if the spell can be casted (i.e. the animation should start)

Implemented in MWWorld::World.

virtual void MWBase::World::stopVideo

(

)

[pure virtual]

Implemented in MWWorld::World.

virtual void MWBase::World::teleportToClosestMarker	(	const MWWorld::Ptr &	ptr,
		const std::string &	id,
		Ogre::Vector3	worldPos
	)		[pure virtual]

Teleports ptr to the reference of id (e.g. DivineMarker, PrisonMarker, TempleMarker) closest to worldPos.

Note:

id must be lower case

Implemented in MWWorld::World.

virtual bool MWBase::World::toggleCollisionMode

(

)

[pure virtual]

Toggle collision mode for player. If disabled player object should ignore collisions and gravity.

Returns:

Resulting mode

Implemented in MWWorld::World.

virtual bool MWBase::World::toggleGodMode

(

)

[pure virtual]

Implemented in MWWorld::World.

virtual void MWBase::World::togglePlayerLooking

(

bool

enable

)

[pure virtual]

Implemented in MWWorld::World.

virtual void MWBase::World::togglePOV

(

)

[pure virtual]

Implemented in MWWorld::World.

virtual void MWBase::World::togglePreviewMode

(

bool

enable

)

[pure virtual]

Implemented in MWWorld::World.

virtual bool MWBase::World::toggleRenderMode

(

RenderMode

mode

)

[pure virtual]

Toggle a render mode.

Returns:

Resulting mode

Implemented in MWWorld::World.

virtual bool MWBase::World::toggleSky

(

)

[pure virtual]

Returns:

Resulting mode

Implemented in MWWorld::World.

virtual bool MWBase::World::toggleVanityMode

(

bool

enable

)

[pure virtual]

Implemented in MWWorld::World.

virtual void MWBase::World::toggleWater

(

)

[pure virtual]

Implemented in MWWorld::World.

virtual void MWBase::World::update	(	float	duration,
		bool	paused
	)		[pure virtual]

Implemented in MWWorld::World.

virtual bool MWBase::World::vanityRotateCamera

(

float *

rot

)

[pure virtual]

Implemented in MWWorld::World.

---

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

• apps/openmw/mwbase/world.hpp