Annchienta Namespace Reference

Classes
class	Area
class	AudioManager
class	Cacheable
class	CacheManager
class	Engine
class	Entity
class	FollowPathPersonControl
class	Font
class	InputManager
class	InputPersonControl
class	Layer
class	LogManager
class	Map
class	MapManager
class	Mask
class	MathManager
class	Person
class	PersonControl
class	Point
	Holds a Point. More...
class	SamplePersonControl
class	Sound
class	StaticObject
class	Surface
class	Tile
	Holds a Tile. More...
class	TileSet
class	Vector
class	VideoManager
Enumerations
enum	CacheableType { UnknownCacheable = 0, SurfaceCacheable, MaskCacheable, SoundCacheable }
enum	EntityType { TileEntity = 0, StaticObjectEntity, PersonEntity }
enum	InputMode { CinematicMode = 0, InteractiveMode = 1 }
enum	ObstructionType { DefaultObstruction = 0, NoObstruction = 1, FullObstruction = 2 }
enum	PointType { TilePoint = 0, IsometricPoint, MapPoint, ScreenPoint }
Functions
StaticObject *	getActiveObject ()
AudioManager *	getAudioManager ()
CacheManager *	getCacheManager ()
Engine *	getEngine ()
InputManager *	getInputManager ()
LogManager *	getLogManager ()
MapManager *	getMapManager ()
MathManager *	getMathManager ()
StaticObject *	getPassiveObject ()
VideoManager *	getVideoManager ()
void	init (const char *writeDir=".")
void	quit ()
void	setActiveObject (StaticObject *object)
void	setPassiveObject (StaticObject *object)

---

Enumeration Type Documentation

enum Annchienta::CacheableType

Enumerator:

UnknownCacheable
SurfaceCacheable
MaskCacheable
SoundCacheable

enum Annchienta::EntityType

Enumerator:

TileEntity
StaticObjectEntity
PersonEntity

enum Annchienta::InputMode

Enumerator:

CinematicMode	No input is accepted from the user. Used for cinematic sequences.
InteractiveMode	In this mode, the game accepts user input, which means the player can control his character.

enum Annchienta::ObstructionType

Enumerator:

DefaultObstruction
NoObstruction
FullObstruction

enum Annchienta::PointType

These enums are used for indicating types of Points we can be dealing with.

Enumerator:

TilePoint	A Point defined by an x, y (and z) coordinate. The x and y coordinates indicate which tile this point is situated on. The most northern point of the Map is considered to be (0,0).
IsometricPoint	A Point defined by an x, y (and z) coordinate. The x and y coordinates indicate a point in an isometric axis system. The most northern point of the Map is considered to be (0,0)
MapPoint	A Point defined by an x, y (and z) coordinate. The x and y coordinates indicate a point in an orthogonal axis system where the most northern point of the Map is (0,0).
ScreenPoint	A Point defined by an x and y coordinate. This indicates a point on the screen. The top-left corner of the window is considered (0,0).

---

Function Documentation

StaticObject* Annchienta::getActiveObject

(

)

A function for use in scenes. When you call this function, it will return the object that most recently started interacting with another object.

Returns:

The object that started interacting.

AudioManager* Annchienta::getAudioManager

(

)

CacheManager* Annchienta::getCacheManager

(

)

Returns:

An instance of the global CacheManager.

Engine* Annchienta::getEngine

(

)

Returns the global engine.

InputManager* Annchienta::getInputManager

(

)

LogManager* Annchienta::getLogManager

(

)

Retrieve the global LogManager instance.

MapManager* Annchienta::getMapManager

(

)

MathManager* Annchienta::getMathManager

(

)

Returns:

An instance of the global MathManager.

StaticObject* Annchienta::getPassiveObject

(

)

A function for use in scenes. When you call this function, it will return the object that most recently started being interacting with.

Returns:

The object that started being interacting with.

VideoManager* Annchienta::getVideoManager

(

)

void Annchienta::init

(

const char *

writeDir = "."

)

Starts the engine. Call this before using any functions from the annchienta module.

Parameters:

writeDir

path to directory where log and save files should be placed.

void Annchienta::quit

(

)

Quits and deletes the engine. Call this at the end of your game...

void Annchienta::setActiveObject

(

StaticObject *

object

)

void Annchienta::setPassiveObject

(

StaticObject *

object

)