ORK Framework  2.29.0
API Documentation
ORKFramework.EquipAbilityShortcut Class Reference
Inheritance diagram for ORKFramework.EquipAbilityShortcut:
ORKFramework.AbilityShortcut ORKFramework.IStatusValueChangeSource ORKFramework.ILevelUpCostText ORKFramework.ILevelUpSpend ORKFramework.ICallCombatantSelection ORKFramework.ITimestamp ORKFramework.IReuseTime ORKFramework.IUseCostDisplay ORKFramework.IVariableSource ORKFramework.IRenameable ORKFramework.ICastTime ORKFramework.ITargetRange ORKFramework.IMarkNewContent ORKFramework.IGUID ORKFramework.IShortcut

Public Member Functions

 EquipAbilityShortcut (EquipShortcut equipment, EquipmentAbility equipAbility, int index)
override SelectedDataHandler GetSelectedData ()
override void UsesExperience (Combatant combatant, int points)
override void CheckLevelUp (Combatant combatant, int points)
override bool CanLevelUp ()
override bool CanLevelUpSpend (Combatant combatant)
override void SpendExperience (Combatant combatant)
override string GetLevelUpCostString (Combatant combatant)
override void RegisterStatusChanges (Combatant c)
override void UnregisterStatusChanges (Combatant c)
override void StatusValueChanged (Combatant c, int id, int change)
- Public Member Functions inherited from ORKFramework.AbilityShortcut
 AbilityShortcut (int id, int level, AbilityState state)
IShortcut GetCopy (int quantity)
bool IsEqual (IShortcut shortcut)
int BuyPrice (Combatant user)
int SellPrice (Combatant user)
void InitVariables ()
void UpdateVariableChanges ()
void SetStartEffects (Combatant owner)
void RemoveStartEffects (Combatant owner)
bool IsUseable (UseableIn useIn)
ActiveAbility GetActiveLevel ()
PassiveAbility GetPassiveLevel ()
bool InRange (Combatant user, Combatant target)
float GetAvailableTime ()
float GetTimeUse ()
float GetCastTime (Combatant user)
void PlayCastAudio (Combatant user)
bool CanCancelCasting ()
bool CanCastMove ()
void ShowCastingConsoleText (Combatant user, List< Combatant > target, Dictionary< Combatant, StatusChangeInformation > statusChangesTarget)
void ShowCancelCastingConsoleText (Combatant user, List< Combatant > target, Dictionary< Combatant, StatusChangeInformation > statusChangesTarget)
bool CanTarget (Combatant user, Combatant target)
bool HasPossibleTargets (Combatant user, List< Combatant > available)
List< CombatantGetPossibleTargets (Combatant user, List< Combatant > available)
bool IsNoneTarget ()
bool IsNoneTargetSelection ()
bool IsSingleTarget ()
bool IsGroupTarget ()
bool ToggleTargetRange ()
int GetLevel ()
bool ChangeUseLevel (int change, bool loop)
void SetHighestUseLevel (Combatant user)
IContentSimple GetTypeContent ()
string GetName ()
string GetShortName ()
string GetDescription ()
string GetIconTextCode ()
Texture GetIcon ()
GUIContent GetContent ()
string GetInfo (Combatant combatant)
string GetUseCostText (Combatant user)
ShortcutHUDWrapper GetDrag (Combatant user)
bool IsDropable ()
bool CanUse (Combatant user, bool checkTime, bool checkUseCosts)
void CallCombatantSelection (BaseMenuPart parent, bool useAction)
bool Use (Combatant user, List< Combatant > targets, bool useAction)
bool AutoUse (Combatant user)
bool IsReuseTime (EndAfter type)
string GetReuseTimeText (Combatant user, int decimals)
float GetReuseTime (Combatant user)
float GetMaxReuseTime (Combatant user)
virtual void SetUseCount (int useCount, int maxUseCount)
virtual void ResetUseCount (Combatant user, UseCountResetType resetType)
virtual void ChangeUseCount (int change, FormulaOperator floatOperator)
IPortrait GetPortrait (int typeID)
void UnmarkID (int id)
StatusPreview GetPreview (Combatant combatant, PreviewSelection selectedPreview)
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...


override int LevelPoints [get]
override int MinLevelPoints [get]
override int MaxLevelPoints [get]
EquipShortcut Equipment [get]
EquipmentAbility EquipmentAbility [get]
- Properties inherited from ORKFramework.AbilityShortcut
virtual string GUID [get, set]
bool IsTemporary [get]
AbilityState State [get, set]
int Quantity [get, set]
int Level [get, set]
virtual int LevelPoints [get, set]
virtual int MinLevelPoints [get]
virtual int MaxLevelPoints [get]
Ability Setting [get]
bool IsBaseAttack [get]
bool IsCounterAttack [get]
bool IsAbility [get]
float Timestamp [get, set]
bool HasVariables [get]
VariableHandler Variables [get]
bool IsPassive [get]
CastTimeSettingsCastTimeSettings [get]
int UseLevel [get, set]
int ID [get]
int TypeID [get]
string RenameableName [get, set]
string RenameableDescription [get, set]
bool OnScreenCombatant [get]
virtual int UseCount [get, set]
virtual int MaxUseCount [get]
virtual bool HasUseCount [get]
bool IsNewContent [get, set]
- Properties inherited from ORKFramework.IShortcut
int Quantity [get, set]
- Properties inherited from ORKFramework.IContent
int TypeID [get]
- Properties inherited from ORKFramework.IContentSimple
int ID [get]
- Properties inherited from ORKFramework.IGUID
string GUID [get, set]
- Properties inherited from ORKFramework.IMarkNewContent
bool IsNewContent [get, set]
- Properties inherited from ORKFramework.ICastTime
CastTimeSettings CastTimeSettings [get]
- Properties inherited from ORKFramework.IRenameable
string RenameableName [get, set]
string RenameableDescription [get, set]
- Properties inherited from ORKFramework.IVariableSource
bool HasVariables [get]
VariableHandler Variables [get]
- Properties inherited from ORKFramework.ITimestamp
float Timestamp [get, set]

Additional Inherited Members

- Static Public Member Functions inherited from ORKFramework.AbilityShortcut
static AbilityShortcut GetAbilityShortcut (object shortcut)
- Protected Member Functions inherited from ORKFramework.AbilityShortcut
void RegisterUpdateVariables ()
- Protected Attributes inherited from ORKFramework.AbilityShortcut
string guid = ""
int id = 0
int level = 1
int useLevel = 1
int lvlPoints = 0
Ability ability
AbilityState state = AbilityState.None
VariableHandler variableHandler
float timestamp = 0
int useCount = -1
int maxUseCount = -1
bool isNewContent = false
bool targetRangeToggle = false
string name = ""