ORK Framework  3.17.1
API Documentation
GamingIsLove.ORKFramework.ClassShortcut Class Reference
Inheritance diagram for GamingIsLove.ORKFramework.ClassShortcut:
GamingIsLove.ORKFramework.IAddRandomStatusBonus GamingIsLove.ORKFramework.UI.IUIShortcut GamingIsLove.ORKFramework.IStatusBonus GamingIsLove.ORKFramework.ILevel GamingIsLove.ORKFramework.IMarkNewContent GamingIsLove.ORKFramework.IShortcut

Public Member Functions

 ClassShortcut (Combatant owner, Class settings)
 
virtual void Clear ()
 
IShortcut GetCopy (int quantity)
 
bool IsEqual (IShortcut shortcut)
 
virtual string FormatQuantity (int quantity)
 
int BuyPrice (Combatant user)
 
int SellPrice (Combatant user)
 
virtual SelectedDataHandler GetSelectedData ()
 
virtual void Equipped ()
 
virtual void Unequipped ()
 
virtual void AddEquippedAbilities (bool isPreview)
 
virtual void RemoveEquippedAbilities (bool isPreview)
 
virtual List< AbilityShortcutGetEquippedAbilities (ClassSlotSetting slot)
 
virtual string GetName ()
 
virtual string GetShortName ()
 
virtual string GetDescription ()
 
virtual Sprite GetIconSprite ()
 
virtual Texture GetIconTexture ()
 
virtual string GetIconTextCode ()
 
virtual string GetCustomContent (string contentKey)
 
virtual IPortrait GetPortrait (PortraitTypeAsset portraitType)
 
IContent GetTypeContent ()
 
virtual DragShortcutWrapper GetDrag (Combatant user)
 
virtual DragShortcutWrapper GetDrag (Combatant user, ClassSlot slot)
 
virtual UIShortcutSettings GetUISettings ()
 
virtual string GetBonusText ()
 
virtual void InitLevel (int level)
 
virtual void UseAddSchematic ()
 
virtual void UseRemoveSchematic ()
 
virtual void CheckMaxLevel ()
 
virtual bool CheckLevelUp (StatusValueSetting classStatus)
 
virtual void CheckLevelUpContent (StatusValueSetting classStatus, ref List< UIContent > levelUp)
 
virtual UIContent ForceLevelUp ()
 
virtual UIContent LevelUp ()
 
virtual void LearnAbilitiesBaseLevelUp (ref string abilityText)
 
virtual void GetStatusChanges (ref StatusPreviewInformation info)
 
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 ()
 
virtual void AddStatusDevelopment (bool markResetStatus)
 
virtual void RemoveStatusDevelopment (bool markResetStatus)
 
virtual void AddStatusValueBonus (int statusID, int value)
 
virtual void SetStatusValueBonus (int statusID, int value)
 
virtual int GetStatusValueBonus (int statusID)
 
virtual void SetDevelopmentAtLevel (int level, int percentPoints, int[] statusValues)
 
virtual void SetDevelopmentAtLevel (int level, StatusDevelopmentRecord record)
 
virtual bool GetDevelopmentAtLevel (ref int value, int level, StatusValueSetting status)
 
virtual bool GetDevelopmentBonus (ref int value, int level, StatusValueSetting status)
 
virtual AbilityShortcut LearnAbility (Ability ability, int level, int atLevel, bool classLevel, bool isGroupAbility, bool showNotification, bool showConsole)
 
virtual bool HasLearnedAbility (Ability ability, int level, int atLevel, bool classLevel, bool isGroupAbility)
 
virtual bool HasLearnedAbility (Ability ability, int level, bool isGroupAbility)
 
virtual AbilityShortcut GetLearned (Ability ability)
 
virtual void AddNonLearnedAbilities ()
 
virtual void RemoveNonLearnedAbilities ()
 
virtual bool CanEquip (Combatant combatant)
 
virtual bool IsUseable (UseableIn useIn)
 
virtual bool CanUse (Combatant combatant, bool checkTime, bool checkUseCosts)
 
virtual bool IsDropable ()
 
virtual bool Use (Combatant user, List< Combatant > targets, bool useAction)
 
virtual List< CombatantGetPossibleTargets (Combatant user, List< Combatant > available)
 
virtual bool CanTarget (Combatant user, Combatant target)
 
virtual StatusPreview GetPreview (Combatant combatant, PreviewSelection selectedPreview)
 
virtual void UnmarkNewContent (object value)
 
virtual bool UnmarkView (Combatant owner, object value)
 
virtual bool UnmarkSelection (Combatant owner, object value)
 
virtual DataObject SaveGame ()
 
virtual void LoadGame (DataObject data)
 

Protected Attributes

Combatant owner
 
Class settings
 
ClassSlot isEquippedOn
 
int currentLevel = 1
 
StatusValue experience
 
Dictionary< int, StatusDevelopmentRecorddevSV
 
int [] addedStatusValue
 
StatusBonusInstance statusBonus
 
bool isNewContent = false
 
AbilityShortcut classAbility
 
List< ClassInstanceAbilityabilities
 
CombatantShortcutList [] shortcutList
 

Properties

virtual Combatant Owner [get]
 
virtual Class Settings [get]
 
virtual ClassSlot IsEquippedOn [get, set]
 
virtual bool IsCurrentSingleClass [get]
 
virtual bool IsUsed [get]
 
virtual int Quantity [get, set]
 
virtual string QuantityFormatted [get]
 
virtual int ID [get]
 
ItemType ItemType [get]
 
virtual int Level [get, set]
 
virtual StatusValue Experience [get]
 
virtual bool ReceiveExperience [get]
 
virtual string LevelFormatted [get]
 
virtual string MaxLevelFormatted [get]
 
virtual int MaxLevel [get]
 
virtual bool IsMaxLevel [get]
 
virtual bool HasClassAbility [get]
 
virtual AbilityShortcut ClassAbility [get, set]
 
virtual CombatantShortcutList [] ShortcutList [get, set]
 
virtual bool IsNewContent [get, set]
 
- Properties inherited from GamingIsLove.ORKFramework.IShortcut
int Quantity [get, set]
 
string QuantityFormatted [get]
 
- Properties inherited from GamingIsLove.ORKFramework.IMarkNewContent
bool IsNewContent [get, set]
 
- Properties inherited from GamingIsLove.ORKFramework.ILevel
int Level [get]
 

Member Function Documentation

◆ GetStatusBonus() [1/2]

virtual StatusPreviewInformation GamingIsLove.ORKFramework.ClassShortcut.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.ClassShortcut.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.