ORK Framework  2.25.2
API Documentation
ORKFramework.Ability Class Reference
Inheritance diagram for ORKFramework.Ability:
ORKFramework.BaseLanguageData ORKFramework.IContentSimple ORKFramework.BaseIndexData ORKFramework.BaseData ORKFramework.IBaseData

Public Member Functions

 Ability (string name)
override void SetData (DataObject data)
 Sets the variables of the class using a ORKFramework.DataObject. More...
bool IsUseable (UseableIn useIn)
AbilityLevel GetLevel (int lvl)
string GetName (int lvl)
GUIContent GetContent (int lvl)
bool CanUse (Combatant user, bool checkTime, bool checkUseCosts, int lvl, AbilityActionType actionType, VariableHandler localVariables, SelectedDataHandler selectedData)
void UseCosts (Combatant user, int lvl, VariableHandler localVariables, SelectedDataHandler selectedData)
void Use (Combatant user, List< Combatant > target, bool animate, BaseAction action, AbilityActionType actionType, bool doCounter, bool doUseCosts, int lvl, float damageFactor, float damageMultiplier, VariableHandler localVariables, SelectedDataHandler selectedData)
string GetName ()
string GetDescription ()
string GetIconTextCode ()
Texture GetIcon ()
GUIContent GetContent ()
- Public Member Functions inherited from ORKFramework.BaseLanguageData
 BaseLanguageData (string name)
- Public Member Functions inherited from ORKFramework.BaseData
virtual DataObject GetData ()
 Gets a ORKFramework.DataObject representing the class. More...
virtual void EditorAutoSetup (string fieldName)
 Called for all fields using the autoSetup option of the ORKFramework.ORKEditorLayoutAttribute. More...

Public Attributes

int abilityType = 0
bool ownDamageType = false
int damageTypeID = 0
bool hidden = false
UseableIn useableIn = UseableIn.Both
bool allowLvlChange = false
bool allowDeadUser = false
bool ownSelection = false
bool useScreenCombatant = false
int selectionID = 0
LevelUpType lvlType = LevelUpType.None
int expID = 0
bool ownBattleInfoText = false
BattleInfo battleInfoText
bool ownNotifications = false
AbilityNotification abilityLearned
AbilityNotification abilityForgotten
AbilityNotification groupAbilityLearned
AbilityNotification groupAbilityForgotten
bool ownConsoleAddAction = false
ConsoleTextActionPreview consoleAddAction
bool ownConsoleAction = false
ConsoleTextActionPreview consoleAction
bool ownConsoleCast = false
ConsoleTextActionPreview consoleCast
bool ownConsoleCastCancel = false
ConsoleTextActionPreview consoleCastCancel
bool ownConsoleLearning = false
ConsoleTextLearning consoleLearning
bool ownConsoleGroupLearning = false
ConsoleTextGroupLearning consoleGroupLearning
bool ownConsoleForgetting = false
ConsoleTextLearning consoleForgetting
bool ownConsoleGroupForgetting = false
ConsoleTextGroupLearning consoleGroupForgetting
bool ownConsoleLevelUp = false
ConsoleTextLevelUp consoleLevelUp
TypeImagePortrait [] portrait = new TypeImagePortrait[0]
AbilityLevel [] level = new AbilityLevel[] {new AbilityLevel()}
- Public Attributes inherited from ORKFramework.BaseLanguageData
LanguageInfo [] languageInfo


int ItemTypeID [get]
int ID [get]
- Properties inherited from ORKFramework.BaseIndexData
virtual int RealID [get, set]
- Properties inherited from ORKFramework.IContentSimple
int ID [get]

Additional Inherited Members

- Protected Attributes inherited from ORKFramework.BaseIndexData
int realID = 0

Member Function Documentation

◆ SetData()

override void ORKFramework.Ability.SetData ( DataObject  data)

Sets the variables of the class using a ORKFramework.DataObject.

dataORKFramework.DataObject containing the data.

Reimplemented from ORKFramework.BaseData.