Dawn of Light - Class documentation 2900
This is the Dawn of Light project
DOL.GS.AttackData Class Reference

Holds all data for an Attack. More...

List of all members.

Public Types

enum  eAttackType {
  Unknown = -1, MeleeOneHand = 1, MeleeDualWield = 2, MeleeTwoHand = 3,
  Ranged = 4, Spell = 5
}
 The type of attack. More...

Public Member Functions

 AttackData ()
 Constructs new AttackData.

Properties

int Modifier [get, set]
 Sets or gets the modifier (resisted damage)
bool IsSpellResisted [get, set]
 Was the spell resisted.
GameLiving Attacker [get, set]
 Sets or gets the attacker.
GameLiving Target [get, set]
 Sets or gets the attack target.
eArmorSlot ArmorHitLocation [get, set]
 Sets or gets the armor hit location.
int Damage [get, set]
 Sets or gets the damage.
int UncappedDamage [get, set]
 Sets or gets the uncapped damage.
int CriticalDamage [get, set]
 Sets or gets the critical damage.
int StyleDamage [get, set]
 Sets or gets the style damage.
eDamageType DamageType [get, set]
 Sets or gets the damage type.
Style Style [get, set]
 Sets or gets the style used.
GameLiving.eAttackResult AttackResult [get, set]
 Sets or gets the attack result.
ISpellHandler SpellHandler [get, set]
List< ISpellHandlerStyleEffects [get]
 (procs) Gets the style effects
int WeaponSpeed [get, set]
 Sets or gets the weapon speed.
bool IsMeleeAttack [get]
 Checks whether attack type is one of melee types.
bool IsOffHand [get, set]
InventoryItem Weapon [get, set]
eAttackType AttackType [get, set]
 Sets or gets the attack type.
int AnimationId [get, set]
 Sets or gets the attack animation ID.
bool IsHit [get]
 Method to determine if an attack result, resulted in a hit.
bool IsRandomFumble [get]
bool IsRandomMiss [get]
bool CausesCombat [get, set]
 Does this attack put the living in combat?

Detailed Description

Holds all data for an Attack.


Member Enumeration Documentation

The type of attack.

Enumerator:
Unknown 

Attack type has not been set yet.

MeleeOneHand 

Attack is done using a weapon in one hand.

MeleeDualWield 

Attack is done using one weapon in each hand.

MeleeTwoHand 

Attack is done using one same weapon in both hands.

Ranged 

Attack is done using a weapon in ranged slot.

Spell 

Attack is done with a spell.


Constructor & Destructor Documentation

DOL.GS.AttackData.AttackData ( )

Constructs new AttackData.


Property Documentation

int DOL.GS.AttackData.AnimationId [get, set]

Sets or gets the attack animation ID.

eArmorSlot DOL.GS.AttackData.ArmorHitLocation [get, set]

Sets or gets the armor hit location.

GameLiving DOL.GS.AttackData.Attacker [get, set]

Sets or gets the attacker.

GameLiving.eAttackResult DOL.GS.AttackData.AttackResult [get, set]

Sets or gets the attack result.

eAttackType DOL.GS.AttackData.AttackType [get, set]

Sets or gets the attack type.

bool DOL.GS.AttackData.CausesCombat [get, set]

Does this attack put the living in combat?

int DOL.GS.AttackData.CriticalDamage [get, set]

Sets or gets the critical damage.

int DOL.GS.AttackData.Damage [get, set]

Sets or gets the damage.

eDamageType DOL.GS.AttackData.DamageType [get, set]

Sets or gets the damage type.

bool DOL.GS.AttackData.IsHit [get]

Method to determine if an attack result, resulted in a hit.

Returns:
true if it was a hit
bool DOL.GS.AttackData.IsMeleeAttack [get]

Checks whether attack type is one of melee types.

bool DOL.GS.AttackData.IsSpellResisted [get, set]

Was the spell resisted.

int DOL.GS.AttackData.Modifier [get, set]

Sets or gets the modifier (resisted damage)

Style DOL.GS.AttackData.Style [get, set]

Sets or gets the style used.

int DOL.GS.AttackData.StyleDamage [get, set]

Sets or gets the style damage.

List<ISpellHandler> DOL.GS.AttackData.StyleEffects [get]

(procs) Gets the style effects

GameLiving DOL.GS.AttackData.Target [get, set]

Sets or gets the attack target.

int DOL.GS.AttackData.UncappedDamage [get, set]

Sets or gets the uncapped damage.

int DOL.GS.AttackData.WeaponSpeed [get, set]

Sets or gets the weapon speed.


The documentation for this class was generated from the following file:
All Classes Namespaces Functions Variables Enumerations Properties Events