Difference between revisions of "Script/HeroParty"

From SF3
Jump to: navigation, search
(Created page with "==class HeroParty== === Class Methods === {| border='0' style ='border:solid 1px #eeeedd; color: black; width: 1200px;background-color: #ffffcc;' cellspacing='0' cellpadding=...")
 
Line 1: Line 1:
 
==class HeroParty==
 
==class HeroParty==
 
+
An interface which can be used to interact with a player's hero characters.
 +
 
 
=== Class Methods ===
 
=== Class Methods ===
 
{| border='0' style ='border:solid 1px #eeeedd; color: black; width: 1200px;background-color: #ffffcc;' cellspacing='0' cellpadding='7'
 
{| border='0' style ='border:solid 1px #eeeedd; color: black; width: 1200px;background-color: #ffffcc;' cellspacing='0' cellpadding='7'
Line 7: Line 8:
 
| style='color: black; width: 90%; line-height: 0.8;' | '''AddItems''' (const [[../BasicDataTypes|string]]&in ''_sItemTechnicalName'', const [[../BasicDataTypes|uint]] ''_uAmount'')
 
| style='color: black; width: 90%; line-height: 0.8;' | '''AddItems''' (const [[../BasicDataTypes|string]]&in ''_sItemTechnicalName'', const [[../BasicDataTypes|uint]] ''_uAmount'')
 
|-
 
|-
 +
|
 +
| style = 'color: #505050; line-height: 0.5;' |''add an item to the hero party's inventory''
 
|-
 
|-
 
| 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]]  
 
| style='color: black; width: 90%; line-height: 0.8;' | '''RemoveItems''' (const [[../BasicDataTypes|string]]&in ''_sItemTechnicalName'', const [[../BasicDataTypes|uint]] ''_uAmount'')
 
| style='color: black; width: 90%; line-height: 0.8;' | '''RemoveItems''' (const [[../BasicDataTypes|string]]&in ''_sItemTechnicalName'', const [[../BasicDataTypes|uint]] ''_uAmount'')
 
|-
 
|-
 +
|
 +
| style = 'color: #505050; line-height: 0.5;' |''remove the given amount of the given item from the hero party's inventory''
 
|-
 
|-
 
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]]  
 
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]]  
 
| style='color: black; width: 90%; line-height: 0.8;' | '''HasItems''' (const [[../BasicDataTypes|string]]&in ''_sItemTechnicalName'', const [[../BasicDataTypes|uint]] ''_uAmount'') const
 
| style='color: black; width: 90%; line-height: 0.8;' | '''HasItems''' (const [[../BasicDataTypes|string]]&in ''_sItemTechnicalName'', const [[../BasicDataTypes|uint]] ''_uAmount'') const
 
|-
 
|-
 +
|
 +
| style = 'color: #505050; line-height: 0.5;' |''check whether the hero party has at least _uAmount of the given item in their inventory''
 
|-
 
|-
 
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]]  
 
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]]  
 
| style='color: black; width: 90%; line-height: 0.8;' | '''IsMember''' (const [[../Creature|Creature]]&in ''_Creature'') const
 
| style='color: black; width: 90%; line-height: 0.8;' | '''IsMember''' (const [[../Creature|Creature]]&in ''_Creature'') const
 
|-
 
|-
 +
|
 +
| style = 'color: #505050; line-height: 0.5;' |''check whether the given creature is currently a member of the hero party''
 
|-
 
|-
 
| 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]]  
 
| style='color: black; width: 90%; line-height: 0.8;' | '''AddMember''' (const [[../Creature|Creature]]&in ''_Creature'')
 
| style='color: black; width: 90%; line-height: 0.8;' | '''AddMember''' (const [[../Creature|Creature]]&in ''_Creature'')
 
|-
 
|-
 +
|
 +
| style = 'color: #505050; line-height: 0.5;' |''add creature to hero party''
 
|-
 
|-
 
| 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]]  
 
| style='color: black; width: 90%; line-height: 0.8;' | '''RemoveMember''' (const [[../Creature|Creature]]&in ''_Creature'')
 
| style='color: black; width: 90%; line-height: 0.8;' | '''RemoveMember''' (const [[../Creature|Creature]]&in ''_Creature'')
 
|-
 
|-
 +
|
 +
| style = 'color: #505050; line-height: 0.5;' |''remove creature from hero party''
 
|-
 
|-
 
| 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]]  
 
| style='color: black; width: 90%; line-height: 0.8;' | '''AddExperience''' (const [[../BasicDataTypes|uint]] ''_uAmount'')
 
| style='color: black; width: 90%; line-height: 0.8;' | '''AddExperience''' (const [[../BasicDataTypes|uint]] ''_uAmount'')
 
|-
 
|-
 +
|
 +
| style = 'color: #505050; line-height: 0.5;' |''award experience to the hero party''
 
|-
 
|-
 
| 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]]  
 
| style='color: black; width: 90%; line-height: 0.8;' | '''Stop''' ()
 
| style='color: black; width: 90%; line-height: 0.8;' | '''Stop''' ()
 
|-
 
|-
 +
|
 +
| style = 'color: #505050; line-height: 0.5;' |''stop the entire hero party dead in their tracks.''
 
|}
 
|}

Revision as of 08:54, 1 September 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
void AddExperience (const uint _uAmount)
award experience to the hero party
void Stop ()
stop the entire hero party dead in their tracks.

class HeroParty

Class Methods

void AddItems (const string&in _sItemTechnicalName, const uint _uAmount)
void RemoveItems (const string&in _sItemTechnicalName, const uint _uAmount)
bool HasItems (const string&in _sItemTechnicalName, const uint _uAmount) const
bool IsMember (const Creature&in _Creature) const
void AddMember (const Creature&in _Creature)
void RemoveMember (const Creature&in _Creature)
void AddExperience (const uint _uAmount)
void Stop ()