ORK Framework  2.24.0
API Documentation
ORKFramework.GroupAbilities Class Reference
Inheritance diagram for ORKFramework.GroupAbilities:
ORKFramework.ISaveData

Public Member Functions

 GroupAbilities (Group owner)
 
void LeaderChanged (Combatant oldLeader, Combatant newLeader)
 
void FireChanged ()
 
List< AbilityShortcutGetAbilities ()
 
bool HasLearned (int id, int lvl)
 Determines whether the specified ability has been learned. More...
 
AbilityShortcut GetLearned (int id)
 Gets a learned ability. More...
 
bool Forget (int id, bool showNotification, bool showConsole)
 Forgets an ability. More...
 
bool Learn (int id, int lvl, bool showNotification, bool showConsole)
 Learns an ability. More...
 
bool Learn (AbilityShortcut ability, bool showNotification, bool showConsole)
 Learns an ability. More...
 
DataObject SaveGame ()
 Used to save the data - you need to add the data to a ORKFramework.DataObject. More...
 
void LoadGame (DataObject data)
 Used to load the data - you need to get the data from the ORKFramework.DataObject. More...
 

Properties

GroupChanged Changed
 

Member Function Documentation

bool ORKFramework.GroupAbilities.Forget ( int  id,
bool  showNotification,
bool  showConsole 
)

Forgets an ability.

Parameters
idThe ID (index) of the ability.
showNotificationtrue to display popup notifications.
showConsoletrue to display in the console.
AbilityShortcut ORKFramework.GroupAbilities.GetLearned ( int  id)

Gets a learned ability.

Returns
The ability if learned, otherwise null.
Parameters
idThe ID (index) of the ability.
bool ORKFramework.GroupAbilities.HasLearned ( int  id,
int  lvl 
)

Determines whether the specified ability has been learned.

Returns
true if the ability has been learned; otherwise, false.
Parameters
idThe ID (index) of the ability.
lvlThe minimum level that has to be learned.
bool ORKFramework.GroupAbilities.Learn ( int  id,
int  lvl,
bool  showNotification,
bool  showConsole 
)

Learns an ability.

Parameters
idThe ID (index) of the ability.
lvlThe level that will be learned
showNotificationtrue to display popup notifications.
showConsoletrue to display in the console.
bool ORKFramework.GroupAbilities.Learn ( AbilityShortcut  ability,
bool  showNotification,
bool  showConsole 
)

Learns an ability.

Parameters
abilityThe ability that will be learned.
showNotificationtrue to display popup notifications.
showConsoletrue to display in the console.
void ORKFramework.GroupAbilities.LoadGame ( DataObject  data)

Used to load the data - you need to get the data from the ORKFramework.DataObject.

Parameters
dataA ORKFramework.DataObject containing the data.

Implements ORKFramework.ISaveData.

DataObject ORKFramework.GroupAbilities.SaveGame ( )

Used to save the data - you need to add the data to a ORKFramework.DataObject.

Returns
A ORKFramework.DataObject containing the data.

Implements ORKFramework.ISaveData.