ORK Framework  2.29.3
API Documentation
ORKFramework.Combatants.CombatantEquipment Class Reference
Inheritance diagram for ORKFramework.Combatants.CombatantEquipment:
ORKFramework.ISaveData

Public Member Functions

 CombatantEquipment (Combatant owner)
 
void FireChanged ()
 
void FireCollectedChange ()
 
void CheckAvailableParts (bool reset)
 Checks the available equipment parts. More...
 
void CheckViewerBlocks (bool notify)
 
bool CanEquip (EquipType equipType, bool[] parts)
 
bool IsEquipped (EquipSet equipSet, int id, int level, int partID)
 
bool IsTypeEquipped (EquipSet equipSet, int index, int partID)
 
EquipShortcut Get (string guid)
 
EquipShortcut Get (string guid, EquipSet type)
 
List< int > GetAvailableParts (Consider onlyContributing)
 Gets the available equipment parts. More...
 
void AddEquipmentPart (int partID)
 
void RemoveEquipmentPart (int partID)
 
void AddBlockedEquipmentPart (int partID)
 
void RemoveBlockedEquipmentPart (int partID)
 
void AddBlockedViewer (int partID)
 
void RemoveBlockedViewer (int partID)
 
void GetStatusChanges (ref StatusPreviewInformation info)
 
void SetStartEffects ()
 
bool CanApplyEffect (int effectID)
 
bool CanRemoveEffect (int effectID)
 
void UseAttackEffects (Combatant target)
 
void UseDefenceEffects (Combatant target)
 
void GetAttackAttributes (ref int[] atkAttr)
 
void GetAnimationSettings (ref List< AnimationSetting > list)
 
bool EquipAccess (int partID, EquipShortcut equip, Combatant fromInventory, Combatant unequipToInventory, bool reset)
 Equips an equipment via the access handler. More...
 
bool Equip (int partID, EquipShortcut equip, Combatant fromInventory, Combatant unequipToInventory, bool reset)
 Equips an equipment. More...
 
void UnequipAllAccess (Combatant toInventory)
 Unequips all currently equipped equipment via the access handler. More...
 
void UnequipAll (Combatant toInventory)
 Unequips all currently equipped equipment. More...
 
void UnequipAccess (EquipShortcut equip, Combatant toInventory)
 Unequips an equipment via the access handler. More...
 
void Unequip (EquipShortcut equip, Combatant toInventory)
 Unequips an equipment. More...
 
void UnequipAccess (int partID, Combatant toInventory, bool reset, bool force)
 Unequips equipment currently equipped on a defined equipment part via the access handler. More...
 
void Unequip (int partID, Combatant toInventory, bool reset, bool force)
 Unequips equipment currently equipped on a defined equipment part. More...
 
EquipPartSlot [] GetFakeEquip (int partID, EquipShortcut equip)
 
void LockAll (bool lockParts)
 
bool IsPartLocked (int partID)
 
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...
 

Static Public Member Functions

static void GetStatusChanges (EquipPartSlot[] equips, ref StatusPreviewInformation info)
 

Properties

NotifyCombatant Changed
 
Notify SimpleChanged
 
NotifyCombatant CollectedChange
 
bool HasCollectedChange [get, set]
 
EquipPartSlot this[int index] [get, set]
 Gets the EquipPartSlot at the specified index. This lets you access an equipment part of the combatant. More...
 
AvailableEquipment Settings [get]
 
List< int > AddedEquipmentParts [get, set]
 
List< int > BlockedEquipmentParts [get, set]
 
List< int > BlockedViewers [get, set]
 
bool UpdateAnimations [get, set]
 

Member Function Documentation

◆ CheckAvailableParts()

void ORKFramework.Combatants.CombatantEquipment.CheckAvailableParts ( bool  reset)

Checks the available equipment parts.

◆ Equip()

bool ORKFramework.Combatants.CombatantEquipment.Equip ( int  partID,
EquipShortcut  equip,
Combatant  fromInventory,
Combatant  unequipToInventory,
bool  reset 
)

Equips an equipment.

