Difference between revisions of "Script/HeroParty"
From SF3
(→Class Methods) |
|||
| Line 70: | Line 70: | ||
| | | | ||
| style = 'color: #505050; line-height: 0.5;' |''get all current members of the party'' | | style = 'color: #505050; line-height: 0.5;' |''get all current members of the party'' | ||
| + | |- | ||
| + | | style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] | ||
| + | | style='color: black; width: 90%; line-height: 1.0;' | '''IsGathered''' (const [[../BasicDataTypes|bool]] ''_bShowGatherNotification'') const | ||
| + | |- | ||
| + | | | ||
| + | | style = 'color: #505050; line-height: 0.5;' |''check whether the hero party is currently gathered (if _bShowGatherNotification is true, a notification telling the player to gather their party will be shown)'' | ||
| + | |- | ||
| + | | style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] | ||
| + | | style='color: black; width: 90%; line-height: 1.0;' | '''IsGathered''' (const [[../Entity|Entity]]&in ''_Target'', const [[../BasicDataTypes|bool]] ''_bShowGatherNotification'') const | ||
| + | |- | ||
| + | | | ||
| + | | style = 'color: #505050; line-height: 0.5;' |''check whether the hero party is currently gathered at the target's position. | ||
| + | (if _bShowGatherNotification is true, a notification telling the player to gather their party will be shown)'' | ||
|- | |- | ||
| 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 09:34, 21 March 2017
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 | |
| uint | GetItemAmount (const string&in _sItemTechnicalName) const |
| get the number of items of the given type currently in the party inventory | |
| void | AddGold (const uint _uAmount) |
| add the given amount of gold coins to the party's coin pouch | |
| uint | RemoveGold (const uint _uAmount) |
| remove up to _uAmount of gold coins from the party's coin pouch (may be less if there is not enough available). returns actual amount removed. | |
| bool | GetGold () const |
| get current amount of gold in the party's coin pouch | |
| 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 | |
| bool | IsGathered (const bool _bShowGatherNotification) const |
| check whether the hero party is currently gathered (if _bShowGatherNotification is true, a notification telling the player to gather their party will be shown) | |
| bool | IsGathered (const Entity&in _Target, const bool _bShowGatherNotification) const |
| check whether the hero party is currently gathered at the target's position.
(if _bShowGatherNotification is true, a notification telling the player to gather their party will be shown) | |
| 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. |
