ORK Framework  3.17.1
API Documentation
GamingIsLove.ORKFramework.AbilityShortcut Class Reference
Inheritance diagram for GamingIsLove.ORKFramework.AbilityShortcut:
GamingIsLove.ORKFramework.IAddRandomStatusBonus GamingIsLove.ORKFramework.IStatusBonus GamingIsLove.ORKFramework.ILevel GamingIsLove.ORKFramework.IKeySchematicStarter GamingIsLove.ORKFramework.ILevelUpCostText GamingIsLove.ORKFramework.ILevelUpSpend GamingIsLove.ORKFramework.UI.ICallCombatantSelection GamingIsLove.ORKFramework.UI.IUIShortcut GamingIsLove.ORKFramework.ITimestamp GamingIsLove.ORKFramework.IReuseTime GamingIsLove.ORKFramework.IUseCostDisplay GamingIsLove.ORKFramework.IRenameable GamingIsLove.ORKFramework.ICastTime GamingIsLove.ORKFramework.ITargetRange GamingIsLove.ORKFramework.IMarkNewContent GamingIsLove.ORKFramework.IGUID GamingIsLove.ORKFramework.IContentCombatantInfo GamingIsLove.ORKFramework.IShortcut GamingIsLove.ORKFramework.EquipAbilityShortcut

Public Member Functions

 AbilityShortcut (Ability ability, int level, AbilityState state)
 
IShortcut GetCopy (int quantity)
 
bool IsEqual (IShortcut shortcut)
 
string FormatQuantity (int quantity)
 
int BuyPrice (Combatant user)
 
int SellPrice (Combatant user)
 
string FormatLevelPoints (int value)
 
virtual SelectedDataHandler GetSelectedData ()
 
void StartKeySchematic (string callKey, object machineObject, object startingObject, VariableHandler localVariables, Notify finishedCallback)
 
virtual UIShortcutSettings GetUISettings ()
 
void InitVariables ()
 
void UpdateVariableChanges ()
 
virtual void UsesExperience (Combatant combatant, int points)
 
virtual void CheckLevelUp (Combatant combatant, int points)
 
virtual bool CanLevelUp ()
 
virtual bool CanResearch (Combatant combatant)
 
virtual bool Research (Combatant combatant)
 
virtual bool CanLevelUpSpend (Combatant combatant)
 
virtual void SpendExperience (Combatant combatant)
 
virtual string GetLevelUpCostString (Combatant combatant)
 
void SetStartEffects (Combatant owner)
 
void RemoveStartEffects (Combatant owner)
 
bool IsUseable (UseableIn useIn)
 
ActiveAbility GetActiveLevel ()
 
PassiveAbility GetPassiveLevel ()
 
bool InRange (Combatant user, Combatant target)
 
float GetAvailableTime ()
 
void UseAddSchematic (Combatant combatant)
 
void UseRemoveSchematic (Combatant combatant)
 
