RPG::Actor Class Reference

Used for the data of actors which can be changed in-game. More...

Inherits RPG::Battler.

List of all members.

Public Member Functions
std::string	getDegree ()
	Returns the current degree.
std::string	getCharsetFilename ()
	Returns the current charset filename.
int	getCharsetId ()
	Returns the current charset ID.
int	getCharsetTransparency ()
	Returns the current charset transparency.
std::string	getFacesetFilename ()
	Returns the current faceset filename.
int	getFacesetId ()
	Returns the current faceset ID.
int	getBattleGraphicId ()
	Returns the current battle graphic ID.
int	getBattleCommand (int index)
	Returns the current battle command on a certain position.
Static Public Member Functions
static RPG::Actor *	partyMember (int index)
	Returns a certain party member.
Public Attributes
DStringPtr	name
	Name ("\x01" means database default)
DStringPtr	degree
	Degree ("\x01" means database default)
DStringPtr	charsetFilename
	Filename of the charset (empty means database default)
int	charsetId
	ID of the sprite in the charset file (only valid if charsetFilename isn't empty)
int	charsetTransparency
	Transparency of the charset (0 to 8, only valid if charsetFilename isn't empty)
DStringPtr	facesetFilename
	Filename of the faceset (empty means database default)
int	facesetId
	ID of the sprite in the faceset file (only valid if facesetFilename isn't empty)
int	level
	Current level.
int	exp
	Current experience points.
int	maxHpDiff
	Difference from the default maximal HP.
int	maxMpDiff
	Difference from the default maximal MP.
int	attackDiff
	Difference from the default attack value.
int	defenseDiff
	Difference from the default defense value.
int	intelligenceDiff
	Difference from the default intelligence value.
int	agilityDiff
	Difference from the default agility value.
short	weaponId
	Database ID of the current weapon (zero for none)
short	shieldId
	Database ID of the current shield (or second-hand weapon, zero for none)
short	armorId
	Database ID of the current armor (zero for none)
short	helmetId
	Database ID of the current helmet (zero for none)
short	accessoryId
	Database ID of the current accessory (zero for none)
bool	twoWeapons
	Can the actor hold two weapons?
bool	lockEquipemnt
	Is the actor's equipment unchangable by the player?
bool	autoBattle
	Is the battle AI activated for this actor?
bool	mightyGuard
	Is the "mighty guard" mode activated for this actor?
int	battleGraphicId
	Database ID of the battle graphic (zero for database default)
bool	customBattleCommands
	true if the battleCommands member is valid, otherwise the database default should be used
int	battleCommands [7]
	The current battle commands for this actor (0 and -1 both mean "no command at this position")

---

Detailed Description

Used for the data of actors which can be changed in-game.

Note:

Many things are only stored in this class if they were changed and are now different from the default in the database, thus you should use the getter methods to access these things.

The members ending with Diff are "offsets" which are added to the default value (which is calculated from the current level, class and equipment).

See also:

RPG::actors

RPG::DBActor

RPG::dbActors

RPG::Battler

---

Member Function Documentation

int RPG::Actor::getBattleCommand

(

int

index

)

Returns the current battle command on a certain position.

Parameters:

index

Zero-based index of the available commands for this actor (0 to 6)

Returns:

Database ID of the battle command on the given position or either 0 or -1 if there is none

int RPG::Actor::getBattleGraphicId

(

)

Returns the current battle graphic ID.

Returns:

Database ID of the current battle graphic

std::string RPG::Actor::getCharsetFilename

(

)

Returns the current charset filename.

Returns:

Current charset filename

See also:

getCharsetId

getCharsetTransparency

int RPG::Actor::getCharsetId

(

)

Returns the current charset ID.

Returns:

ID of sprite in charsets

See also:

getCharsetFilename

getCharsetTransparency

int RPG::Actor::getCharsetTransparency

(

)

Returns the current charset transparency.

Returns:

Transparency value (see RPG::Character::transparency documentation)

See also:

getCharsetFilename

getCharsetId

std::string RPG::Actor::getDegree

(

)

Returns the current degree.

Returns:

Current degree

std::string RPG::Actor::getFacesetFilename

(

)

Returns the current faceset filename.

Returns:

Current faceset filename

See also:

getFacesetId

int RPG::Actor::getFacesetId

(

)

Returns the current faceset ID.

Returns:

ID of sprite in faceset

See also:

getFacesetFilename

static RPG::Actor* RPG::Actor::partyMember

(

int

index

)

[static]

Returns a certain party member.

Parameters:

index

Zero-based party member index (0 to 3)

Returns:

Pointer to the RPG::Actor object of the particular actor

---

Member Data Documentation

short RPG::Actor::accessoryId

Database ID of the current accessory (zero for none)

int RPG::Actor::agilityDiff

Difference from the default agility value.

short RPG::Actor::armorId

Database ID of the current armor (zero for none)

int RPG::Actor::attackDiff

Difference from the default attack value.

bool RPG::Actor::autoBattle

Is the battle AI activated for this actor?

int RPG::Actor::battleCommands[7]

The current battle commands for this actor (0 and -1 both mean "no command at this position")

int RPG::Actor::battleGraphicId

Database ID of the battle graphic (zero for database default)

DStringPtr RPG::Actor::charsetFilename

Filename of the charset (empty means database default)

int RPG::Actor::charsetId

ID of the sprite in the charset file (only valid if charsetFilename isn't empty)

int RPG::Actor::charsetTransparency

Transparency of the charset (0 to 8, only valid if charsetFilename isn't empty)

bool RPG::Actor::customBattleCommands

true if the battleCommands member is valid, otherwise the database default should be used

int RPG::Actor::defenseDiff

Difference from the default defense value.

DStringPtr RPG::Actor::degree

Degree ("\x01" means database default)

int RPG::Actor::exp

Current experience points.

DStringPtr RPG::Actor::facesetFilename

Filename of the faceset (empty means database default)

int RPG::Actor::facesetId

ID of the sprite in the faceset file (only valid if facesetFilename isn't empty)

short RPG::Actor::helmetId

Database ID of the current helmet (zero for none)

int RPG::Actor::intelligenceDiff

Difference from the default intelligence value.

int RPG::Actor::level

Current level.

bool RPG::Actor::lockEquipemnt

Is the actor's equipment unchangable by the player?

int RPG::Actor::maxHpDiff

Difference from the default maximal HP.

int RPG::Actor::maxMpDiff

Difference from the default maximal MP.

bool RPG::Actor::mightyGuard

Is the "mighty guard" mode activated for this actor?

DStringPtr RPG::Actor::name

Name ("\x01" means database default)

short RPG::Actor::shieldId

Database ID of the current shield (or second-hand weapon, zero for none)

bool RPG::Actor::twoWeapons

Can the actor hold two weapons?

short RPG::Actor::weaponId

Database ID of the current weapon (zero for none)