Script/HeroParty

From SF3
Revision as of 11:25, 21 September 2016 by Dave (talk | contribs) (Class Methods)

Jump to: navigation, search

class HeroParty

An interface which can be used to interact with a player's hero characters.

Class Methods

void AddItems (const string&in _sItemTechnicalName, const uint _uAmount)
add an item to the hero party's inventory
void RemoveItems (const string&in _sItemTechnicalName, const uint _uAmount)
remove the given amount of the given item from the hero party's inventory
bool HasItems (const string&in _sItemTechnicalName, const uint _uAmount) const
check whether the hero party has at least _uAmount of the given item in their inventory
bool IsMember (const Creature&in _Creature) const
check whether the given creature is currently a member of the hero party
void AddMember (const Creature&in _Creature)
add creature to hero party
void RemoveMember (const Creature&in _Creature)
remove creature from hero party
Creature[]@ GetMembers () const
get all current members of the party
void AddExperience (const uint _uAmount)
award experience to the hero party
void Stop ()
stop the entire hero party dead in their tracks.

class HeroParty

An interface which can be used to interact with a player's hero characters.

Class Methods

void AddItems (const string&in _sItemTechnicalName, const uint _uAmount)
add an item to the hero party's inventory
void RemoveItems (const string&in _sItemTechnicalName, const uint _uAmount)
remove the given amount of the given item from the hero party's inventory
bool HasItems (const string&in _sItemTechnicalName, const uint _uAmount) const
check whether the hero party has at least _uAmount of the given item in their inventory
bool IsMember (const Creature&in _Creature) const
check whether the given creature is currently a member of the hero party
void AddMember (const Creature&in _Creature)
add creature to hero party
void RemoveMember (const Creature&in _Creature)
remove creature from hero party
Creature[]@ GetMembers () const
get all current members of the party
void AddExperience (const uint _uAmount)
award experience to the hero party
void Stop ()
stop the entire hero party dead in their tracks.