ORK Framework
3.17.1
API Documentation
|
Public Member Functions | |
CombatantEquipment (Combatant owner) | |
virtual void | FireChanged () |
void | CheckAvailableSlots (bool reset) |
Checks the available equipment slots. More... | |
float | GetEquippedSpace () |
void | CheckViewerBlocks (bool notify) |
bool | IsUnequipped (EquipmentSlotSetting equipmentSlot) |
bool | IsEquipped (Equipment equip, LevelValueCheck levelCheck, EquipmentSlotSetting equipmentSlot) |
bool | IsEquipped (EquipShortcut equip) |
bool | IsTypeEquipped (bool checkParent, ItemType itemType, EquipmentSlotSetting equipmentSlot) |
EquipmentSlot | GetSlot (EquipmentSlotSetting equipmentSlot) |
EquipmentSlot | GetRealSlot (EquipmentSlotSetting equipmentSlot, bool checkBlockingSlot) |
EquipmentSlot | GetSlot (EquipShortcut equip) |
EquipShortcut | Get (string guid) |
virtual void | RegisterChanges (EquipShortcut equip) |
virtual void | UnregisterChanges (EquipShortcut equip) |
List< EquipmentSlot > | GetAvailableSlots (Consider onlyContributing) |
Gets the available equipment slots. More... | |
bool | HasAvailableSlots (Consider onlyContributing) |
void | AddEquipmentSlot (EquipmentSlotSetting equipmentSlot) |
void | RemoveEquipmentSlot (EquipmentSlotSetting equipmentSlot) |
void | AddBlockedEquipmentSlot (EquipmentSlotSetting equipmentSlot) |
void | RemoveBlockedEquipmentSlot (EquipmentSlotSetting equipmentSlot) |
void | AddBlockedViewer (EquipmentSlotSetting equipmentSlot) |
void | RemoveBlockedViewer (EquipmentSlotSetting equipmentSlot) |
void | GetStatusChanges (ref StatusPreviewInformation info) |
void | SetStartEffects () |
bool | CanApplyEffect (StatusEffectSetting effect) |
bool | CanRemoveEffect (StatusEffectSetting effect) |
void | UseAttackEffects (Combatant target, bool isBlocked, bool isCritical) |
void | UseDefenceEffects (Combatant target, bool isBlocked, bool isCritical) |
void | GetEffectAttackModifiers (Dictionary< int, List< int >> modifiers, EffectModifierUseType useType) |
virtual bool | ContainsEffectAttackModifier (AttackModifierSetting modifier, int attributeID, HashSet< AttackModifierSetting > ignore) |
bool | IsAttackChangesBlocked () |
bool | IsAbilityChangesBlocked (AbilityShortcut ability) |
bool | IsItemChangesBlocked (ItemShortcut item) |
void | GetAnimationSettings (ref List< AnimationSetting > list) |
bool | EquipAccess (EquipmentSlotSetting equipmentSlot, EquipShortcut equip, Combatant fromInventory, Combatant unequipToInventory, bool reset) |
Equips an equipment via the access handler. More... | |
bool | Equip (EquipmentSlotSetting equipmentSlot, 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... | |
bool | CanUnequip (EquipShortcut equip) |
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 (EquipmentSlotSetting equipmentSlot, Combatant toInventory, bool reset, bool force) |
Unequips equipment currently equipped on a defined equipment slot via the access handler. More... | |
void | Unequip (EquipmentSlotSetting equipmentSlot, Combatant toInventory, bool reset, bool force) |
Unequips equipment currently equipped on a defined equipment slot. More... | |
EquipmentSlot [] | GetFakeEquip (EquipmentSlotSetting equipmentSlot, EquipShortcut equip) |
void | LockAll (bool lockSlots) |
bool | IsSlotLocked (EquipmentSlotSetting equipmentSlot) |
bool | IsSlotLocked (EquipmentSlot equipSlot) |
DataObject | SaveGame () |
void | LoadGame (DataObject data) |
Static Public Member Functions | |
static void | GetStatusChanges (EquipmentSlot[] equips, ref StatusPreviewInformation info) |
Protected Member Functions | |
void | Unequip (EquipmentSlot equipSlot, Combatant toInventory, bool reset, bool force) |
Properties | |
bool | HasCollectedChange [get, set] |
EquipmentSlot | this[int index] [get, set] |
Gets the equipment slot at the specified index. This lets you access an equipment slot of the combatant. More... | |
EquipmentSlot [] | Slots [get, set] |
AvailableEquipment | Settings [get] |
List< EquipmentSlotSetting > | AddedEquipmentSlots [get, set] |
List< EquipmentSlotSetting > | BlockedEquipmentSlots [get, set] |
List< EquipmentSlotSetting > | BlockedViewers [get, set] |
bool | UpdateAnimations [get, set] |
void GamingIsLove.ORKFramework.Combatants.CombatantEquipment.CheckAvailableSlots | ( | bool | reset | ) |
Checks the available equipment slots.
bool GamingIsLove.ORKFramework.Combatants.CombatantEquipment.Equip | ( | EquipmentSlotSetting | equipmentSlot, |
EquipShortcut | equip, | ||
Combatant | fromInventory, | ||
Combatant | unequipToInventory, | ||
bool | reset | ||
) |
Equips an equipment.
equipmentSlot | The equipment slot it will be equipped on. Use -1 if a matching equipment slot should be searched. |
equip | The EquipShortcut that will be equipped. |
fromInventory | The combatant who's inventory should remove the equipment. |
unequipToInventory | The combatant who's inventory should add equipment currently equipped on the used equipment slot. |
reset | true if the combatant's status system should be reset (i.e. checking for bonuses, etc.). |
true
if the equipment was equipped.bool GamingIsLove.ORKFramework.Combatants.CombatantEquipment.EquipAccess | ( | EquipmentSlotSetting | equipmentSlot, |
EquipShortcut | equip, | ||
Combatant | fromInventory, | ||
Combatant | unequipToInventory, | ||
bool | reset | ||
) |
Equips an equipment via the access handler.
equipmentSlot | The equipment slot it will be equipped on. Use -1 if a matching equipment slot should be searched. |
equip | The EquipShortcut that will be equipped. |
fromInventory | The combatant who's inventory should remove the equipment. |
unequipToInventory | The combatant who's inventory should add equipment currently equipped on the used equipment slot. |
reset | true if the combatant's status system should be reset (i.e. checking for bonuses, etc.). |
true
if the equipment was equipped.List<EquipmentSlot> GamingIsLove.ORKFramework.Combatants.CombatantEquipment.GetAvailableSlots | ( | Consider | onlyContributing | ) |
Gets the available equipment slots.
onlyContributing | Yes to only add contributing equipment slots. No to only add not contributing equipment slots. Ignore to ignore contributing state. |
void GamingIsLove.ORKFramework.Combatants.CombatantEquipment.Unequip | ( | EquipShortcut | equip, |
Combatant | toInventory | ||
) |
Unequips an equipment.
equip | The equipment that will be unequiped. |
toInventory | The combatant who's inventory should add the unequipped equipment. |
void GamingIsLove.ORKFramework.Combatants.CombatantEquipment.Unequip | ( | EquipmentSlotSetting | equipmentSlot, |
Combatant | toInventory, | ||
bool | reset, | ||
bool | force | ||
) |
Unequips equipment currently equipped on a defined equipment slot.
equipmentSlot | The equipment slot that will be unequipped. |
toInventory | The combatant who's inventory should add the unequipped equipment. |
reset | true if the combatant's status system should be reset (i.e. checking for bonuses, etc.). |
force | true if unequipping should be forced. |
void GamingIsLove.ORKFramework.Combatants.CombatantEquipment.UnequipAccess | ( | EquipShortcut | equip, |
Combatant | toInventory | ||
) |
Unequips an equipment via the access handler.
equip | The equipment that will be unequiped. |
toInventory | The combatant who's inventory should add the unequipped equipment. |
void GamingIsLove.ORKFramework.Combatants.CombatantEquipment.UnequipAccess | ( | EquipmentSlotSetting | equipmentSlot, |
Combatant | toInventory, | ||
bool | reset, | ||
bool | force | ||
) |
Unequips equipment currently equipped on a defined equipment slot via the access handler.
equipmentSlot | The equipment slot that will be unequipped. |
toInventory | The combatant who's inventory should add the unequipped equipment. |
reset | true if the combatant's status system should be reset (i.e. checking for bonuses, etc.). |
force | true if unequipping should be forced. |
void GamingIsLove.ORKFramework.Combatants.CombatantEquipment.UnequipAll | ( | Combatant | toInventory | ) |
Unequips all currently equipped equipment.
toInventory | The combatant who's inventory should add the unequipped equipment. |
void GamingIsLove.ORKFramework.Combatants.CombatantEquipment.UnequipAllAccess | ( | Combatant | toInventory | ) |
Unequips all currently equipped equipment via the access handler.
toInventory | The combatant who's inventory should add the unequipped equipment. |
|
getset |
Gets the equipment slot at the specified index. This lets you access an equipment slot of the combatant.
index | The ID (index) of the equipment slot. |