attack.rst

lua

attack

lua

Attack

This module contains ctypes and functions required for interacting with Solstice's and NWN's internal combat attack data structures.

ctypes

Warning

The following ctypes must be syncronized with nwnx_solstice. If not bad, bad things will happen. Good news is it's unlikely that will every be necessary.

Functions

Note

When using these functions in performance critical code, you should cache them in local variables.

AddCCMessage(info, type, objs, ints, str)

Adds combat message to an attack.

param info

Attack info.

type info

:cAttack

AddDamageToResult(info, dmg, mult)

Add damage.

param info

Attack info.

type info

:cAttack

param dmg

:cDamageRoll

param int mult

Multiplier for crits, etc.

AddEffect(info, attacker, eff)

Adds an onhit effect to an attack.

param info

Attack info.

type info

:cAttack

param attacker

Creature

param eff

Effect

AddVFX(info, attacker, vfx)

param info

Attack info.

type info

:cAttack

param attacker

Creature

param int vfx

VFX*

ClearSpecialAttack(info)

param info

Attack info.

type info

:cAttack

CopyDamageToNWNAttackData(info, attacker, target)

param info

Attack info.

type info

:cAttack

param attacker

Creature

param target

Creature

GetAttackRoll(info)

param info

Attack info.

type info

:cAttack

GetIsCoupDeGrace(info)

param info

Attack info.

type info

:cAttack

GetIsCriticalHit(info)

param info

Attack info.

type info

:cAttack

GetIsDeathAttack(info)

param info

Attack info.

type info

:cAttack

GetIsHit(info)

param info

Attack info.

type info

:cAttack

GetIsRangedAttack(info)

param info

Attack info.

type info

:cAttack

GetIsSneakAttack(info)

param info

Attack info.

type info

:cAttack

GetIsSpecialAttack(info)

param info

Attack info.

type info

:cAttack

GetResult(info)

param info

Attack info.

type info

:cAttack

GetSpecialAttack(info)

param info

Attack info.

type info

:cAttack

GetType(info)

param info

Attack info.

type info

:cAttack

rtype

ATTACK_TYPE*

SetAttackMod(info, ab)

param info

Attack info.

type info

:cAttack

param int ab

Attack modifier.

SetAttackRoll(info, roll)

param info

Attack info.

type info

:cAttack

param int roll

Attack roll.

SetConcealment(info, conceal)

param info

Attack info.

type info

:cAttack

param int conceal

Concealment.

SetCriticalResult(info, threat, result)

param info

Attack info.

type info

:cAttack

param int threat

Critical threat roll.

param boolean result

Is a critical hit.

SetMissedBy(info, roll)

param info

Attack info.

type info

:cAttack

param int roll

Attack roll.

SetResult(info, result)

param info

Attack info.

type info

:cAttack

param int result

Attack result.

SetSneakAttack(info, sneak, death)

param info

Attack info.

type info

:cAttack

param boolean sneak

Is sneak attack.

param boolean death

Is death attack.