CastTime GetCastTimeSetting (Combatant user)
 
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 CanTargetToggled (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 CanToggleTargetRange ()
 
bool CanToggleTargetType ()
 
bool TargetSelf ()
 
int GetLevel ()
 
bool ChangeUseLevel (int change, bool loop)
 
void SetHighestUseLevel (Combatant user)
 
IContent GetTypeContent ()
 
string GetName ()
 
string GetShortName ()
 
string GetDescription ()
 
string GetIconTextCode ()
 
Texture GetIconTexture ()
 
virtual Sprite GetIconSprite ()
 
virtual string GetCustomContent (string contentKey)
 
string GetInfo (Combatant combatant)
 
string GetUseCostText (Combatant user)
 
float GetActionCost (Combatant user)
 
DragShortcutWrapper GetDrag (Combatant user)
 
virtual string GetBonusText ()
 
virtual StatusPreviewInformation GetStatusBonus ()
 Gets the blank bonus provided by the status bonus. More...
 
virtual void GetStatusBonus (ref StatusPreviewInformation info)
 Adds the bonus provided by the status bonus to existing status bonus information. More...
 
virtual void AddRandomStatusBonus (RandomStatusBonusSettings settings)
 
virtual void RemoveAllStatusBonuses ()
 
bool CanPassiveToggle (Combatant user)
 
virtual bool TogglePassiveState (Combatant user)
 
virtual bool SetPassiveState (Combatant user, bool isEnabled)
 
bool IsDropable ()
 
bool CanUse (Combatant user, bool checkTime, bool checkUseCosts)
 
bool CanChoose (Combatant user, bool checkTime, bool checkUseCosts)
 
void CallCombatantSelection (ICombatantSelectionOrigin parent, bool useAction)
 
bool Use (Combatant user, List< Combatant > targets, bool useAction)
 
bool AutoUse (Combatant user)
 
ReuseTime GetReuseTimeSetting (Combatant user)
 
bool IsReuseBlocked (Combatant user)
 
string GetReuseTimeText (Combatant user, int decimals)
 
string GetReuseTimeFormatted (float seconds)
 
float GetReuseTime (Combatant user)
 
float GetMaxReuseTime (Combatant user)
 
virtual void FireUseCountChanged ()
 
virtual void SetUseCount (int useCount, int maxUseCount)
 
virtual void ResetUseCount (Combatant user, UseCountResetType resetType)
 
virtual void ChangeUseCount (int change, FloatOperator floatOperator)
 
virtual void RegisterStatusChanges (Combatant c)
 
virtual void UnregisterStatusChanges (Combatant c)
 
virtual void StatusValueChanged (Combatant c, StatusValue statusValue, int change)
 
IPortrait GetPortrait (PortraitTypeAsset portraitType)
 
void UnmarkNewContent (object value)
 
StatusPreview GetPreview (Combatant combatant, PreviewSelection selectedPreview)
 
DataObject SaveGame ()
 
void LoadGame (DataObject data)
 

Static Public Member Functions

static AbilityShortcut GetAbilityShortcut (object value)
 

Protected Member Functions

void RegisterUpdateVariables ()
 

Protected Attributes

string guid = ""
 
int level = 1
 
int useLevel = 1
 
int lvlPoints = 0
 
Ability ability
 
AbilityState state = AbilityState.None
 
VariableHandler variableHandler
 
float timestamp = 0
 
StatusBonusInstance statusBonus
 
int useCount = -1
 
int maxUseCount = -1
 
bool isPassiveEnabled = true
 
bool isNewContent = false
 
string name = ""
 
Notify levelPointsChangedHandler
 
Notify useCountChangedHandler
 
Notify levelChangedHandler
 
Notify passiveStateChangedHandler
 

Properties

Notify LevelPointsChanged
 
Notify UseCountChanged
 
Notify LevelChanged
 
Notify PassiveStateChanged
 
virtual string GUID [get, set]
 
int Quantity [get, set]
 
bool IsTemporary [get]
 
bool IsHidden [get]
 
AbilityState State [get, set]
 
string QuantityFormatted [get]
 
int Level [get, set]
 
string LevelFormatted [get]
 
string UseLevelFormatted [get]
 
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]
 
int UseLevel [get, set]
 
int ID [get]
 
string RenameableName [get, set]
 
string RenameableDescription [get, set]
 
bool IsPassiveEnabled [get]
 
bool IsPassiveToggleable [get]
 
virtual int UseCount [get, set]
 
virtual int MaxUseCount [get]
 
virtual bool HasUseCount [get]
 
bool IsNewContent [get, set]
 
- Properties inherited from GamingIsLove.ORKFramework.IShortcut
int Quantity [get, set]
 
string QuantityFormatted [get]
 
- Properties inherited from GamingIsLove.ORKFramework.IGUID
string GUID [get, set]
 
- Properties inherited from GamingIsLove.ORKFramework.IMarkNewContent
bool IsNewContent [get, set]
 
- Properties inherited from GamingIsLove.ORKFramework.IRenameable
string RenameableName [get, set]
 
string RenameableDescription [get, set]
 
- Properties inherited from GamingIsLove.ORKFramework.ITimestamp
float Timestamp [get, set]
 
- Properties inherited from GamingIsLove.ORKFramework.ILevel
int Level [get]
 

Member Function Documentation

◆ GetStatusBonus() [1/2]

virtual StatusPreviewInformation GamingIsLove.ORKFramework.AbilityShortcut.GetStatusBonus ( )
virtual

Gets the blank bonus provided by the status bonus.

Returns
Status bonus information.

Implements GamingIsLove.ORKFramework.IStatusBonus.

◆ GetStatusBonus() [2/2]

virtual void GamingIsLove.ORKFramework.AbilityShortcut.GetStatusBonus ( ref StatusPreviewInformation  info)
virtual

Adds the bonus provided by the status bonus to existing status bonus information.

Parameters
infoStatus bonus information.

Implements GamingIsLove.ORKFramework.IStatusBonus.