Difference between revisions of "Script/HeroParty"
From SF3
| Line 57: | Line 57: | ||
|- | |- | ||
| | | | ||
| − | | style = 'color: #505050; line-height: 0.5;' |''modify attribute of the given hero by the given value (note: this will only work when enough | + | | style = 'color: #505050; line-height: 0.5;' |''modify attribute of the given hero by the given value (note: this will only work when enough attribute points are available)'' |
| + | |- | ||
| + | | style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] | ||
| + | | style='color: black; width: 90%; line-height: 1.0;' | '''UnlockHeroAbility''' (const [[../Creature|Creature]]&in ''_Creature'', const [[../BasicDataTypes|string]]&in ''_sAbilityName'') | ||
| + | |- | ||
| + | | | ||
| + | | style = 'color: #505050; line-height: 0.5;' |''unlock the given ability for the given hero, provided the hero has enough ability points available'' | ||
|- | |- | ||
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] | | style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] | ||
Revision as of 14:19, 7 December 2016
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 | ModifyHeroAttribute (const Creature&in _Creature, const ECreatureAttribute _Attribute, const int8 _iValue) |
| modify attribute of the given hero by the given value (note: this will only work when enough attribute points are available) | |
| void | UnlockHeroAbility (const Creature&in _Creature, const string&in _sAbilityName) |
| unlock the given ability for the given hero, provided the hero has enough ability points available | |
| void | Stop () |
| stop the entire hero party dead in their tracks. |