Parameters
partIDThe ID/index of the equipment part it will be equipped on. Use -1 if a matching equipment part should be searched.
equipThe EquipShortcut that will be equipped.
fromInventoryThe combatant who's inventory should remove the equipment.
unequipToInventoryThe combatant who's inventory should add equipment currently equipped on the used equipment part.
resettrue if the combatant's status system should be reset (i.e. checking for bonuses, etc.).
Returns
true if the equipment was equipped.

◆ EquipAccess()

bool ORKFramework.Combatants.CombatantEquipment.EquipAccess ( int  partID,
EquipShortcut  equip,
Combatant  fromInventory,
Combatant  unequipToInventory,
bool  reset 
)

Equips an equipment via the access handler.

Parameters
partIDThe ID/index of the equipment part it will be equipped on. Use -1 if a matching equipment part should be searched.
equipThe EquipShortcut that will be equipped.
fromInventoryThe combatant who's inventory should remove the equipment.
unequipToInventoryThe combatant who's inventory should add equipment currently equipped on the used equipment part.
resettrue if the combatant's status system should be reset (i.e. checking for bonuses, etc.).
Returns
true if the equipment was equipped.

◆ GetAvailableParts()

List<int> ORKFramework.Combatants.CombatantEquipment.GetAvailableParts ( Consider  onlyContributing)

Gets the available equipment parts.

Parameters
onlyContributingYes to only add contributing equipment parts. No to only add not contributing equipment parts. Ignore to ignore contributing state.
Returns
A list of IDs (indexes) of the equipment parts.

◆ LoadGame()

void ORKFramework.Combatants.CombatantEquipment.LoadGame ( DataObject  data)

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

Parameters
dataA ORKFramework.DataObject containing the data.

Implements ORKFramework.ISaveData.

◆ SaveGame()

DataObject ORKFramework.Combatants.CombatantEquipment.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.

◆ Unequip() [1/2]

void ORKFramework.Combatants.CombatantEquipment.Unequip ( EquipShortcut  equip,
Combatant  toInventory 
)

Unequips an equipment.

Parameters
equipThe equipment that will be unequiped.
toInventoryThe combatant who's inventory should add the unequipped equipment.

◆ Unequip() [2/2]

void ORKFramework.Combatants.CombatantEquipment.Unequip ( int  partID,
Combatant  toInventory,
bool  reset,
bool  force 
)

Unequips equipment currently equipped on a defined equipment part.

Parameters
partIDThe ID/index of the equipment part that will be unequipped.
toInventoryThe combatant who's inventory should add the unequipped equipment.
resettrue if the combatant's status system should be reset (i.e. checking for bonuses, etc.).
forcetrue if unequipping should be forced.

◆ UnequipAccess() [1/2]

void ORKFramework.Combatants.CombatantEquipment.UnequipAccess ( EquipShortcut  equip,
Combatant  toInventory 
)

Unequips an equipment via the access handler.

Parameters
equipThe equipment that will be unequiped.
toInventoryThe combatant who's inventory should add the unequipped equipment.

◆ UnequipAccess() [2/2]

void ORKFramework.Combatants.CombatantEquipment.UnequipAccess ( int  partID,
Combatant  toInventory,
bool  reset,
bool  force 
)

Unequips equipment currently equipped on a defined equipment part via the access handler.

Parameters
partIDThe ID/index of the equipment part that will be unequipped.
toInventoryThe combatant who's inventory should add the unequipped equipment.
resettrue if the combatant's status system should be reset (i.e. checking for bonuses, etc.).
forcetrue if unequipping should be forced.

◆ UnequipAll()

void ORKFramework.Combatants.CombatantEquipment.UnequipAll ( Combatant  toInventory)

Unequips all currently equipped equipment.

Parameters
toInventoryThe combatant who's inventory should add the unequipped equipment.

◆ UnequipAllAccess()

void ORKFramework.Combatants.CombatantEquipment.UnequipAllAccess ( Combatant  toInventory)

Unequips all currently equipped equipment via the access handler.

Parameters
toInventoryThe combatant who's inventory should add the unequipped equipment.

Property Documentation

◆ this[int index]

EquipPartSlot ORKFramework.Combatants.CombatantEquipment.this[int index]
getset

Gets the EquipPartSlot at the specified index. This lets you access an equipment part of the combatant.

Parameters
indexThe ID (index) of the equipment part.