ORKFramework.GroupAbilities Class Reference

Inheritance diagram for ORKFramework.GroupAbilities:

Public Member Functions
	GroupAbilities (Group owner)
void	LeaderChanged (Combatant oldLeader, Combatant newLeader)
void	FireChanged ()
List< AbilityShortcut >	GetAbilities ()
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

Forget()

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

Forgets an ability.

Parameters

id	The ID (index) of the ability.
showNotification	true to display popup notifications.
showConsole	true to display in the console.

GetLearned()

AbilityShortcut ORKFramework.GroupAbilities.GetLearned

(

int

id

)

Gets a learned ability.

Returns

The ability if learned, otherwise null.

Parameters

id	The ID (index) of the ability.

HasLearned()

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

id	The ID (index) of the ability.
lvl	The minimum level that has to be learned.

Learn() [1/2]

bool ORKFramework.GroupAbilities.Learn	(	int	id,
		int	lvl,
		bool	showNotification,
		bool	showConsole
	)

Learns an ability.

Parameters

id	The ID (index) of the ability.
lvl	The level that will be learned
showNotification	true to display popup notifications.
showConsole	true to display in the console.

Learn() [2/2]

bool ORKFramework.GroupAbilities.Learn	(	AbilityShortcut	ability,
		bool	showNotification,
		bool	showConsole
	)

Learns an ability.

Parameters

ability	The ability that will be learned.
showNotification	true to display popup notifications.
showConsole	true to display in the console.

LoadGame()

void ORKFramework.GroupAbilities.LoadGame

(

DataObject

data

)

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

Parameters

data	A ORKFramework.DataObject containing the data.

Implements ORKFramework.ISaveData.

SaveGame()

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.